syscSystemCoupling
Last update: 17.07.2025void syscFatalError(const char *errorMessage)
Provide a function to notify System Coupling about a fatal error.
SyscError syscRegisterSurfMeshAccess(SyscSurfMeshAccess meshAccess)
Provide a function to register surface mesh access.
SyscError syscRegisterInputScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputScalarDataAccessWithPointer dataAccess)
Provide a function to register input scalar data access.
SyscError syscRegisterInputScalarDataAccess(SyscInputScalarDataAccess dataAccess)
Provide a function to register input scalar data access.
SyscError syscDisconnect()
Provide a function to end the analysis and disconnect from System Coupling.
SyscParameter syscGetAddedInputParameter(size_t index)
Provide a function to return input parameter information.
size_t syscGetNumInputParameters()
Provide a method to get the number of input parameters.
SyscConvergenceStatus
Provide enum for participant's solver convergence status.
Definition syscCommonTypes.h:109
SyscError syscConnect(const char *scHost, const unsigned short scPort, const char *participantName, const char *buildInformation)
Provide a function to establish connection to System Coupling.
SyscOutputComplexScalarData(* SyscOutputComplexScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output complex scalar data.
Definition syscFunctionTypes.h:165
SyscOutputComplexVectorData(* SyscOutputComplexVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output complex vector data with opaque pointer.
Definition syscFunctionTypes.h:187
SyscError syscRegisterOutputComplexScalarDataAccess(SyscOutputComplexScalarDataAccess dataAccess)
Provide a function to register output complex scalar data access.
SyscError syscRegisterOutputComplexVectorDataAccess(SyscOutputComplexVectorDataAccess dataAccess)
Provide a function to register output complex vector data access.
SyscOutputVectorData(* SyscOutputVectorDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone output vector data.
Definition syscFunctionTypes.h:126
SyscError syscRegisterInputComplexScalarDataAccess(SyscInputComplexScalarDataAccess dataAccess)
Provide a function to register input complex scalar data access.
SyscError syscRegisterVolumeMeshAccess(SyscVolumeMeshAccess meshAccess)
Provide a function to register volume mesh access.
SyscError syscRegisterOutputScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputScalarDataAccessWithPointer dataAccess)
Provide a function to register output scalar data access.
SyscError syscRegisterRestartPointCreation(SyscRestartPointCreation restartPointCreation)
Provide a function to register restart point creation callback.
SyscError syscRegisterSurfaceMeshMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscSurfaceMeshMultiZoneAccess meshAccess)
Provide a function to register surface mesh multi-zone access.
SyscError syscAddInputParameter(const SyscParameter parameter)
Provide a method to add an input parameter that could be used in a coupled analysis.
SyscError syscRegisterInputVectorDataAccess(SyscInputVectorDataAccess dataAccess)
Provide a function to register input vector data access.
SyscError syscUpdateOutputs(const enum SyscConvergenceStatus convStatus)
Provide a function to update the participants output variables.
SyscError syscRegisterVolumeMeshAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscVolumeMeshAccessWithPointer meshAccess)
Provide a function to register volume mesh access.
SyscError syscAddRegion(const SyscRegion region)
Provide a function to add a region that could be used in a coupled analysis.
SyscError syscCheckSurfaceMeshValidity(SyscSurfaceMesh mesh)
Provide a function to perform simple mesh validity checks.
SyscError syscRegisterInputVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputVectorDataAccessWithPointer dataAccess)
Provide a function to register input vector data access.
SyscError syscAddCouplingInterface(const SyscCouplingInterface couplingInterface)
Provide a function to add a coupling interface.
double syscGetParameterValue(const char *parameterName, SyscError *errorCode)
Provide a function to get a Parameter value.
SyscError syscRegisterInputComplexScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputComplexScalarDataAccessWithPointer dataAccess)
Provide a function to register input complex scalar data access.
size_t syscGetNumRegions()
Provide a function to return the number of added regions.
SyscError syscRegisterOutputComplexScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputComplexScalarDataAccessWithPointer dataAccess)
Provide a function to register output complex scalar data access.
SyscOutputComplexVectorData(* SyscOutputComplexVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output complex vector data.
Definition syscFunctionTypes.h:180
SyscError syscSetParameterValue(const char *parameterName, double value)
Provide a function to set a Parameter value.
SyscError syscConnectParallel(const char *scHost, const unsigned short scPort, const char *participantName, const size_t communicator, const char *buildInformation)
Provide a function to establish connection to System Coupling in parallel.
SyscInputComplexVectorData(* SyscInputComplexVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input complex vector data with opaque pointer.
Definition syscFunctionTypes.h:157
SyscError syscRegisterInputScalarDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscInputScalarDataMultiZoneAccess dataAccess)
Provide a function to register input scalar data multi-zone access.
SyscError syscRegisterOutputScalarDataAccess(SyscOutputScalarDataAccess dataAccess)
Provide a function to register output scalar data access.
SyscOutputComplexScalarData(* SyscOutputComplexScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output complex scalar data with opaque pointer.
Definition syscFunctionTypes.h:172
SyscSurfaceMesh(* SyscSurfMeshAccess)(const char *regionName)
Provide function prototype for access to surface mesh.
Definition syscFunctionTypes.h:195
SyscRegion syscGetAddedRegion(size_t index)
Provide a function to return added region given the region index.
SyscOutputScalarData(* SyscOutputScalarDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone output scalar data.
Definition syscFunctionTypes.h:102
SyscError syscRegisterPointCloudMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscPointCloudMultiZoneAccess pointCloudAccess)
Provide a function to register point cloud multi-zone access.
SyscError syscRegisterOutputScalarDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputScalarDataMultiZoneAccess dataAccess)
Provide a function to register output scalar data multi-zone access.
SyscInputComplexScalarData(* SyscInputComplexScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input complex scalar data with opaque pointer.
Definition syscFunctionTypes.h:142
const char *(* SyscRestartPointCreation)()
Provide function prototype for creating restart points.
Definition syscFunctionTypes.h:263
SyscError syscCompleteSetup(const SyscSetupInfo setupInfo)
Provide a function to notify System Coupling that setup can be completed.
SyscError syscUpdateInputs()
Provide a function to update the participants input variables.
SyscInputScalarData(* SyscInputScalarDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone input scalar data.
Definition syscFunctionTypes.h:54
SyscError syscRegisterOutputComplexVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputComplexVectorDataAccessWithPointer dataAccess)
Provide a function to register output complex vector data access.
SyscError syscStartStandaloneParallel(const size_t mpiCommunicator)
Provide a function to start standalone mode in parallel.
size_t syscGetNumCouplingInterfaces()
Provide a function to return the number of added coupling interfaces.
SyscInputVectorData(* SyscInputVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input vector data.
Definition syscFunctionTypes.h:63
SyscError syscConnectUseStruct(SyscParticipantInfo participantInfo)
Provide a function to establish connection to System Coupling in serial using a C structure.
SyscError syscRegisterOutputVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputVectorDataAccessWithPointer dataAccess)
Provide a function to register output vector data access.
SyscSurfaceMesh(* SyscSurfaceMeshMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone surface mesh.
Definition syscFunctionTypes.h:206
SyscError syscInitializeAnalysis()
Provide a function to notify System Coupling that analysis initialization can be completed.
SyscError syscRegisterOutputVectorDataAccess(SyscOutputVectorDataAccess dataAccess)
Provide a function to register output vector data access.
size_t syscGetNumOutputParameters()
Provide a method to get the number of output parameters.
SyscParameter syscGetAddedOutputParameter(size_t index)
Provide a function to return input parameter information.
uint16_t(* SyscZoneCountAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to zone count.
Definition syscFunctionTypes.h:252
SyscInputScalarData(* SyscInputScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input scalar data.
Definition syscFunctionTypes.h:39
SyscOutputVectorData(* SyscOutputVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output vector data with opaque pointer.
Definition syscFunctionTypes.h:118
SyscOutputScalarData(* SyscOutputScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to output scalar data with opaque pointer.
Definition syscFunctionTypes.h:94
SyscInputComplexScalarData(* SyscInputComplexScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input complex scalar data.
Definition syscFunctionTypes.h:135
SyscError syscRegisterVolumeMeshMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscVolumeMeshMultiZoneAccess meshAccess)
Provide a function to register volume mesh multi-zone access.
SyscOutputScalarData(* SyscOutputScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output scalar data.
Definition syscFunctionTypes.h:87
SyscPointCloud(* SyscPointCloudMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone point cloud.
Definition syscFunctionTypes.h:244
SyscError syscConnectParallelUseStruct(SyscParticipantInfo participantInfo, const size_t communicator)
Provide a function to establish connection to System Coupling in parallel using a C structure.
SyscTimeStep syscGetCurrentTimeStep()
Provide a function to get current time step.
SyscInputComplexVectorData(* SyscInputComplexVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input complex vector data.
Definition syscFunctionTypes.h:150
SyscVolumeMesh(* SyscVolumeMeshAccess)(const char *regionName)
Provide function prototype for access to volume mesh.
Definition syscFunctionTypes.h:214
SyscInputScalarData(* SyscInputScalarDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input scalar data with opaque pointer.
Definition syscFunctionTypes.h:46
SyscError syscRegisterZoneCountAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscZoneCountAccess zoneCountAccess)
Provide a function to register zone count access.
int syscWriteSetupFile(const SyscSetupFileInfo setupFileInfo)
Provide a function to write the setup file.
SyscError syscRegisterOutputVectorDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputVectorDataMultiZoneAccess dataAccess)
Provide a function to register output vector data multi-zone access.
SyscError syscRegisterInputVectorDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscInputVectorDataMultiZoneAccess dataAccess)
Provide a function to register input vector data multi-zone access.
SyscVolumeMesh(* SyscVolumeMeshAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to volume mesh with opaque pointer.
Definition syscFunctionTypes.h:220
SyscError syscRegisterSurfaceMeshAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscSurfaceMeshAccessWithPointer meshAccess)
Provide a function to register surface mesh access.
SyscError syscRegisterPointCloudAccess(SyscPointCloudAccess pointCloudAccess)
Provide a function to register point cloud access.
SyscError syscAddCouplingInterfaceA(const SyscCouplingInterface couplingInterface, int autoGenerateDataTransfers)
Provide a function to add a coupling interface.
SyscError syscRegisterInputComplexVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputComplexVectorDataAccessWithPointer dataAccess)
Provide a function to register input complex vector data access.
SyscInputVectorData(* SyscInputVectorDataMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone input vector data.
Definition syscFunctionTypes.h:78
SyscInputVectorData(* SyscInputVectorDataAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, const char *variableName)
Provide function prototype for access to input vector data with opaque pointer.
Definition syscFunctionTypes.h:70
SyscPointCloud(* SyscPointCloudAccess)(const char *regionName)
Provide function prototype for access to point cloud.
Definition syscFunctionTypes.h:233
SyscOutputVectorData(* SyscOutputVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output vector data.
Definition syscFunctionTypes.h:111
SyscError syscRegisterPointCloudAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscPointCloudAccessWithPointer pointCloudAccess)
Provide a function to register point cloud access.
SyscError syscAddOutputParameter(const SyscParameter parameter)
Provide a method to add an output parameter that could be used in a coupled analysis.
SyscError syscRegisterInputComplexVectorDataAccess(SyscInputComplexVectorDataAccess dataAccess)
Provide a function to register input complex vector data access.
SyscVolumeMesh(* SyscVolumeMeshMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone volume mesh.
Definition syscFunctionTypes.h:225
SyscPointCloud(* SyscPointCloudAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to point cloud with an opaque pointer.
Definition syscFunctionTypes.h:239
SyscError syscWriteResults(const SyscResultsInfo resultsInfo)
Write results to a file.
SyscSurfaceMesh(* SyscSurfaceMeshAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to surface mesh with opaque pointer.
Definition syscFunctionTypes.h:201
Provide a struct for a coupling interface.
Definition syscCouplingInterface.h:45
Provide a struct for detecting errors from the interface calls.
Definition syscCommonTypes.h:137
Provide a structure to provide connection info to System Coupling.
Definition syscCommonTypes.h:315
Provide a structure for writing System Coupling setup files.
Definition syscCommonTypes.h:256
Provide a structure for System Coupling setup information.
Definition syscCommonTypes.h:172
