Skip to main content

System Coupling Participant library 2026 R1

File syscSystemCoupling.h

Last update: 09.03.2026

Location: syscSystemCoupling.h

Includes

  • SystemCouplingParticipant/LibraryType.hpp
  • SystemCouplingParticipant/syscComm.h
  • SystemCouplingParticipant/syscCommonTypes.h
  • SystemCouplingParticipant/syscCouplingInterface.h
  • SystemCouplingParticipant/syscFunctionTypes.h
  • SystemCouplingParticipant/syscLegacyInterfaces.h
  • SystemCouplingParticipant/syscParameter.h
  • SystemCouplingParticipant/syscPointCloud.h
  • SystemCouplingParticipant/syscRearrange.h
  • SystemCouplingParticipant/syscRegion.h
  • SystemCouplingParticipant/syscVariable.h
  • SystemCouplingParticipant/syscVolumeMesh.h
  • SystemCouplingParticipant/syscSurfaceMesh.h
  • <stddef.h>
graph LR
1["syscSystemCoupling.h"]
click 1 "syscSystemCoupling_8h.md#syscSystemCoupling_8h"
1 --> 2
1 --> 3
1 --> 4
1 --> 5
1 --> 6
1 --> 7
1 --> 8
1 --> 9
1 --> 10
1 --> 11
1 --> 12
1 --> 13
1 --> 14
1 --> 15

2["SystemCouplingParticipant/LibraryType.hpp"]

3["SystemCouplingParticipant/syscComm.h"]

4["SystemCouplingParticipant/syscCommonTypes.h"]

5["SystemCouplingParticipant/syscCouplingInterface.h"]

6["SystemCouplingParticipant/syscFunctionTypes.h"]

7["SystemCouplingParticipant/syscLegacyInterfaces.h"]

8["SystemCouplingParticipant/syscParameter.h"]

9["SystemCouplingParticipant/syscPointCloud.h"]

10["SystemCouplingParticipant/syscRearrange.h"]

11["SystemCouplingParticipant/syscRegion.h"]

14["SystemCouplingParticipant/syscSurfaceMesh.h"]

12["SystemCouplingParticipant/syscVariable.h"]

13["SystemCouplingParticipant/syscVolumeMesh.h"]

15["stddef.h"]

Functions

Function syscStartStandaloneParallel

Function syscConnect

Function syscConnectParallel

Function syscConnectUseStruct

Function syscConnectParallelUseStruct

Function syscAddRegion

Function syscAddInputParameter

Function syscAddOutputParameter

Function syscGetNumInputParameters

Function syscGetNumOutputParameters

Function syscGetAddedInputParameter

Function syscGetAddedOutputParameter

Function syscGetNumRealAttributes

Function syscGetNumIntegerAttributes

Function syscGetAddedRealAttribute

Function syscGetAddedIntegerAttribute

Function syscAddRealAttribute

Function syscAddIntegerAttribute

Function syscGetParameterValue

Function syscSetParameterValue

Function syscGetRealAttributeValue

Function syscGetIntegerAttributeValue

Function syscAddCouplingInterface

Function syscAddCouplingInterfaceA

Function syscCompleteSetup

Function syscRegisterInputScalarDataAccess

Function syscRegisterInputScalarDataAccessWithPointer

Function syscRegisterInputScalarDataMultiZoneAccess

Function syscRegisterInputVectorDataAccess

Function syscRegisterInputVectorDataAccessWithPointer

Function syscRegisterInputVectorDataMultiZoneAccess

Function syscRegisterOutputScalarDataAccess

Function syscRegisterOutputScalarDataAccessWithPointer

Function syscRegisterOutputScalarDataMultiZoneAccess

Function syscRegisterOutputVectorDataAccess

Function syscRegisterOutputVectorDataAccessWithPointer

Function syscRegisterOutputVectorDataMultiZoneAccess

Function syscRegisterInputComplexScalarDataAccess

Function syscRegisterInputComplexScalarDataAccessWithPointer

Function syscRegisterInputComplexVectorDataAccess

Function syscRegisterInputComplexVectorDataAccessWithPointer

Function syscRegisterOutputComplexScalarDataAccess

Function syscRegisterOutputComplexScalarDataAccessWithPointer

Function syscRegisterOutputComplexVectorDataAccess

Function syscRegisterOutputComplexVectorDataAccessWithPointer

Function syscRegisterSurfMeshAccess

Function syscRegisterSurfaceMeshAccessWithPointer

Function syscRegisterSurfaceMeshMultiZoneAccess

Function syscRegisterVolumeMeshAccess

Function syscRegisterVolumeMeshAccessWithPointer

Function syscRegisterVolumeMeshMultiZoneAccess

Function syscRegisterPointCloudAccess

Function syscRegisterPointCloudAccessWithPointer

Function syscRegisterPointCloudMultiZoneAccess

Function syscRegisterZoneCountAccess

Function syscRegisterRestartPointCreation

Function syscInitializeAnalysis

Function syscDoIteration

Function syscDoTimeStep

Function syscGetCurrentTimeStep

Function syscUpdateInputs

Function syscUpdateOutputs

Function syscDisconnect

Function syscFatalError

Function syscNonFatalError

Function syscCheckSurfaceMeshValidity

Function syscWriteSetupFile

Function syscWriteResults

Function syscGetNumRegions

Function syscGetAddedRegion

Function syscGetSolutionControl

Function syscGetNumCouplingInterfaces

Function syscGetAddedCouplingInterface

Source

/*
* Copyright ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
*/

#pragma once

#include "SystemCouplingParticipant/LibraryType.hpp"

#include "SystemCouplingParticipant/syscComm.h"
#include "SystemCouplingParticipant/syscCommonTypes.h"
#include "SystemCouplingParticipant/syscCouplingInterface.h"
#include "SystemCouplingParticipant/syscFunctionTypes.h"
#include "SystemCouplingParticipant/syscLegacyInterfaces.h"
#include "SystemCouplingParticipant/syscParameter.h"
#include "SystemCouplingParticipant/syscPointCloud.h"
#include "SystemCouplingParticipant/syscRearrange.h"
#include "SystemCouplingParticipant/syscRegion.h"
#include "SystemCouplingParticipant/syscVariable.h"
#include "SystemCouplingParticipant/syscVolumeMesh.h"
#include "SystemCouplingParticipant/syscSurfaceMesh.h"

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif



SyscError syscStartStandaloneParallel(const size_t mpiCommunicator);


SyscError syscConnect(
  const char* scHost,
  const unsigned short scPort,
  const char* participantName,
  const char* buildInformation);


SyscError syscConnectParallel(
  const char* scHost,
  const unsigned short scPort,
  const char* participantName,
  const size_t communicator,
  const char* buildInformation);



SyscError syscConnectUseStruct(
  SyscParticipantInfo participantInfo);



SyscError syscConnectParallelUseStruct(
  SyscParticipantInfo participantInfo,
  const size_t communicator);


SyscError syscAddRegion(
  const SyscRegion region);


SyscError syscAddInputParameter(
  const SyscParameter parameter);


SyscError syscAddOutputParameter(
  const SyscParameter parameter);


size_t syscGetNumInputParameters();


size_t syscGetNumOutputParameters();


SyscParameter syscGetAddedInputParameter(size_t index);


SyscParameter syscGetAddedOutputParameter(size_t index);


size_t syscGetNumRealAttributes();


size_t syscGetNumIntegerAttributes();


SyscRealAttribute syscGetAddedRealAttribute(size_t index);


SyscIntegerAttribute syscGetAddedIntegerAttribute(size_t index);


SyscError syscAddRealAttribute(
  const SyscRealAttribute attribute);


SyscError syscAddIntegerAttribute(
  const SyscIntegerAttribute attribute);


double syscGetParameterValue(const char* parameterName, SyscError* errorCode);


SyscError syscSetParameterValue(
  const char* parameterName,
  double value);


double syscGetRealAttributeValue(
  const char* attributeName,
  SyscError* errorCode);


int64_t syscGetIntegerAttributeValue(
  const char* attributeName,
  SyscError* errorCode);


SyscError syscAddCouplingInterface(
  const SyscCouplingInterface couplingInterface);


SyscError syscAddCouplingInterfaceA(
  const SyscCouplingInterface couplingInterface,
  int autoGenerateDataTransfers);


SyscError syscCompleteSetup(const SyscSetupInfo setupInfo);


SyscError syscRegisterInputScalarDataAccess(
  SyscInputScalarDataAccess dataAccess);


SyscError syscRegisterInputScalarDataAccessWithPointer(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscInputScalarDataAccessWithPointer dataAccess);


SyscError syscRegisterInputScalarDataMultiZoneAccess(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscInputScalarDataMultiZoneAccess dataAccess);


SyscError syscRegisterInputVectorDataAccess(
  SyscInputVectorDataAccess dataAccess);


SyscError syscRegisterInputVectorDataAccessWithPointer(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscInputVectorDataAccessWithPointer dataAccess);


SyscError syscRegisterInputVectorDataMultiZoneAccess(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscInputVectorDataMultiZoneAccess dataAccess);


SyscError syscRegisterOutputScalarDataAccess(
  SyscOutputScalarDataAccess dataAccess);


SyscError syscRegisterOutputScalarDataAccessWithPointer(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscOutputScalarDataAccessWithPointer dataAccess);


SyscError syscRegisterOutputScalarDataMultiZoneAccess(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscOutputScalarDataMultiZoneAccess dataAccess);


SyscError syscRegisterOutputVectorDataAccess(
  SyscOutputVectorDataAccess dataAccess);


SyscError syscRegisterOutputVectorDataAccessWithPointer(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscOutputVectorDataAccessWithPointer dataAccess);


SyscError syscRegisterOutputVectorDataMultiZoneAccess(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscOutputVectorDataMultiZoneAccess dataAccess);


SyscError syscRegisterInputComplexScalarDataAccess(
  SyscInputComplexScalarDataAccess dataAccess);


SyscError syscRegisterInputComplexScalarDataAccessWithPointer(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscInputComplexScalarDataAccessWithPointer dataAccess);


SyscError syscRegisterInputComplexVectorDataAccess(
  SyscInputComplexVectorDataAccess dataAccess);


SyscError syscRegisterInputComplexVectorDataAccessWithPointer(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscInputComplexVectorDataAccessWithPointer dataAccess);


SyscError syscRegisterOutputComplexScalarDataAccess(
  SyscOutputComplexScalarDataAccess dataAccess);


SyscError syscRegisterOutputComplexScalarDataAccessWithPointer(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscOutputComplexScalarDataAccessWithPointer dataAccess);


SyscError syscRegisterOutputComplexVectorDataAccess(
  SyscOutputComplexVectorDataAccess dataAccess);


SyscError syscRegisterOutputComplexVectorDataAccessWithPointer(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscOutputComplexVectorDataAccessWithPointer dataAccess);


SyscError syscRegisterSurfMeshAccess(SyscSurfMeshAccess meshAccess);


SyscError syscRegisterSurfaceMeshAccessWithPointer(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscSurfaceMeshAccessWithPointer meshAccess);


SyscError syscRegisterSurfaceMeshMultiZoneAccess(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscSurfaceMeshMultiZoneAccess meshAccess);


SyscError syscRegisterVolumeMeshAccess(SyscVolumeMeshAccess meshAccess);


SyscError syscRegisterVolumeMeshAccessWithPointer(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscVolumeMeshAccessWithPointer meshAccess);


SyscError syscRegisterVolumeMeshMultiZoneAccess(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscVolumeMeshMultiZoneAccess meshAccess);


SyscError syscRegisterPointCloudAccess(SyscPointCloudAccess pointCloudAccess);


SyscError syscRegisterPointCloudAccessWithPointer(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscPointCloudAccessWithPointer pointCloudAccess);


SyscError syscRegisterPointCloudMultiZoneAccess(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscPointCloudMultiZoneAccess pointCloudAccess);


SyscError syscRegisterZoneCountAccess(
  SyscOpaqueDataAccess opaqueDataAccess,
  SyscZoneCountAccess zoneCountAccess);


SyscError syscRegisterRestartPointCreation(
  SyscRestartPointCreation restartPointCreation);


SyscError syscInitializeAnalysis();


int syscDoIteration();


int syscDoTimeStep();


SyscTimeStep syscGetCurrentTimeStep();


SyscError syscUpdateInputs();


SyscError syscUpdateOutputs(const enum SyscConvergenceStatus convStatus);


SyscError syscDisconnect();


void syscFatalError(const char* errorMessage);


void syscNonFatalError(const char* errorMessage);


SyscError syscCheckSurfaceMeshValidity(SyscSurfaceMesh mesh);


int syscWriteSetupFile(const SyscSetupFileInfo setupFileInfo);


SyscError syscWriteResults(const SyscResultsInfo resultsInfo);


size_t syscGetNumRegions();


SyscRegion syscGetAddedRegion(size_t index);


SyscSolutionControl syscGetSolutionControl();


size_t syscGetNumCouplingInterfaces();


SyscCouplingInterface syscGetAddedCouplingInterface(size_t index);


#ifdef __cplusplus
}
#endif

Connect with Ansys