## On this page
# Class sysc::SystemCoupling
Last update: 17.07.2025
**Definition**: `SystemCoupling.hpp` (line 47)
Provide the main class for interacting with the System Coupling participant library.
For co-simulation, this class maintains the socket connection to the System Coupling solver. The coupling participant will need to provide host and port information for existing System Coupling server, as well as the name of this coupling participant.
For mapping, an instance of this class should be created to perform mapping.
There should only be one instance of this System Coupling class.
## Members
- [addCouplingInterface](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ae4c93f4502c9df950fddddab3aab5eec)
- [addCouplingInterface](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ae1f7fe88e678c07cde61acff8742b608)
- [addInputParameter](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a141ea7f0524e5e8dc7e051408477e9cb)
- [addIntegerAttribute](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a85e574ea482ec764a16b7ee64beda3de)
- [addOutputParameter](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1aefc367f59f86420aaaa425d7d24b071c)
- [addRealAttribute](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ab298f64d5d97a11f59650605c062d38a)
- [addRegion](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1afd8d4beebb3a46d80c9f9fcddc385db2)
- [addStringAttribute](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1afe7e2a632aed3933b59dae2d0fbf8cb1)
- [checkMeshValidity](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a8c7d2613f81b8d9a5bd81db9dcbae8fd)
- [checkMeshValidity](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ac6a85f6aae44d330b8042dc9296bd59b)
- [completeCouplingSetup](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a6d389ee7e0740e0348919cd3b7d956f7)
- [completeCouplingSetup](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ae07c136aa42d636df179cc7352065430)
- [completeSetup](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a204a3a8145961af7bc28d2cfd58a4358)
- [disconnect](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a4f15e4d02257cde7717b9fffae806311)
- [doIteration](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a0cb8cd28d752af2cfd0b4d27511ea306)
- [doTimeStep](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a285a15756651ef5027191ca69dfab7e0)
- [fatalError](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a9d5c081a6a43f86de3aef366d6527730)
- [getAddedCouplingInterface](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a8aab50ac4eedd188745852bb0cc94f6d)
- [getAddedRegion](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1adb354cb78a277f08c87b59f97bcdd453)
- [getCurrentTimeStep](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a6ab306d83db2610887c8fb18c554eba6)
- [getInputParameter](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1aff74fa8017356c93a1ea5677a29103e5)
- [getIntegerAttribute](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a47057e45b7637d4709138c5f64d7e0d4)
- [getIntegerAttributeValue](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a4c59f4d91ed51f811b9a8af91129250e)
- [getNumCouplingInterfaces](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a83c9856515b950fa453f36a29c3dd0ca)
- [getNumInputParameters](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a5043b933c85893f89b72c967922e0397)
- [getNumIntegerAttributes](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1aeeb32be00caa7d33c4ddd9b28f80a3a0)
- [getNumOutputParameters](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a6b0bc9b6b4c6155f573c94376e37ba8d)
- [getNumRealAttributes](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a7d91d3013cc5c826f91d42f6e8f5c6d8)
- [getNumRegions](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1af1cac0616352ad6998eefad0593c8ffb)
- [getNumStringAttributes](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1af757a39bdfd82702d7879af71ed835db)
- [getOutputParameter](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1acd9357a14b747921037daa0c24c9bc1b)
- [getParameterValue](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1aefb34bf071d430de2dd4f1be1dc74e84)
- [getRealAttribute](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1adac66a89bdba3cc298631045b659fba1)
- [getRealAttributeValue](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a8ec3e49911120cd590ec285456de40ac)
- [getRegion](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ab70a16b544c86e9681e9946f2ce3ec53)
- [getSetupInfo](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a43ac90ab5f0cfd64fec354519d4f5b43)
- [getSolutionControl](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ace4a88af60a1aa93a68fa4b071592413)
- [getStringAttribute](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a6aff5352468a4c1065e167faa3a02ae2)
- [getStringAttributeValue](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a5fc4695ae6b5bb6e7cd706cb976d3f40)
- [initializeAnalysis](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ab47a6eaf83eae538e17290a5c2582b8e)
- [operator=](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1af9e2480d475df72014f4b565f97d8c70)
- [operator=](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a11c5ccef62c2719e4d0af87796311914)
- [registerDoesTargetDataExist](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a756e4452ee89f8eddf521a57d33d20e4)
- [registerDoesTargetDataExist](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a96819f69d3044bc1f1a6f70c06da90cb)
- [registerInputComplexScalarDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ae65892603ab7d6f24d3a1cbc80af7edb)
- [registerInputComplexScalarDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a878ad16bd59726553ee0a3de9d2bca06)
- [registerInputComplexVectorDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a58064b5079b01898a6951e366ea86331)
- [registerInputComplexVectorDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1abdd59a061b86ef7cef6301652d98ec65)
- [registerInputScalarDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a60439772708be217b06f07f8554d5abd)
- [registerInputScalarDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a61c7be7c0e7ab939f27b49b015fbd8d0)
- [registerInputScalarDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a5b437d3878dde1d36d8bbfe0b68a1ea3)
- [registerInputScalarVariableAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a7f6ec98123d0c18a6fce5c51d9af5e28)
- [registerInputVectorDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1aac58f07f6eaa259959f39eefa3a48275)
- [registerInputVectorDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a3c27f87e2afbd4fc4cd1a3936af119a4)
- [registerInputVectorDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a630e6c6211338d8d2dd3dce15a897019)
- [registerInputVectorVariableAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a742d335b9842d2574d4522834154c3c7)
- [registerOutputComplexScalarDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a6e31333c6867d5214565215c5de97ba2)
- [registerOutputComplexScalarDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a09a5b550343939ded20c225c4cd7c980)
- [registerOutputComplexVectorDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a6ccb2d4f3fe8a866648ffa1f310bc78f)
- [registerOutputComplexVectorDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a85be3c843ee3b5e71f5e54fff61468aa)
- [registerOutputScalarDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1adeacbc3dfb240c3f389d344337839458)
- [registerOutputScalarDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ada68571b9d10213009b97e4701cba62a)
- [registerOutputScalarDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ab71ebbabd746c3b1b0108f298443d38b)
- [registerOutputScalarVariableAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a215a0a89ded36ecab1c4720c7c581b5e)
- [registerOutputVectorDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1abb613dba476f0873e7d59585acb7d981)
- [registerOutputVectorDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1aedc414935e27b77ce784e7f1c5fc6a75)
- [registerOutputVectorDataAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a76d36b21f00f091187e875e5dfb6f6d6)
- [registerOutputVectorVariableAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ab63d037d8a7545bd6b5a6f2b3e91c30f)
- [registerPointCloudAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a05632386db24345a895d5b504c52af5e)
- [registerPointCloudAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a71eeb76fc93f4d9b8618d70ef5f66493)
- [registerPointCloudAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a1e24a3be97eb868486fd6477f26356fd)
- [registerRestartPointCreation](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1aaae2fc4f2cee448f97e69fae2510c1ce)
- [registerSurfaceMeshAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1afb819aa4b19aa15dc552d73803352fb4)
- [registerSurfaceMeshAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a183340630be801da193518a69e183cd1)
- [registerSurfaceMeshAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1adbd878be917e52aa1cf1ef26e152e677)
- [registerTargetDataCreation](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a16f160af31ea38f0a502ff1f746b957b)
- [registerTargetDataCreation](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a753caed2214ab353ae9a377e55c3c2d8)
- [registerVolumeMeshAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1af12f29a1532884bc561c7bd5fe9efc97)
- [registerVolumeMeshAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a692aa29e269337e50d3b134f4628b7c0)
- [registerVolumeMeshAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ad6950fb23d3f98f17f023c29555743b8)
- [registerZoneCountAccess](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a11c8df8113a78dcb40b91534ce1f4b1c)
- [setParameterValue](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1aca0700c21a60e92e3b67c0e50a575133)
- [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1aa85c07a47dbf3cccce8049e8c8fe86cc)
- [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a0381ca6fb1dcf81258ada4e95c354ab9)
- [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a9f7e98bb312a412ae7bc81f0a49afa1a)
- [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a28570e0829c5d0c2177d1b25b55b2da0)
- [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a68a64fa8efe499cc189979d44624d0f7)
- [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a197f13843de7afcd2f84b85eaffa11ad)
- [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a692355d68459adf3eddfaef350bf0c9c)
- [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a8d869edcfaaace05684e095add7d733b)
- [updateInputs](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a9c768f6965f14e8ab3308c7df4144da7)
- [updateOutputs](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a468e5e084477cdaca2adee6c50edf7e9)
- [writeResults](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ac9b3de74b577b71eccf44c901ba0d225)
- [writeSetupFile](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a3d0f96215b1b4609d46e0772c3e3578b)
- [~SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1ad17cf746d960d4911bac179e9bc733bc)
## Public functions
### Function SystemCoupling
```cpp
sysc::SystemCoupling::SystemCoupling()
```
Provide a (default) constructor for the [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) class for non-cosimulation mode.
This is a default constructor that will initialize the participant library in standalone (non-cosimulation) mode.
When running in parallel MPI environment, the parallel communication within the participant library will use MPI\_COMM\_WORLD communicator.
**Return type**:
### Function SystemCoupling
```cpp
sysc::SystemCoupling::SystemCoupling(std::size_t mpiCommunicator)
```
Provide a constructor for the [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) class for non-cosimulation mode with a custom MPI communicator.
**Parameters**:
- **mpiCommunicator**: MPI communicator cast to std::size\_t.
This will initialize the participant library in standalone mode and will use the provided MPI communicator for all parallel communication.
**Parameters**:
- std::size\_t **mpiCommunicator**
**Return type**:
### Function SystemCoupling
```cpp
sysc::SystemCoupling::SystemCoupling(const ParticipantInfo &participantInfo)
```
Provide a constructor for the [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) class with a custom struct representing the default input parameters.
**Parameters**:
- **participantInfo**: The struct containing the attributes needed to connect to System Coupling: scHost, scPort, participantName, etc.
**Parameters**:
- const [ParticipantInfo](structsysc_1_1ParticipantInfo.md#structsysc_1_1ParticipantInfo) & **participantInfo**
**Return type**:
### Function SystemCoupling
```cpp
sysc::SystemCoupling::SystemCoupling(const ParticipantInfo &participantInfo, std::size_t mpiCommunicator)
```
Provide a constructor for the [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) class with an mpiCommunicator object set to non default.
**Parameters**:
- **participantInfo**: The struct containing the attributes needed to connect to System Coupling: scHost, scPort, participantName, etc.
- **mpiCommunicator**: MPI communicator cast to std::size\_t.
**Parameters**:
- const [ParticipantInfo](structsysc_1_1ParticipantInfo.md#structsysc_1_1ParticipantInfo) & **participantInfo**
- std::size\_t **mpiCommunicator**
**Return type**:
### Function SystemCoupling
```cpp
sysc::SystemCoupling::SystemCoupling(const std::string &scHost, unsigned short scPort, const std::string &participantName, const std::string &buildInformation="Unknown")
```
Provide a constructor for the [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) class for cosimulation mode.
Initializes the participant library in cosimulation mode. It establishes the connection to the System Coupling solver.
The participant solver must have obtained the host and port information from System Coupling prior to creating this object (e.g. via an input argument when participant application was started). Copy constructor and assignment operators are disabled to avoid copying the created object.
**Parameters**:
- **scHost**: Name of the host on which System Coupling is running.
- **scPort**: Port number on which System Coupling is listening for participant connections.
- **participantName**: Name of this participant (e.g. "MAPDL-1")
- **buildInformation**: Information about the build of this participant solver. This parameter is optional - default is "Unknown".
**Parameters**:
- const std::string & **scHost**
- unsigned short **scPort**
- const std::string & **participantName**
- const std::string & **buildInformation** = "Unknown"
**Return type**:
### Function SystemCoupling
```cpp
sysc::SystemCoupling::SystemCoupling(const std::string &scHost, unsigned short scPort, const std::string &participantName, std::size_t mpiCommunicator, const std::string &buildInformation)
```
Provide a constructor for the [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) class for cosimulation mode with a custom MPI communicator.
This constructor works the same way as the one above (see above), but it takes in one additional argument, which is the MPI communicator, cast as std::size\_t.
**Parameters**:
- **scHost**: Name of the host on which System Coupling is running.
- **scPort**: Port number on which System Coupling is listening for participant connections.
- **participantName**: Name of this participant (e.g. "MAPDL-1")
- **mpiCommunicator**: MPI communicator cast to std::size\_t.
- **buildInformation**: Information about the build of this participant solver. This parameter is optional - default is "Unknown".
**Parameters**:
- const std::string & **scHost**
- unsigned short **scPort**
- const std::string & **participantName**
- std::size\_t **mpiCommunicator**
- const std::string & **buildInformation**
**Return type**:
### Function ~SystemCoupling
```cpp
sysc::SystemCoupling::~SystemCoupling()
```
**Return type**:
### Function completeSetup
```cpp
void sysc::SystemCoupling::completeSetup(const sysc::SetupInfo &setupInfo)
```
Provide a function to notify System Coupling that setup can be completed.
After this function is called, coupled analysis setup can no longer be updated, i.e. regions and variables cannot be changed. Participant should also pass in [sysc::SetupInfo](structsysc_1_1SetupInfo.md#structsysc_1_1SetupInfo) struct to provide additional information about the setup, such as whether steady or transient analysis is to be performed.
Once the setup is complete, any subsequent call to complete the setup will have no effect.
**Parameters**:
- const [sysc::SetupInfo](structsysc_1_1SetupInfo.md#structsysc_1_1SetupInfo) & **setupInfo**
**Return type**: void
### Function initializeAnalysis
```cpp
void sysc::SystemCoupling::initializeAnalysis()
```
Provide a function to notify System Coupling that analysis initialization can be completed.
This function must be called after registering mesh and variable data access and prior to entering the coupled analysis loop.
If this function is called before the coupled analysis is complete, it will automatically complete the coupled analysis and assume steady analysis type.
**Return type**: void
### Function getCurrentTimeStep
```cpp
sysc::TimeStep sysc::SystemCoupling::getCurrentTimeStep()
```
Provide a function to get current time step.
**Returns**:
Returns a time step struct, which contains time step number, start time, and time step size for the current coupling time step.
A default value (time step number 0, start time 0.0, time step size 0.0) is returned if this function is called outside the coupled analysis loop or if the analysis is steady.
**Return type**: [sysc::TimeStep](structsysc_1_1TimeStep.md#structsysc_1_1TimeStep)
### Function doIteration
```cpp
bool sysc::SystemCoupling::doIteration()
```
Provide a function to check whether to do a coupling iteration.
This function returns true if another coupling iteration is required, otherwise it returns false.
**Return type**: bool
### Function doTimeStep
```cpp
bool sysc::SystemCoupling::doTimeStep()
```
Provide a function to check whether to do a coupling time step.
This function returns true if another coupling time step is required, otherwise it returns false.
This function should be called to check if another coupling time step should be done. If the previous coupling time step is finished and another time step should be performed, then calling this function will tell System Coupling that the coupling participant is going to advance to the next time step (i.e. calling [doTimeStep()](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a285a15756651ef5027191ca69dfab7e0) will cause [doIteration()](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a0cb8cd28d752af2cfd0b4d27511ea306) to change from returning false to returning true, under the conditions described above).
This function only makes sense for transient analysis. It will always return false for steady analysis.
**Return type**: bool
### Function updateInputs
```cpp
void sysc::SystemCoupling::updateInputs()
```
Provide a function to update the participants input variables.
Solution data for all input variables will be updated. Depending on the defined interfaces, data will be transferred from another coupling participant solver, or from the opposite side of the same-participant coupling interface.
When doing cosimulation, this function must be called from inside the coupled analysis loop. It tells System Coupling that the participant is about to begin its solver iterations. All input variable data will be up-to-date after returning from this function. If any local coupling interfaces are defined, all corresponding input variable data will also be updated.
When doing same-participant mapping only (without cosimulation), this function should be called whenever input data needs to be brought up-to-date.
**Return type**: void
### Function updateOutputs
```cpp
void sysc::SystemCoupling::updateOutputs(ConvergenceStatus status)
```
Provide a function to update the participants output variables.
This function must be called from inside the coupled analysis loop. It tells System Coupling that the participant has finished performing its solver iterations.
**Parameters**:
- **status**: Status of participant solver after its solver iteration(s). See ConvergenceStatus for details
**Parameters**:
- [ConvergenceStatus](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga0b8801743579159eb41cf07d8372a734) **status**
**Return type**: void
### Function disconnect
```cpp
void sysc::SystemCoupling::disconnect()
```
Provide a function to end the analysis and disconnect from System Coupling.
**Return type**: void
### Function fatalError
```cpp
void sysc::SystemCoupling::fatalError(const std::string &errorMessage)
```
Provide a function to notify System Coupling about a fatal error.
**Parameters**:
- const std::string & **errorMessage**
**Return type**: void
### Function addRegion
```cpp
void sysc::SystemCoupling::addRegion(const Region ®ion)
```
Provide a function to add a region that could be used in a coupled analysis.
**Parameters**:
- **region**: - [Region](classsysc_1_1Region.md#classsysc_1_1Region) to be added.
If this region has already been added, then this call will have no effect.
If a different region with the same has already been added, then a runtime error will be thrown.
If the region name contains invalid characters, then a runtime error will be thrown.
**Parameters**:
- const [Region](classsysc_1_1Region.md#classsysc_1_1Region) & **region**
**Return type**: void
### Function addInputParameter
```cpp
void sysc::SystemCoupling::addInputParameter(Parameter parameter)
```
Provide a method to add an input parameter that could be used in a coupled analysis.
If this parameter has already been added as an input solver parameter, then this call will have no effect.
If a different parameter with the same name has already been added as an input parameter, then a runtime error will be thrown.
If a parameter with the same name has already been added as an output parameter, then a runtime error will be thrown.
If the parameter name contains invalid characters, a runtime error will be thrown.
**Parameters**:
- **parameter**: [Parameter](classsysc_1_1Parameter.md#classsysc_1_1Parameter) whose values are provided by System Coupling and consumed by the participant.
**Parameters**:
- [Parameter](classsysc_1_1Parameter.md#classsysc_1_1Parameter) **parameter**
**Return type**: void
### Function addOutputParameter
```cpp
void sysc::SystemCoupling::addOutputParameter(Parameter parameter)
```
Provide a method to add an output parameter that could be used in a coupled analysis.
If this parameter has already been added as an output solver parameter, then this call will have no effect.
If a different parameter with the same name has already been added as an output parameter, then a runtime error will be thrown.
If a parameter with the same name has already been added as an input parameter, then a runtime error will be thrown.
If the parameter name contains invalid characters, a runtime error will be thrown.
**Parameters**:
- **parameter**: [Parameter](classsysc_1_1Parameter.md#classsysc_1_1Parameter) whose values are provided by System Coupling and consumed by the participant.
**Parameters**:
- [Parameter](classsysc_1_1Parameter.md#classsysc_1_1Parameter) **parameter**
**Return type**: void
### Function addRealAttribute
```cpp
void sysc::SystemCoupling::addRealAttribute(const RealAttribute &realAttribute)
```
Provide a method to add a real attribute that could be used in a coupled analysis.
If this attribute has already been added as a real attribute, then this call will have no effect.
If a different real attribute with the same name has already been added as a real attribute, then a runtime error will be thrown.
If the real attribute name contains invalid characters, a runtime error will be thrown.
**Parameters**:
- **realAttribute**: real attribute whose values are provided by System Coupling and consumed by the participant.
**Parameters**:
- const [RealAttribute](classsysc_1_1RealAttribute.md#classsysc_1_1RealAttribute) & **realAttribute**
**Return type**: void
### Function addIntegerAttribute
```cpp
void sysc::SystemCoupling::addIntegerAttribute(const IntegerAttribute &integerAttribute)
```
Provide a method to add an integer attribute that could be used in a coupled analysis.
If this attribute has already been added as an integer attribute, then this call will have no effect.
If a different integer attribute with the same name has already been added as an integer attribute, then a runtime error will be thrown.
If the integer attribute name contains invalid characters, a runtime error will be thrown.
**Parameters**:
- **integerAttribute**: integer attribute whose values are provided by System Coupling and consumed by the participant.
**Parameters**:
- const [IntegerAttribute](classsysc_1_1IntegerAttribute.md#classsysc_1_1IntegerAttribute) & **integerAttribute**
**Return type**: void
### Function addStringAttribute
```cpp
void sysc::SystemCoupling::addStringAttribute(const StringAttribute &stringAttribute)
```
Provide a method to add a string attribute that could be used in a coupled analysis.
If this attribute has already been added as an string attribute, then this call will have no effect.
If a different string attribute with the same name has already been added as an string attribute, then a runtime error will be thrown.
If the string attribute name contains invalid characters, a runtime error will be thrown.
**Parameters**:
- **stringAttribute**: string attribute whose values are provided by System Coupling and consumed by the participant.
**Parameters**:
- const [StringAttribute](classsysc_1_1StringAttribute.md#classsysc_1_1StringAttribute) & **stringAttribute**
**Return type**: void
### Function addCouplingInterface
```cpp
void sysc::SystemCoupling::addCouplingInterface(const CouplingInterface &couplingInterface)
```
Provide a function to add a coupling interface.
**Parameters**:
- **couplingInterface**: - coupling interface to be added.
Data transfers will be automatically created. If a variable is defined as an output on all regions on one side of the interface and as an input on all regions on the opposite side of the interface, then the data transfer will be added for this variable.
If this coupling interface has already been added, then this call will have no effect.
If a different coupling interface with the same has already been added, then a runtime error will be thrown.
If the coupling interface name contains invalid characters, then a runtime error will be thrown.
See [sysc::CouplingInterface](classsysc_1_1CouplingInterface.md#classsysc_1_1CouplingInterface) for more details.
**Parameters**:
- const [CouplingInterface](classsysc_1_1CouplingInterface.md#classsysc_1_1CouplingInterface) & **couplingInterface**
**Return type**: void
### Function addCouplingInterface
```cpp
void sysc::SystemCoupling::addCouplingInterface(const CouplingInterface &couplingInterface, bool autoGenerateTransfers)
```
Provide a function to add a coupling interface.
**Parameters**:
- **couplingInterface**: - coupling interface to be added.
- **autoGenerateTransfers**: - flag whether to automatically create data transfers.
If this coupling interface has already been added, then this call will have no effect.
If a different coupling interface with the same has already been added, then a runtime error will be thrown.
If the coupling interface name contains invalid characters, then a runtime error will be thrown.
If autoGenerateTransfers is true, then the data transfers are generated automatically according to the following rule: if a variable is defined as an output on all regions on one side of the interface and as an input on all regions on the opposite side of the interface, then the data transfer will be added for this variable.
See [sysc::CouplingInterface](classsysc_1_1CouplingInterface.md#classsysc_1_1CouplingInterface) for more details.
**Parameters**:
- const [CouplingInterface](classsysc_1_1CouplingInterface.md#classsysc_1_1CouplingInterface) & **couplingInterface**
- bool **autoGenerateTransfers**
**Return type**: void
### Function getParameterValue
```cpp
double sysc::SystemCoupling::getParameterValue(const ParameterName ¶meterName)
```
Provide a function to get a [Parameter](classsysc_1_1Parameter.md#classsysc_1_1Parameter) value.
**Parameters**:
- **parameterName**: - name of the parameter.
**Parameters**:
- const [ParameterName](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga9cadba4f4e91a46ad88e42877c682d46) & **parameterName**
**Return type**: double
### Function setParameterValue
```cpp
void sysc::SystemCoupling::setParameterValue(const ParameterName ¶meterName, double value)
```
Provide a function to set a [Parameter](classsysc_1_1Parameter.md#classsysc_1_1Parameter) value.
**Parameters**:
- **parameterName**: - name of the parameter.
- **value**: - value of the parameter.
**Parameters**:
- const [ParameterName](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga9cadba4f4e91a46ad88e42877c682d46) & **parameterName**
- double **value**
**Return type**: void
### Function getRealAttributeValue
```cpp
double sysc::SystemCoupling::getRealAttributeValue(const AttributeName &attributeName)
```
Provide a function to get a [RealAttribute](classsysc_1_1RealAttribute.md#classsysc_1_1RealAttribute) value.
**Parameters**:
- **attributeName**: - name of the real attribute.
**Parameters**:
- const [AttributeName](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gadb06eacf4ed0787d18e8ddbf0612c83c) & **attributeName**
**Return type**: double
### Function getIntegerAttributeValue
```cpp
int64_t sysc::SystemCoupling::getIntegerAttributeValue(const AttributeName &attributeName)
```
Provide a function to get an [IntegerAttribute](classsysc_1_1IntegerAttribute.md#classsysc_1_1IntegerAttribute) value.
**Parameters**:
- **attributeName**: - name of the integer attribute.
**Parameters**:
- const [AttributeName](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gadb06eacf4ed0787d18e8ddbf0612c83c) & **attributeName**
**Return type**: int64\_t
### Function getStringAttributeValue
```cpp
std::string sysc::SystemCoupling::getStringAttributeValue(const AttributeName &attributeName)
```
Provide a function to get a [StringAttribute](classsysc_1_1StringAttribute.md#classsysc_1_1StringAttribute) value.
**Parameters**:
- **attributeName**: - name of the string attribute.
**Parameters**:
- const [AttributeName](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gadb06eacf4ed0787d18e8ddbf0612c83c) & **attributeName**
**Return type**: std::string
### Function registerInputScalarDataAccess
```cpp
void sysc::SystemCoupling::registerInputScalarDataAccess(InputScalarDataAccess *dataAccess)
```
Provide a function to register input scalar data access.
**Parameters**:
- **dataAccess**: - a pointer to the function that conforms to sysc::InputScalarDataAccess prototype.
**Parameters**:
- [InputScalarDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga7dd9c918ef6adb34c5e7832dfb077cf2) \* **dataAccess**
**Return type**: void
### Function registerInputScalarDataAccess
```cpp
void sysc::SystemCoupling::registerInputScalarDataAccess(OpaqueDataAccess opaqueDataAccess, InputScalarDataAccessWithPointer *dataAccess)
```
Provide a function to register input scalar data access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **dataAccess**: - a pointer to the function that conforms to sysc::InputScalarDataAccessWithPointer prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [InputScalarDataAccessWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga31d70598dce8c2bef6ec3f0c167ab271) \* **dataAccess**
**Return type**: void
### Function registerInputVectorDataAccess
```cpp
void sysc::SystemCoupling::registerInputVectorDataAccess(InputVectorDataAccess *dataAccess)
```
Provide a function to register input vector data access.
**Parameters**:
- **dataAccess**: - a pointer to the function that conforms to sysc::InputVectorDataAccess function prototype.
**Parameters**:
- [InputVectorDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gab7625786f580e802bcae651a9e6b8ab6) \* **dataAccess**
**Return type**: void
### Function registerInputVectorDataAccess
```cpp
void sysc::SystemCoupling::registerInputVectorDataAccess(OpaqueDataAccess opaqueDataAccess, InputVectorDataAccessWithPointer *dataAccess)
```
Provide a function to register input vector data access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **dataAccess**: - a pointer to the function that conforms to sysc::InputVectorDataAccessWithPointer prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [InputVectorDataAccessWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga12662b1595f7ffd8429f9e6d6cdcf4e5) \* **dataAccess**
**Return type**: void
### Function registerOutputScalarDataAccess
```cpp
void sysc::SystemCoupling::registerOutputScalarDataAccess(OutputScalarDataAccess *dataAccess)
```
Provide a function to register output scalar data access.
**Parameters**:
- **dataAccess**: - a pointer to the function that conforms to sysc::OutputScalarDataAccess function prototype.
**Parameters**:
- [OutputScalarDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gaf919dd1650fbc5b6cede63027640a40f) \* **dataAccess**
**Return type**: void
### Function registerOutputScalarDataAccess
```cpp
void sysc::SystemCoupling::registerOutputScalarDataAccess(OpaqueDataAccess opaqueDataAccess, OutputScalarDataAccessWithPointer *dataAccess)
```
Provide a function to register output scalar data access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **dataAccess**: - a pointer to the function that conforms to sysc::OutputScalarDataAccessWithPointer prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [OutputScalarDataAccessWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga0198dfa2f53816088cfc3c0f94b33fb5) \* **dataAccess**
**Return type**: void
### Function registerOutputVectorDataAccess
```cpp
void sysc::SystemCoupling::registerOutputVectorDataAccess(OutputVectorDataAccess *dataAccess)
```
Provide a function to register output vector data access.
**Parameters**:
- **dataAccess**: - a pointer to the function that conforms to sysc::OutputVectorDataAccess function prototype.
**Parameters**:
- [OutputVectorDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga3af176d8520259b81f0460e1299e04b6) \* **dataAccess**
**Return type**: void
### Function registerOutputVectorDataAccess
```cpp
void sysc::SystemCoupling::registerOutputVectorDataAccess(OpaqueDataAccess opaqueDataAccess, OutputVectorDataAccessWithPointer *dataAccess)
```
Provide a function to register output vector data access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **dataAccess**: - a pointer to the function that conforms to sysc::OutputVectorDataAccessWithPointer prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [OutputVectorDataAccessWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga816b3979bcee14cdb92a88c0621a8e1e) \* **dataAccess**
**Return type**: void
### Function registerInputComplexScalarDataAccess
```cpp
void sysc::SystemCoupling::registerInputComplexScalarDataAccess(InputComplexScalarDataAccess *dataAccess)
```
Provide a function to register input complex scalar data access.
**Parameters**:
- **dataAccess**: - a pointer to the function that conforms to sysc::InputComplexScalarDataAccess prototype.
**Parameters**:
- [InputComplexScalarDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gac45104dcb153caae0c4edac26e46351e) \* **dataAccess**
**Return type**: void
### Function registerInputComplexScalarDataAccess
```cpp
void sysc::SystemCoupling::registerInputComplexScalarDataAccess(OpaqueDataAccess opaqueDataAccess, InputComplexScalarDataAccessWithPointer *dataAccess)
```
Provide a function to register input complex scalar data access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **dataAccess**: - a pointer to the function that conforms to sysc::InputComplexScalarDataAccess prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [InputComplexScalarDataAccessWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga90ec216c6ff3f8ada5d0b0b4ea362b15) \* **dataAccess**
**Return type**: void
### Function registerInputComplexVectorDataAccess
```cpp
void sysc::SystemCoupling::registerInputComplexVectorDataAccess(InputComplexVectorDataAccess *dataAccess)
```
Provide a function to register input complex vector data access.
**Parameters**:
- **dataAccess**: - a pointer to the function that conforms to InputComplexVectorDataAccess prototype.
**Parameters**:
- [InputComplexVectorDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga0cc318418bce4c3aa356f91798e962e7) \* **dataAccess**
**Return type**: void
### Function registerInputComplexVectorDataAccess
```cpp
void sysc::SystemCoupling::registerInputComplexVectorDataAccess(OpaqueDataAccess opaqueDataAccess, InputComplexVectorDataAccessWithPointer *dataAccess)
```
Provide a function to register input complex vector data access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **dataAccess**: - a pointer to the function that conforms to InputComplexVectorDataAccess prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [InputComplexVectorDataAccessWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gaf213c1ae6a1bff131c598f99ad9320b4) \* **dataAccess**
**Return type**: void
### Function registerOutputComplexScalarDataAccess
```cpp
void sysc::SystemCoupling::registerOutputComplexScalarDataAccess(OutputComplexScalarDataAccess *dataAccess)
```
Provide a function to register output complex scalar data access.
**Parameters**:
- **dataAccess**: - a pointer to the function that conforms to OutputComplexScalarDataAccess prototype.
**Parameters**:
- [OutputComplexScalarDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gaeb662bc24c2d2c6f4248f038eee43e74) \* **dataAccess**
**Return type**: void
### Function registerOutputComplexScalarDataAccess
```cpp
void sysc::SystemCoupling::registerOutputComplexScalarDataAccess(OpaqueDataAccess opaqueDataAccess, OutputComplexScalarDataAccessWithPointer *dataAccess)
```
Provide a function to register output complex scalar data access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **dataAccess**: - a pointer to the function that conforms to OutputComplexScalarDataAccess prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [OutputComplexScalarDataAccessWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga74e6e9bec4808c21fab845daa661b50c) \* **dataAccess**
**Return type**: void
### Function registerOutputComplexVectorDataAccess
```cpp
void sysc::SystemCoupling::registerOutputComplexVectorDataAccess(OutputComplexVectorDataAccess *dataAccess)
```
Provide a function to register output complex vector data access.
**Parameters**:
- **dataAccess**: - a pointer to the function that conforms to OutputComplexVectorDataAccess prototype.
**Parameters**:
- [OutputComplexVectorDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gaec1b87f8104f48c01859a46d280894db) \* **dataAccess**
**Return type**: void
### Function registerOutputComplexVectorDataAccess
```cpp
void sysc::SystemCoupling::registerOutputComplexVectorDataAccess(OpaqueDataAccess opaqueDataAccess, OutputComplexVectorDataAccessWithPointer *dataAccess)
```
Provide a function to register output complex vector data access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **dataAccess**: - a pointer to the function that conforms to OutputComplexVectorDataAccess prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [OutputComplexVectorDataAccessWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gaa3871403c3c169499a051ce8cc88d9a7) \* **dataAccess**
**Return type**: void
### Function registerSurfaceMeshAccess
```cpp
void sysc::SystemCoupling::registerSurfaceMeshAccess(SurfaceMeshAccess *meshAccess)
```
Provide a function to register surface mesh access.
**Parameters**:
- **meshAccess**: - a pointer to the function that conforms to SurfaceMeshAccess function prototype. See SurfaceMeshAccess for details.
**Parameters**:
- [SurfaceMeshAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga31a21ade99a36c30fdc24d33c6d5c9aa) \* **meshAccess**
**Return type**: void
### Function registerSurfaceMeshAccess
```cpp
void sysc::SystemCoupling::registerSurfaceMeshAccess(OpaqueDataAccess opaqueDataAccess, SurfaceMeshAccessWithPointer *meshAccess)
```
Provide a function to register surface mesh access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **meshAccess**: - a pointer to the function that conforms to SurfaceMeshAccessWithPointer function prototype. See SurfaceMeshAccessWithPointer for details.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [SurfaceMeshAccessWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gaefc47d665f38f4380346fb9c29b9c8ff) \* **meshAccess**
**Return type**: void
### Function registerZoneCountAccess
```cpp
void sysc::SystemCoupling::registerZoneCountAccess(OpaqueDataAccess opaqueDataAccess, ZoneCountAccess *zoneCountAccess)
```
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [ZoneCountAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga67496d998ace1dd2796a5a96f6356483) \* **zoneCountAccess**
**Return type**: void
### Function registerSurfaceMeshAccess
```cpp
void sysc::SystemCoupling::registerSurfaceMeshAccess(OpaqueDataAccess opaqueDataAccess, SurfaceMeshMultiZoneAccess *dataAccess)
```
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [SurfaceMeshMultiZoneAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga78db51b86b998102a74753c41118d0de) \* **dataAccess**
**Return type**: void
### Function registerVolumeMeshAccess
```cpp
void sysc::SystemCoupling::registerVolumeMeshAccess(OpaqueDataAccess opaqueDataAccess, VolumeMeshMultiZoneAccess *dataAccess)
```
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [VolumeMeshMultiZoneAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gaf8cf8d3d04cd46c0841bd0d1fdb54158) \* **dataAccess**
**Return type**: void
### Function registerInputScalarDataAccess
```cpp
void sysc::SystemCoupling::registerInputScalarDataAccess(OpaqueDataAccess opaqueDataAccess, InputScalarDataMultiZoneAccess *dataAccess)
```
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [InputScalarDataMultiZoneAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga3b4a0b9036a3be955d417a16c6acb695) \* **dataAccess**
**Return type**: void
### Function registerOutputScalarDataAccess
```cpp
void sysc::SystemCoupling::registerOutputScalarDataAccess(OpaqueDataAccess opaqueDataAccess, OutputScalarDataMultiZoneAccess *dataAccess)
```
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [OutputScalarDataMultiZoneAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gaad003be96e3cd29fc18e0d2a27889db4) \* **dataAccess**
**Return type**: void
### Function registerInputVectorDataAccess
```cpp
void sysc::SystemCoupling::registerInputVectorDataAccess(OpaqueDataAccess opaqueDataAccess, InputVectorDataMultiZoneAccess *dataAccess)
```
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [InputVectorDataMultiZoneAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga59cfd8bf053c1492e4c0a6b4c0109ef6) \* **dataAccess**
**Return type**: void
### Function registerOutputVectorDataAccess
```cpp
void sysc::SystemCoupling::registerOutputVectorDataAccess(OpaqueDataAccess opaqueDataAccess, OutputVectorDataMultiZoneAccess *dataAccess)
```
Provide a function to register output vector data access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **dataAccess**: - a pointer to the function that conforms to sysc::OutputVectorDataMultiZoneAccess prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [OutputVectorDataMultiZoneAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga46429473df8e53efff6e5d967897a291) \* **dataAccess**
**Return type**: void
### Function registerVolumeMeshAccess
```cpp
void sysc::SystemCoupling::registerVolumeMeshAccess(VolumeMeshAccess *meshAccess)
```
Provide a function to register volume mesh access.
**Parameters**:
- **meshAccess**: - a pointer to the function that conforms to VolumeMeshAccess function prototype. See VolumeMeshAccess for details.
**Parameters**:
- [VolumeMeshAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga7a37f14608ada16bb16d44c498325fff) \* **meshAccess**
**Return type**: void
### Function registerVolumeMeshAccess
```cpp
void sysc::SystemCoupling::registerVolumeMeshAccess(OpaqueDataAccess opaqueDataAccess, VolumeMeshAccessWithPointer *meshAccess)
```
Provide a function to register volume mesh access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **meshAccess**: - a pointer to the function that conforms to VolumeMeshAccessWithPointer function prototype. See VolumeMeshAccessWithPointer for details.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [VolumeMeshAccessWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga6c3e4e3f977efd6284430b6f8e918ce1) \* **meshAccess**
**Return type**: void
### Function registerPointCloudAccess
```cpp
void sysc::SystemCoupling::registerPointCloudAccess(PointCloudAccess *pointCloudAccess)
```
Provide a function to register point cloud access.
**Parameters**:
- **pointCloudAccess**: - a pointer to the function that conforms to PointCloudAccess function prototype. See PointCloudAccess for details.
**Parameters**:
- [PointCloudAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga1651bb5df846358dfae0401b4a51331d) \* **pointCloudAccess**
**Return type**: void
### Function registerPointCloudAccess
```cpp
void sysc::SystemCoupling::registerPointCloudAccess(OpaqueDataAccess opaqueDataAccess, PointCloudAccessWithPointer *pointCloudAccess)
```
Provide a function to register point cloud access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **pointCloudAccess**: - a pointer to the function that conforms to PointCloudAccessWithPointer function prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [PointCloudAccessWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga1ec70c59d86f6f43cc865c72e4a9d76e) \* **pointCloudAccess**
**Return type**: void
### Function registerPointCloudAccess
```cpp
void sysc::SystemCoupling::registerPointCloudAccess(OpaqueDataAccess opaqueDataAccess, PointCloudMultiZoneAccess *pointCloudAccess)
```
Provide a function to register point cloud access.
**Parameters**:
- **opaqueDataAccess**: - a pointer that is passed into the callback function.
- **pointCloudAccess**: - a pointer to the function that conforms to PointCloudMultiZoneAccess function prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [PointCloudMultiZoneAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga2108977976cabe1b6207eb8bc58175f4) \* **pointCloudAccess**
**Return type**: void
### Function registerRestartPointCreation
```cpp
void sysc::SystemCoupling::registerRestartPointCreation(RestartPointCreation *restartPointCreation)
```
Provide a function to register a restart point creation callback.
**Parameters**:
- **restartPointCreation**: - a pointer to the function that conforms to RestartPointCreation function prototype. See RestartPointCreation for details.
**Parameters**:
- [RestartPointCreation](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga871467e0179633e71b13d4a1904ad732) \* **restartPointCreation**
**Return type**: void
### Function registerTargetDataCreation
```cpp
void sysc::SystemCoupling::registerTargetDataCreation(TargetDataCreation *targetDataCreation)
```
Provide a function to register a target data creation callback.
**Parameters**:
- **targetDataCreation**: - a pointer to the function that conforms to TargetDataCreation function prototype. See TargetDataCreation for details.
**Parameters**:
- [TargetDataCreation](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23c842f309f11150deb4dda666115091) \* **targetDataCreation**
**Return type**: void
### Function registerTargetDataCreation
```cpp
void sysc::SystemCoupling::registerTargetDataCreation(OpaqueDataAccess opaqueDataAccess, TargetDataCreationWithPointer *targetDataCreation)
```
Provide a function to register a target data creation callback.
**Parameters**:
- **opaqueDataAccess**: a pointer that is passed into the callback function.
- **targetDataCreation**: a pointer to the function that conforms to TargetDataCreationWithPointer function prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [TargetDataCreationWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga62d0a9b9a904f4345ff12f30b052e278) \* **targetDataCreation**
**Return type**: void
### Function registerDoesTargetDataExist
```cpp
void sysc::SystemCoupling::registerDoesTargetDataExist(TargetDataExistenceChecker *doesTargetDataExist)
```
Provide a function to register a does target data exist callback.
**Parameters**:
- **doesTargetDataExist**: a pointer to the function that conforms to DoesTargetDataExist function prototype. See DoesTargetDataExist for details.
**Parameters**:
- [TargetDataExistenceChecker](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga5a236a23cab8fd793659e3ff0ded7aff) \* **doesTargetDataExist**
**Return type**: void
### Function registerDoesTargetDataExist
```cpp
void sysc::SystemCoupling::registerDoesTargetDataExist(OpaqueDataAccess opaqueDataAccess, TargetDataExistenceCheckerWithPointer *doesTargetDataExist)
```
Provide a function to register a does target data exist callback.
**Parameters**:
- **opaqueDataAccess**: a pointer that is passed into the callback function.
- **doesTargetDataExist**: a pointer to the function that conforms to DoesTargetDataExistWithPointer function prototype.
**Parameters**:
- [OpaqueDataAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga23b9971b358756814178dd1cb3c0bc80) **opaqueDataAccess**
- [TargetDataExistenceCheckerWithPointer](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gaf91c64729b5c36e4ed316a3f0fe533ff) \* **doesTargetDataExist**
**Return type**: void
### Function writeSetupFile
```cpp
bool sysc::SystemCoupling::writeSetupFile(const SetupFileInfo &setupFileInfo) const
```
Provide a function to write the setup file.
This function can be used to generate a System Coupling setup file, which contains participant's setup information. It should be called after calling completeSetup.
**Parameters**:
- **setupFileInfo**: - struct containing the setup file info.
**Returns**:
True if the setup file was successfully written, and false otherwise.
**Parameters**:
- const [SetupFileInfo](structsysc_1_1SetupFileInfo.md#structsysc_1_1SetupFileInfo) & **setupFileInfo**
**Return type**: bool
### Function writeResults
```cpp
void sysc::SystemCoupling::writeResults(const ResultsInfo &resultsInfo) const
```
Write results to a file.
**Parameters**:
- const [ResultsInfo](structsysc_1_1ResultsInfo.md#structsysc_1_1ResultsInfo) & **resultsInfo**
**Return type**: void
### Function getNumRegions
```cpp
std::size_t sysc::SystemCoupling::getNumRegions() const
```
Provide a function to return the number of regions.
**Returns**:
Number of regions.
**Return type**: std::size\_t
### Function getAddedRegion
```cpp
const Region& sysc::SystemCoupling::getAddedRegion(std::size_t index) const
```
Provide a function to return region information.
**Parameters**:
- **index**: - region index
**Returns**:
Reference to region information at specified index.
**Parameters**:
- std::size\_t **index**
**Return type**: const [Region](classsysc_1_1Region.md#classsysc_1_1Region) &
### Function getSolutionControl
```cpp
SolutionControl sysc::SystemCoupling::getSolutionControl() const
```
Get solution control.
**Return type**: [SolutionControl](structsysc_1_1SolutionControl.md#structsysc_1_1SolutionControl)
### Function getSetupInfo
```cpp
const SetupInfo& sysc::SystemCoupling::getSetupInfo() const
```
Get [SetupInfo](structsysc_1_1SetupInfo.md#structsysc_1_1SetupInfo).
**Return type**: const [SetupInfo](structsysc_1_1SetupInfo.md#structsysc_1_1SetupInfo) &
### Function getNumCouplingInterfaces
```cpp
std::size_t sysc::SystemCoupling::getNumCouplingInterfaces() const
```
Provide a function to return the number of coupling interfaces.
**Returns**:
Number of coupling interfaces.
**Return type**: std::size\_t
### Function getAddedCouplingInterface
```cpp
const CouplingInterface& sysc::SystemCoupling::getAddedCouplingInterface(std::size_t index) const
```
Provide a function to return coupling interface.
**Parameters**:
- **index**: - coupling interface index
**Returns**:
Reference to the coupling interface at specified index.
**Parameters**:
- std::size\_t **index**
**Return type**: const [CouplingInterface](classsysc_1_1CouplingInterface.md#classsysc_1_1CouplingInterface) &
### Function getInputParameter
```cpp
const Parameter& sysc::SystemCoupling::getInputParameter(std::size_t index) const
```
Provide a function to return input parameter information.
**Parameters**:
- **index**: - input parameter index
**Returns**:
Reference to input parameter information at specified index.
**Parameters**:
- std::size\_t **index**
**Return type**: const [Parameter](classsysc_1_1Parameter.md#classsysc_1_1Parameter) &
### Function getOutputParameter
```cpp
const Parameter& sysc::SystemCoupling::getOutputParameter(std::size_t index) const
```
Provide a function to return output parameter information.
**Parameters**:
- **index**: - output parameter index
**Returns**:
Reference to output parameter information at specified index.
**Parameters**:
- std::size\_t **index**
**Return type**: const [Parameter](classsysc_1_1Parameter.md#classsysc_1_1Parameter) &
### Function getNumInputParameters
```cpp
std::size_t sysc::SystemCoupling::getNumInputParameters() const
```
Provide a function to return the number of input parameters.
**Returns**:
Number of input parameters.
**Return type**: std::size\_t
### Function getNumOutputParameters
```cpp
std::size_t sysc::SystemCoupling::getNumOutputParameters() const
```
Provide a function to return the number of output parameters.
**Returns**:
Number of output parameters.
**Return type**: std::size\_t
### Function getNumRealAttributes
```cpp
std::size_t sysc::SystemCoupling::getNumRealAttributes() const
```
Provide a function to return the number of real attributes.
**Returns**:
Number of real attributes.
**Return type**: std::size\_t
### Function getNumIntegerAttributes
```cpp
std::size_t sysc::SystemCoupling::getNumIntegerAttributes() const
```
Provide a function to return the number of integer attributes.
**Returns**:
Number of integer attributes.
**Return type**: std::size\_t
### Function getNumStringAttributes
```cpp
std::size_t sysc::SystemCoupling::getNumStringAttributes() const
```
Provide a function to return the number of string attributes.
**Returns**:
Number of string attributes.
**Return type**: std::size\_t
### Function getRealAttribute
```cpp
const RealAttribute& sysc::SystemCoupling::getRealAttribute(std::size_t index) const
```
Provide a function to return real attribute information.
**Parameters**:
- **index**: - real attribute index
**Returns**:
Reference to real attribute information at specified index.
**Parameters**:
- std::size\_t **index**
**Return type**: const [RealAttribute](classsysc_1_1RealAttribute.md#classsysc_1_1RealAttribute) &
### Function getIntegerAttribute
```cpp
const IntegerAttribute& sysc::SystemCoupling::getIntegerAttribute(std::size_t index) const
```
Provide a function to return integer attribute information.
**Parameters**:
- **index**: - integer attribute index
**Returns**:
Reference to integer attribute information at specified index.
**Parameters**:
- std::size\_t **index**
**Return type**: const [IntegerAttribute](classsysc_1_1IntegerAttribute.md#classsysc_1_1IntegerAttribute) &
### Function getStringAttribute
```cpp
const StringAttribute& sysc::SystemCoupling::getStringAttribute(std::size_t index) const
```
Provide a function to return string attribute information.
**Parameters**:
- **index**: - string attribute index
**Returns**:
Reference to string attribute information at specified index.
**Parameters**:
- std::size\_t **index**
**Return type**: const [StringAttribute](classsysc_1_1StringAttribute.md#classsysc_1_1StringAttribute) &
### Function completeCouplingSetup
```cpp
void sysc::SystemCoupling::completeCouplingSetup()
```
This function will be deprecated. Use [completeSetup()](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a204a3a8145961af7bc28d2cfd58a4358) instead.
**Return type**: void
### Function completeCouplingSetup
```cpp
void sysc::SystemCoupling::completeCouplingSetup(sysc::AnalysisType analysisType)
```
This function will be deprecated. Use [completeSetup()](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1a204a3a8145961af7bc28d2cfd58a4358) instead.
**Parameters**:
- [sysc::AnalysisType](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gaffd523474fbd708f481a712f1841a967) **analysisType**
**Return type**: void
### Function registerInputScalarVariableAccess
```cpp
void sysc::SystemCoupling::registerInputScalarVariableAccess(InputScalarVariableAccess *dataAccess)
```
Deprecated - do not use.
**Parameters**:
- [InputScalarVariableAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1gabfe4908649fe177d889ed488b090fdea) \* **dataAccess**
**Return type**: void
### Function registerInputVectorVariableAccess
```cpp
void sysc::SystemCoupling::registerInputVectorVariableAccess(InputVectorVariableAccess *dataAccess)
```
Deprecated - do not use.
**Parameters**:
- [InputVectorVariableAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga9b14545ae1ed82c6d1471c1672ca5247) \* **dataAccess**
**Return type**: void
### Function registerOutputScalarVariableAccess
```cpp
void sysc::SystemCoupling::registerOutputScalarVariableAccess(OutputScalarVariableAccess *dataAccess)
```
Deprecated - do not use.
**Parameters**:
- [OutputScalarVariableAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga81e8c19ed24a2ea0433af309188710a6) \* **dataAccess**
**Return type**: void
### Function registerOutputVectorVariableAccess
```cpp
void sysc::SystemCoupling::registerOutputVectorVariableAccess(OutputVectorVariableAccess *dataAccess)
```
Deprecated - do not use.
**Parameters**:
- [OutputVectorVariableAccess](namespacesysc.md#group__SystemCouplingParticipantAPIs_1ga4684b116da21b415e4e63ae927ba12ae) \* **dataAccess**
**Return type**: void
### Function checkMeshValidity
```cpp
MeshValidityStatus sysc::SystemCoupling::checkMeshValidity(const Region ®ion)
```
Deprecated. Use [sysc::SurfaceMesh::checkValidity](classsysc_1_1SurfaceMesh.md#classsysc_1_1SurfaceMesh_1afe6bfa2f60fa4b106a1809428e9cec29) instead.
**Parameters**:
- const [Region](classsysc_1_1Region.md#classsysc_1_1Region) & **region**
**Return type**: [MeshValidityStatus](structsysc_1_1MeshValidityStatus.md#structsysc_1_1MeshValidityStatus)
### Function checkMeshValidity
```cpp
MeshValidityStatus sysc::SystemCoupling::checkMeshValidity(const std::string ®ionName)
```
Deprecated. Use [sysc::SurfaceMesh::checkValidity](classsysc_1_1SurfaceMesh.md#classsysc_1_1SurfaceMesh_1afe6bfa2f60fa4b106a1809428e9cec29) instead.
**Parameters**:
- const std::string & **regionName**
**Return type**: [MeshValidityStatus](structsysc_1_1MeshValidityStatus.md#structsysc_1_1MeshValidityStatus)
### Function getRegion
```cpp
const Region& sysc::SystemCoupling::getRegion(std::size_t index) const
```
Deprecated. Use [getAddedRegion()](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling_1adb354cb78a277f08c87b59f97bcdd453) instead.
**Parameters**:
- std::size\_t **index**
**Return type**: const [Region](classsysc_1_1Region.md#classsysc_1_1Region) &
### Function SystemCoupling
```cpp
sysc::SystemCoupling::SystemCoupling(const SystemCoupling &)=delete
```
Delete the copy-constructor.
**Parameters**:
- const [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) &
**Return type**:
### Function SystemCoupling
```cpp
sysc::SystemCoupling::SystemCoupling(SystemCoupling &&)=default
```
Provide the move-constructor.
**Parameters**:
- [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) &&
**Return type**:
### Function operator=
```cpp
SystemCoupling& sysc::SystemCoupling::operator=(const SystemCoupling &)=delete
```
Delete the copy-assign operator.
**Parameters**:
- const [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) &
**Return type**: [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) &
### Function operator=
```cpp
SystemCoupling& sysc::SystemCoupling::operator=(SystemCoupling &&)=default
```
Provide the move-assign operator.
**Parameters**:
- [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) &&
**Return type**: [SystemCoupling](classsysc_1_1SystemCoupling.md#classsysc_1_1SystemCoupling) &