System Coupling C library 2025 R1

syscSystemCoupling

Last update: 17.07.2025
1 /*
2 * Copyright ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
3 */
4 
5 #pragma once
6 
7 #include "SystemCouplingParticipant/LibraryType.hpp"
8 
9 #include "SystemCouplingParticipant/syscCommonTypes.h"
10 #include "SystemCouplingParticipant/syscCouplingInterface.h"
11 #include "SystemCouplingParticipant/syscFunctionTypes.h"
12 #include "SystemCouplingParticipant/syscLegacyInterfaces.h"
13 #include "SystemCouplingParticipant/syscParameter.h"
14 #include "SystemCouplingParticipant/syscPointCloud.h"
15 #include "SystemCouplingParticipant/syscRegion.h"
16 #include "SystemCouplingParticipant/syscVariable.h"
17 #include "SystemCouplingParticipant/syscVolumeMesh.h"
18 #include "SystemCouplingParticipant/syscSurfaceMesh.h"
19 
20 #include <stddef.h>
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
50 SyscError syscStartStandaloneParallel(const size_t mpiCommunicator);
51 
73 SyscError syscConnect(
74  const char* scHost,
75  const unsigned short scPort,
76  const char* participantName,
77  const char* buildInformation);
78 
91 SyscError syscConnectParallel(
92  const char* scHost,
93  const unsigned short scPort,
94  const char* participantName,
95  const size_t communicator,
96  const char* buildInformation);
97 
109 SyscError syscConnectUseStruct(
110  SyscParticipantInfo participantInfo);
111 
126 SyscError syscConnectParallelUseStruct(
127  SyscParticipantInfo participantInfo,
128  const size_t communicator);
129 
143 SyscError syscAddRegion(
144  const SyscRegion region);
145 
166 SyscError syscAddInputParameter(
167  const SyscParameter parameter);
168 
190 SyscError syscAddOutputParameter(
191  const SyscParameter parameter);
192 
199 size_t syscGetNumInputParameters();
200 
207 size_t syscGetNumOutputParameters();
208 
217 SyscParameter syscGetAddedInputParameter(size_t index);
218 
227 SyscParameter syscGetAddedOutputParameter(size_t index);
228 
235 size_t syscGetNumRealAttributes();
236 
243 size_t syscGetNumIntegerAttributes();
244 
253 SyscRealAttribute syscGetAddedRealAttribute(size_t index);
254 
263 SyscIntegerAttribute syscGetAddedIntegerAttribute(size_t index);
264 
285 SyscError syscAddRealAttribute(
286  const SyscRealAttribute attribute);
287 
308 SyscError syscAddIntegerAttribute(
309  const SyscIntegerAttribute attribute);
310 
319 double syscGetParameterValue(const char* parameterName, SyscError* errorCode);
320 
329 SyscError syscSetParameterValue(
330  const char* parameterName,
331  double value);
332 
340 double syscGetRealAttributeValue(
341  const char* attributeName,
342  SyscError* errorCode);
343 
351 int64_t syscGetIntegerAttributeValue(
352  const char* attributeName,
353  SyscError* errorCode);
354 
370 SyscError syscAddCouplingInterface(
371  const SyscCouplingInterface couplingInterface);
372 
388 SyscError syscAddCouplingInterfaceA(
389  const SyscCouplingInterface couplingInterface,
390  int autoGenerateDataTransfers);
391 
405 SyscError syscCompleteSetup(const SyscSetupInfo setupInfo);
406 
414 SyscError syscRegisterInputScalarDataAccess(
415  SyscInputScalarDataAccess dataAccess);
416 
427 SyscError syscRegisterInputScalarDataAccessWithPointer(
428  SyscOpaqueDataAccess opaqueDataAccess,
429  SyscInputScalarDataAccessWithPointer dataAccess);
430 
438 SyscError syscRegisterInputScalarDataMultiZoneAccess(
439  SyscOpaqueDataAccess opaqueDataAccess,
440  SyscInputScalarDataMultiZoneAccess dataAccess);
441 
449 SyscError syscRegisterInputVectorDataAccess(
450  SyscInputVectorDataAccess dataAccess);
451 
462 SyscError syscRegisterInputVectorDataAccessWithPointer(
463  SyscOpaqueDataAccess opaqueDataAccess,
464  SyscInputVectorDataAccessWithPointer dataAccess);
465 
473 SyscError syscRegisterInputVectorDataMultiZoneAccess(
474  SyscOpaqueDataAccess opaqueDataAccess,
475  SyscInputVectorDataMultiZoneAccess dataAccess);
476 
484 SyscError syscRegisterOutputScalarDataAccess(
485  SyscOutputScalarDataAccess dataAccess);
486 
497 SyscError syscRegisterOutputScalarDataAccessWithPointer(
498  SyscOpaqueDataAccess opaqueDataAccess,
499  SyscOutputScalarDataAccessWithPointer dataAccess);
500 
508 SyscError syscRegisterOutputScalarDataMultiZoneAccess(
509  SyscOpaqueDataAccess opaqueDataAccess,
510  SyscOutputScalarDataMultiZoneAccess dataAccess);
511 
519 SyscError syscRegisterOutputVectorDataAccess(
520  SyscOutputVectorDataAccess dataAccess);
521 
532 SyscError syscRegisterOutputVectorDataAccessWithPointer(
533  SyscOpaqueDataAccess opaqueDataAccess,
534  SyscOutputVectorDataAccessWithPointer dataAccess);
535 
543 SyscError syscRegisterOutputVectorDataMultiZoneAccess(
544  SyscOpaqueDataAccess opaqueDataAccess,
545  SyscOutputVectorDataMultiZoneAccess dataAccess);
546 
554 SyscError syscRegisterInputComplexScalarDataAccess(
555  SyscInputComplexScalarDataAccess dataAccess);
556 
567 SyscError syscRegisterInputComplexScalarDataAccessWithPointer(
568  SyscOpaqueDataAccess opaqueDataAccess,
569  SyscInputComplexScalarDataAccessWithPointer dataAccess);
570 
578 SyscError syscRegisterInputComplexVectorDataAccess(
579  SyscInputComplexVectorDataAccess dataAccess);
580 
591 SyscError syscRegisterInputComplexVectorDataAccessWithPointer(
592  SyscOpaqueDataAccess opaqueDataAccess,
593  SyscInputComplexVectorDataAccessWithPointer dataAccess);
594 
602 SyscError syscRegisterOutputComplexScalarDataAccess(
603  SyscOutputComplexScalarDataAccess dataAccess);
604 
615 SyscError syscRegisterOutputComplexScalarDataAccessWithPointer(
616  SyscOpaqueDataAccess opaqueDataAccess,
617  SyscOutputComplexScalarDataAccessWithPointer dataAccess);
618 
626 SyscError syscRegisterOutputComplexVectorDataAccess(
627  SyscOutputComplexVectorDataAccess dataAccess);
628 
639 SyscError syscRegisterOutputComplexVectorDataAccessWithPointer(
640  SyscOpaqueDataAccess opaqueDataAccess,
641  SyscOutputComplexVectorDataAccessWithPointer dataAccess);
642 
650 SyscError syscRegisterSurfMeshAccess(SyscSurfMeshAccess meshAccess);
651 
662 SyscError syscRegisterSurfaceMeshAccessWithPointer(
663  SyscOpaqueDataAccess opaqueDataAccess,
664  SyscSurfaceMeshAccessWithPointer meshAccess);
665 
676 SyscError syscRegisterSurfaceMeshMultiZoneAccess(
677  SyscOpaqueDataAccess opaqueDataAccess,
678  SyscSurfaceMeshMultiZoneAccess meshAccess);
679 
687 SyscError syscRegisterVolumeMeshAccess(SyscVolumeMeshAccess meshAccess);
688 
699 SyscError syscRegisterVolumeMeshAccessWithPointer(
700  SyscOpaqueDataAccess opaqueDataAccess,
701  SyscVolumeMeshAccessWithPointer meshAccess);
702 
713 SyscError syscRegisterVolumeMeshMultiZoneAccess(
714  SyscOpaqueDataAccess opaqueDataAccess,
715  SyscVolumeMeshMultiZoneAccess meshAccess);
716 
724 SyscError syscRegisterPointCloudAccess(SyscPointCloudAccess pointCloudAccess);
725 
736 SyscError syscRegisterPointCloudAccessWithPointer(
737  SyscOpaqueDataAccess opaqueDataAccess,
738  SyscPointCloudAccessWithPointer pointCloudAccess);
739 
750 SyscError syscRegisterPointCloudMultiZoneAccess(
751  SyscOpaqueDataAccess opaqueDataAccess,
752  SyscPointCloudMultiZoneAccess pointCloudAccess);
753 
758 SyscError syscRegisterZoneCountAccess(
759  SyscOpaqueDataAccess opaqueDataAccess,
760  SyscZoneCountAccess zoneCountAccess);
761 
770 SyscError syscRegisterRestartPointCreation(
771  SyscRestartPointCreation restartPointCreation);
772 
784 SyscError syscInitializeAnalysis();
785 
793 int syscDoIteration();
794 
812 int syscDoTimeStep();
813 
825 SyscTimeStep syscGetCurrentTimeStep();
826 
846 SyscError syscUpdateInputs();
847 
856 SyscError syscUpdateOutputs(const enum SyscConvergenceStatus convStatus);
857 
863 SyscError syscDisconnect();
864 
867 void syscFatalError(const char* errorMessage);
868 
871 void syscNonFatalError(const char* errorMessage);
872 
891 SyscError syscCheckSurfaceMeshValidity(SyscSurfaceMesh mesh);
892 
906 int syscWriteSetupFile(const SyscSetupFileInfo setupFileInfo);
907 
910 SyscError syscWriteResults(const SyscResultsInfo resultsInfo);
911 
918 size_t syscGetNumRegions();
919 
929 SyscRegion syscGetAddedRegion(size_t index);
930 
933 SyscSolutionControl syscGetSolutionControl();
934 
941 size_t syscGetNumCouplingInterfaces();
942 
943 
944 SyscCouplingInterface syscGetAddedCouplingInterface(size_t index);
945 
948 #ifdef __cplusplus
949 }
950 #endif
syscFatalError
void syscFatalError(const char *errorMessage)
Provide a function to notify System Coupling about a fatal error.
syscRegisterSurfMeshAccess
SyscError syscRegisterSurfMeshAccess(SyscSurfMeshAccess meshAccess)
Provide a function to register surface mesh access.
syscRegisterInputScalarDataAccessWithPointer
SyscError syscRegisterInputScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputScalarDataAccessWithPointer dataAccess)
Provide a function to register input scalar data access.
syscRegisterInputScalarDataAccess
SyscError syscRegisterInputScalarDataAccess(SyscInputScalarDataAccess dataAccess)
Provide a function to register input scalar data access.
syscDisconnect
SyscError syscDisconnect()
Provide a function to end the analysis and disconnect from System Coupling.
syscGetAddedInputParameter
SyscParameter syscGetAddedInputParameter(size_t index)
Provide a function to return input parameter information.
syscGetNumInputParameters
size_t syscGetNumInputParameters()
Provide a method to get the number of input parameters.
SyscConvergenceStatus
SyscConvergenceStatus
Provide enum for participant's solver convergence status.
Definition: syscCommonTypes.h:109
syscGetIntegerAttributeValue
int64_t syscGetIntegerAttributeValue(const char *attributeName, SyscError *errorCode)
Provide a function to get an IntegerAttribute value.
syscConnect
SyscError syscConnect(const char *scHost, const unsigned short scPort, const char *participantName, const char *buildInformation)
Provide a function to establish connection to System Coupling.
SyscOutputComplexScalarDataAccess
SyscOutputComplexScalarData(* SyscOutputComplexScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output complex scalar data.
Definition: syscFunctionTypes.h:165
SyscOpaqueDataAccess
void * SyscOpaqueDataAccess
Definition: syscCommonTypes.h:156
SyscOutputComplexVectorDataAccessWithPointer
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
syscRegisterOutputComplexScalarDataAccess
SyscError syscRegisterOutputComplexScalarDataAccess(SyscOutputComplexScalarDataAccess dataAccess)
Provide a function to register output complex scalar data access.
syscRegisterOutputComplexVectorDataAccess
SyscError syscRegisterOutputComplexVectorDataAccess(SyscOutputComplexVectorDataAccess dataAccess)
Provide a function to register output complex vector data access.
SyscOutputVectorDataMultiZoneAccess
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
syscRegisterInputComplexScalarDataAccess
SyscError syscRegisterInputComplexScalarDataAccess(SyscInputComplexScalarDataAccess dataAccess)
Provide a function to register input complex scalar data access.
syscRegisterVolumeMeshAccess
SyscError syscRegisterVolumeMeshAccess(SyscVolumeMeshAccess meshAccess)
Provide a function to register volume mesh access.
syscRegisterOutputScalarDataAccessWithPointer
SyscError syscRegisterOutputScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputScalarDataAccessWithPointer dataAccess)
Provide a function to register output scalar data access.
syscRegisterRestartPointCreation
SyscError syscRegisterRestartPointCreation(SyscRestartPointCreation restartPointCreation)
Provide a function to register restart point creation callback.
syscRegisterSurfaceMeshMultiZoneAccess
SyscError syscRegisterSurfaceMeshMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscSurfaceMeshMultiZoneAccess meshAccess)
Provide a function to register surface mesh multi-zone access.
syscAddInputParameter
SyscError syscAddInputParameter(const SyscParameter parameter)
Provide a method to add an input parameter that could be used in a coupled analysis.
syscRegisterInputVectorDataAccess
SyscError syscRegisterInputVectorDataAccess(SyscInputVectorDataAccess dataAccess)
Provide a function to register input vector data access.
syscUpdateOutputs
SyscError syscUpdateOutputs(const enum SyscConvergenceStatus convStatus)
Provide a function to update the participants output variables.
syscRegisterVolumeMeshAccessWithPointer
SyscError syscRegisterVolumeMeshAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscVolumeMeshAccessWithPointer meshAccess)
Provide a function to register volume mesh access.
syscAddRegion
SyscError syscAddRegion(const SyscRegion region)
Provide a function to add a region that could be used in a coupled analysis.
syscCheckSurfaceMeshValidity
SyscError syscCheckSurfaceMeshValidity(SyscSurfaceMesh mesh)
Provide a function to perform simple mesh validity checks.
syscRegisterInputVectorDataAccessWithPointer
SyscError syscRegisterInputVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputVectorDataAccessWithPointer dataAccess)
Provide a function to register input vector data access.
syscGetSolutionControl
SyscSolutionControl syscGetSolutionControl()
Get solution control.
syscAddCouplingInterface
SyscError syscAddCouplingInterface(const SyscCouplingInterface couplingInterface)
Provide a function to add a coupling interface.
syscGetParameterValue
double syscGetParameterValue(const char *parameterName, SyscError *errorCode)
Provide a function to get a Parameter value.
syscRegisterInputComplexScalarDataAccessWithPointer
SyscError syscRegisterInputComplexScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputComplexScalarDataAccessWithPointer dataAccess)
Provide a function to register input complex scalar data access.
syscGetNumRegions
size_t syscGetNumRegions()
Provide a function to return the number of added regions.
syscRegisterOutputComplexScalarDataAccessWithPointer
SyscError syscRegisterOutputComplexScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputComplexScalarDataAccessWithPointer dataAccess)
Provide a function to register output complex scalar data access.
SyscOutputComplexVectorDataAccess
SyscOutputComplexVectorData(* SyscOutputComplexVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output complex vector data.
Definition: syscFunctionTypes.h:180
syscSetParameterValue
SyscError syscSetParameterValue(const char *parameterName, double value)
Provide a function to set a Parameter value.
syscConnectParallel
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.
SyscInputComplexVectorDataAccessWithPointer
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
syscRegisterInputScalarDataMultiZoneAccess
SyscError syscRegisterInputScalarDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscInputScalarDataMultiZoneAccess dataAccess)
Provide a function to register input scalar data multi-zone access.
SyscRestartPointCreation
const char *(* SyscRestartPointCreation)()
Provide function prototype for creating restart points.
Definition: syscFunctionTypes.h:263
syscRegisterOutputScalarDataAccess
SyscError syscRegisterOutputScalarDataAccess(SyscOutputScalarDataAccess dataAccess)
Provide a function to register output scalar data access.
syscGetAddedIntegerAttribute
SyscIntegerAttribute syscGetAddedIntegerAttribute(size_t index)
Provide a function to return integer attribute information.
SyscOutputComplexScalarDataAccessWithPointer
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
SyscSurfMeshAccess
SyscSurfaceMesh(* SyscSurfMeshAccess)(const char *regionName)
Provide function prototype for access to surface mesh.
Definition: syscFunctionTypes.h:195
syscGetAddedRegion
SyscRegion syscGetAddedRegion(size_t index)
Provide a function to return added region given the region index.
SyscOutputScalarDataMultiZoneAccess
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
syscRegisterPointCloudMultiZoneAccess
SyscError syscRegisterPointCloudMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscPointCloudMultiZoneAccess pointCloudAccess)
Provide a function to register point cloud multi-zone access.
syscRegisterOutputScalarDataMultiZoneAccess
SyscError syscRegisterOutputScalarDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputScalarDataMultiZoneAccess dataAccess)
Provide a function to register output scalar data multi-zone access.
SyscInputComplexScalarDataAccessWithPointer
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
syscAddIntegerAttribute
SyscError syscAddIntegerAttribute(const SyscIntegerAttribute attribute)
Provide a method to add an integer attribute that could be used in a coupled analysis.
syscCompleteSetup
SyscError syscCompleteSetup(const SyscSetupInfo setupInfo)
Provide a function to notify System Coupling that setup can be completed.
syscUpdateInputs
SyscError syscUpdateInputs()
Provide a function to update the participants input variables.
SyscInputScalarDataMultiZoneAccess
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
syscRegisterOutputComplexVectorDataAccessWithPointer
SyscError syscRegisterOutputComplexVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputComplexVectorDataAccessWithPointer dataAccess)
Provide a function to register output complex vector data access.
syscStartStandaloneParallel
SyscError syscStartStandaloneParallel(const size_t mpiCommunicator)
Provide a function to start standalone mode in parallel.
syscGetNumCouplingInterfaces
size_t syscGetNumCouplingInterfaces()
Provide a function to return the number of added coupling interfaces.
SyscInputVectorDataAccess
SyscInputVectorData(* SyscInputVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input vector data.
Definition: syscFunctionTypes.h:63
syscConnectUseStruct
SyscError syscConnectUseStruct(SyscParticipantInfo participantInfo)
Provide a function to establish connection to System Coupling in serial using a C structure.
syscRegisterOutputVectorDataAccessWithPointer
SyscError syscRegisterOutputVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputVectorDataAccessWithPointer dataAccess)
Provide a function to register output vector data access.
SyscSurfaceMeshMultiZoneAccess
SyscSurfaceMesh(* SyscSurfaceMeshMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone surface mesh.
Definition: syscFunctionTypes.h:206
syscInitializeAnalysis
SyscError syscInitializeAnalysis()
Provide a function to notify System Coupling that analysis initialization can be completed.
syscRegisterOutputVectorDataAccess
SyscError syscRegisterOutputVectorDataAccess(SyscOutputVectorDataAccess dataAccess)
Provide a function to register output vector data access.
syscGetNumOutputParameters
size_t syscGetNumOutputParameters()
Provide a method to get the number of output parameters.
syscGetAddedOutputParameter
SyscParameter syscGetAddedOutputParameter(size_t index)
Provide a function to return input parameter information.
SyscZoneCountAccess
uint16_t(* SyscZoneCountAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to zone count.
Definition: syscFunctionTypes.h:252
SyscInputScalarDataAccess
SyscInputScalarData(* SyscInputScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input scalar data.
Definition: syscFunctionTypes.h:39
SyscOutputVectorDataAccessWithPointer
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
SyscOutputScalarDataAccessWithPointer
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
SyscInputComplexScalarDataAccess
SyscInputComplexScalarData(* SyscInputComplexScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input complex scalar data.
Definition: syscFunctionTypes.h:135
syscRegisterVolumeMeshMultiZoneAccess
SyscError syscRegisterVolumeMeshMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscVolumeMeshMultiZoneAccess meshAccess)
Provide a function to register volume mesh multi-zone access.
SyscOutputScalarDataAccess
SyscOutputScalarData(* SyscOutputScalarDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output scalar data.
Definition: syscFunctionTypes.h:87
SyscPointCloudMultiZoneAccess
SyscPointCloud(* SyscPointCloudMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone point cloud.
Definition: syscFunctionTypes.h:244
syscGetNumRealAttributes
size_t syscGetNumRealAttributes()
Provide a function to get the number of real attributes.
syscConnectParallelUseStruct
SyscError syscConnectParallelUseStruct(SyscParticipantInfo participantInfo, const size_t communicator)
Provide a function to establish connection to System Coupling in parallel using a C structure.
syscGetCurrentTimeStep
SyscTimeStep syscGetCurrentTimeStep()
Provide a function to get current time step.
SyscInputComplexVectorDataAccess
SyscInputComplexVectorData(* SyscInputComplexVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to input complex vector data.
Definition: syscFunctionTypes.h:150
syscAddRealAttribute
SyscError syscAddRealAttribute(const SyscRealAttribute attribute)
Provide a method to add a real attribute that could be used in a coupled analysis.
SyscVolumeMeshAccess
SyscVolumeMesh(* SyscVolumeMeshAccess)(const char *regionName)
Provide function prototype for access to volume mesh.
Definition: syscFunctionTypes.h:214
SyscInputScalarDataAccessWithPointer
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
syscRegisterZoneCountAccess
SyscError syscRegisterZoneCountAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscZoneCountAccess zoneCountAccess)
Provide a function to register zone count access.
syscWriteSetupFile
int syscWriteSetupFile(const SyscSetupFileInfo setupFileInfo)
Provide a function to write the setup file.
syscRegisterOutputVectorDataMultiZoneAccess
SyscError syscRegisterOutputVectorDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputVectorDataMultiZoneAccess dataAccess)
Provide a function to register output vector data multi-zone access.
syscRegisterInputVectorDataMultiZoneAccess
SyscError syscRegisterInputVectorDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscInputVectorDataMultiZoneAccess dataAccess)
Provide a function to register input vector data multi-zone access.
SyscVolumeMeshAccessWithPointer
SyscVolumeMesh(* SyscVolumeMeshAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to volume mesh with opaque pointer.
Definition: syscFunctionTypes.h:220
syscRegisterSurfaceMeshAccessWithPointer
SyscError syscRegisterSurfaceMeshAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscSurfaceMeshAccessWithPointer meshAccess)
Provide a function to register surface mesh access.
syscRegisterPointCloudAccess
SyscError syscRegisterPointCloudAccess(SyscPointCloudAccess pointCloudAccess)
Provide a function to register point cloud access.
syscAddCouplingInterfaceA
SyscError syscAddCouplingInterfaceA(const SyscCouplingInterface couplingInterface, int autoGenerateDataTransfers)
Provide a function to add a coupling interface.
syscRegisterInputComplexVectorDataAccessWithPointer
SyscError syscRegisterInputComplexVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputComplexVectorDataAccessWithPointer dataAccess)
Provide a function to register input complex vector data access.
SyscInputVectorDataMultiZoneAccess
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
SyscInputVectorDataAccessWithPointer
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
SyscPointCloudAccess
SyscPointCloud(* SyscPointCloudAccess)(const char *regionName)
Provide function prototype for access to point cloud.
Definition: syscFunctionTypes.h:233
SyscOutputVectorDataAccess
SyscOutputVectorData(* SyscOutputVectorDataAccess)(const char *regionName, const char *variableName)
Provide function prototype for access to output vector data.
Definition: syscFunctionTypes.h:111
syscDoIteration
int syscDoIteration()
Provide a function to check whether to do a coupling iteration.
syscRegisterPointCloudAccessWithPointer
SyscError syscRegisterPointCloudAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscPointCloudAccessWithPointer pointCloudAccess)
Provide a function to register point cloud access.
syscGetAddedRealAttribute
SyscRealAttribute syscGetAddedRealAttribute(size_t index)
Provide a function to return real attribute information.
syscAddOutputParameter
SyscError syscAddOutputParameter(const SyscParameter parameter)
Provide a method to add an output parameter that could be used in a coupled analysis.
syscRegisterInputComplexVectorDataAccess
SyscError syscRegisterInputComplexVectorDataAccess(SyscInputComplexVectorDataAccess dataAccess)
Provide a function to register input complex vector data access.
SyscVolumeMeshMultiZoneAccess
SyscVolumeMesh(* SyscVolumeMeshMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)
Provide function prototype for access to multi-zone volume mesh.
Definition: syscFunctionTypes.h:225
syscGetNumIntegerAttributes
size_t syscGetNumIntegerAttributes()
Provide a function to get the number of integer attributes.
syscGetRealAttributeValue
double syscGetRealAttributeValue(const char *attributeName, SyscError *errorCode)
Provide a function to get a RealAttribute value.
syscDoTimeStep
int syscDoTimeStep()
Provide a function to check whether to do a coupling time step.
SyscPointCloudAccessWithPointer
SyscPointCloud(* SyscPointCloudAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to point cloud with an opaque pointer.
Definition: syscFunctionTypes.h:239
syscWriteResults
SyscError syscWriteResults(const SyscResultsInfo resultsInfo)
Write results to a file.
SyscSurfaceMeshAccessWithPointer
SyscSurfaceMesh(* SyscSurfaceMeshAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)
Provide function prototype for access to surface mesh with opaque pointer.
Definition: syscFunctionTypes.h:201
syscNonFatalError
void syscNonFatalError(const char *errorMessage)
Provide a function to notify System Coupling about a non fatal error.
SyscCouplingInterface
Provide a struct for a coupling interface.
Definition: syscCouplingInterface.h:45
SyscError
Provide a struct for detecting errors from the interface calls.
Definition: syscCommonTypes.h:137
SyscIntegerAttribute
Provide a struct for an integer-valued attribute.
Definition: syscAttribute.h:70
SyscParameter
Provide a struct for a System Coupling parameter.
Definition: syscParameter.h:26
SyscParticipantInfo
Provide a structure to provide connection info to System Coupling.
Definition: syscCommonTypes.h:315
SyscRealAttribute
Provide a struct for a real-valued attribute.
Definition: syscAttribute.h:24
SyscRegion
Provide a struct for a System Coupling region.
Definition: syscRegion.h:42
SyscResultsInfo
Provide a structure for writing results files.
Definition: syscCommonTypes.h:276
SyscSetupFileInfo
Provide a structure for writing System Coupling setup files.
Definition: syscCommonTypes.h:256
SyscSetupInfo
Provide a structure for System Coupling setup information.
Definition: syscCommonTypes.h:172
SyscSolutionControl
Provide a structure containing solution control.
Definition: syscCommonTypes.h:131
SyscSurfaceMesh
Provide a surface mesh access struct.
Definition: syscSurfaceMesh.h:31
SyscTimeStep
Provide a struct for time step.
Definition: syscCommonTypes.h:124

Connect with Ansys