## On this page

  

 

 # syscSystemCoupling

 Last update: 17.07.2025 

<a id="l00001" name="l00001"></a> 1/\*

<a id="l00002" name="l00002"></a> 2\* Copyright 2023 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

<a id="l00003" name="l00003"></a> 3\*/

<a id="l00004" name="l00004"></a> 4 

<a id="l00005" name="l00005"></a> 5\#pragma once

<a id="l00006" name="l00006"></a> 6 

<a id="l00007" name="l00007"></a> 7\#include "SystemCouplingParticipant/LibraryType.hpp"

<a id="l00008" name="l00008"></a> 8 

<a id="l00009" name="l00009"></a> 9\#include "SystemCouplingParticipant/syscCommonTypes.h"

<a id="l00010" name="l00010"></a> 10\#include "SystemCouplingParticipant/syscCouplingInterface.h"

<a id="l00011" name="l00011"></a> 11\#include "SystemCouplingParticipant/syscFunctionTypes.h"

<a id="l00012" name="l00012"></a> 12\#include "SystemCouplingParticipant/syscLegacyInterfaces.h"

<a id="l00013" name="l00013"></a> 13\#include "SystemCouplingParticipant/syscPointCloud.h"

<a id="l00014" name="l00014"></a> 14\#include "SystemCouplingParticipant/syscRegion.h"

<a id="l00015" name="l00015"></a> 15\#include "SystemCouplingParticipant/syscVariable.h"

<a id="l00016" name="l00016"></a> 16\#include "SystemCouplingParticipant/syscVolumeMesh.h"

<a id="l00017" name="l00017"></a> 17\#include "SystemCouplingParticipant/syscSurfaceMesh.h"

<a id="l00018" name="l00018"></a> 18 

<a id="l00019" name="l00019"></a> 19\#include &lt;stddef.h&gt;

<a id="l00020" name="l00020"></a> 20 

<a id="l00021" name="l00021"></a> 21\#ifdef \_\_cplusplus

<a id="l00022" name="l00022"></a> 22extern "C" {

<a id="l00023" name="l00023"></a> 23\#endif

<a id="l00024" name="l00024"></a> 24 

<a id="l00049" name="l00049"></a>[ 49](group__SyscParticipantLibraryCAPI.xhtml#ga862e7375111dcee847bc05463c72b329)[SyscError](structSyscError.xhtml) [syscStartStandaloneParallel](group__SyscParticipantLibraryCAPI.xhtml#ga862e7375111dcee847bc05463c72b329)(const size\_t mpiCommunicator);

<a id="l00050" name="l00050"></a> 50 

<a id="l00072" name="l00072"></a>[ 72](group__SyscParticipantLibraryCAPI.xhtml#ga1404ad75fb1f5b1515dae967b71b1725)[SyscError](structSyscError.xhtml) [syscConnect](group__SyscParticipantLibraryCAPI.xhtml#ga1404ad75fb1f5b1515dae967b71b1725)(

<a id="l00073" name="l00073"></a> 73 const char* scHost,

<a id="l00074" name="l00074"></a> 74 const unsigned short scPort,

<a id="l00075" name="l00075"></a> 75 const char* participantName,

<a id="l00076" name="l00076"></a> 76 const char* buildInformation);

<a id="l00077" name="l00077"></a> 77 

<a id="l00090" name="l00090"></a>[ 90](group__SyscParticipantLibraryCAPI.xhtml#ga68a9b5b64715ad6ffde1c7b145bb4d0f)[SyscError](structSyscError.xhtml) [syscConnectParallel](group__SyscParticipantLibraryCAPI.xhtml#ga68a9b5b64715ad6ffde1c7b145bb4d0f)(

<a id="l00091" name="l00091"></a> 91 const char* scHost,

<a id="l00092" name="l00092"></a> 92 const unsigned short scPort,

<a id="l00093" name="l00093"></a> 93 const char* participantName,

<a id="l00094" name="l00094"></a> 94 const size\_t communicator,

<a id="l00095" name="l00095"></a> 95 const char* buildInformation);

<a id="l00096" name="l00096"></a> 96 

<a id="l00108" name="l00108"></a>[ 108](group__SyscParticipantLibraryCAPI.xhtml#ga8d84278ef4d48a739948f0a952cb2a00)[SyscError](structSyscError.xhtml) [syscConnectUseStruct](group__SyscParticipantLibraryCAPI.xhtml#ga8d84278ef4d48a739948f0a952cb2a00)(

<a id="l00109" name="l00109"></a> 109 [SyscParticipantInfo](structSyscParticipantInfo.xhtml) participantInfo);

<a id="l00110" name="l00110"></a> 110 

<a id="l00125" name="l00125"></a>[ 125](group__SyscParticipantLibraryCAPI.xhtml#gac695e9f06d272958b8fc81bff07708fb)[SyscError](structSyscError.xhtml) [syscConnectParallelUseStruct](group__SyscParticipantLibraryCAPI.xhtml#gac695e9f06d272958b8fc81bff07708fb)(

<a id="l00126" name="l00126"></a> 126 [SyscParticipantInfo](structSyscParticipantInfo.xhtml) participantInfo,

<a id="l00127" name="l00127"></a> 127 const size\_t communicator);

<a id="l00128" name="l00128"></a> 128 

<a id="l00142" name="l00142"></a>[ 142](group__SyscParticipantLibraryCAPI.xhtml#ga3c895512d255076ce0b7dcc0b527991b)[SyscError](structSyscError.xhtml) [syscAddRegion](group__SyscParticipantLibraryCAPI.xhtml#ga3c895512d255076ce0b7dcc0b527991b)(

<a id="l00143" name="l00143"></a> 143 const [SyscRegion](structSyscRegion.xhtml) region);

<a id="l00144" name="l00144"></a> 144 

<a id="l00160" name="l00160"></a>[ 160](group__SyscParticipantLibraryCAPI.xhtml#ga5330416d093678fc96231257a88ea337)[SyscError](structSyscError.xhtml) [syscAddCouplingInterface](group__SyscParticipantLibraryCAPI.xhtml#ga5330416d093678fc96231257a88ea337)(

<a id="l00161" name="l00161"></a> 161 const [SyscCouplingInterface](structSyscCouplingInterface.xhtml) couplingInterface);

<a id="l00162" name="l00162"></a> 162 

<a id="l00178" name="l00178"></a>[ 178](group__SyscParticipantLibraryCAPI.xhtml#gadec9e44f001d4ec2b8139e096ab93ac7)[SyscError](structSyscError.xhtml) [syscAddCouplingInterfaceA](group__SyscParticipantLibraryCAPI.xhtml#gadec9e44f001d4ec2b8139e096ab93ac7)(

<a id="l00179" name="l00179"></a> 179 const [SyscCouplingInterface](structSyscCouplingInterface.xhtml) couplingInterface,

<a id="l00180" name="l00180"></a> 180 int autoGenerateDataTransfers);

<a id="l00181" name="l00181"></a> 181 

<a id="l00195" name="l00195"></a>[ 195](group__SyscParticipantLibraryCAPI.xhtml#ga831884747873b947fcdc57ef31adce27)[SyscError](structSyscError.xhtml) [syscCompleteSetup](group__SyscParticipantLibraryCAPI.xhtml#ga831884747873b947fcdc57ef31adce27)(const [SyscSetupInfo](structSyscSetupInfo.xhtml) setupInfo);

<a id="l00196" name="l00196"></a> 196 

<a id="l00204" name="l00204"></a>[ 204](group__SyscParticipantLibraryCAPI.xhtml#ga06c366cb935ade55b7b90de9691d3f38)[SyscError](structSyscError.xhtml) [syscRegisterInputScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga06c366cb935ade55b7b90de9691d3f38)(

<a id="l00205" name="l00205"></a> 205 [SyscInputScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gaaf3788ac706a730edbf6093c7e543681) dataAccess);

<a id="l00206" name="l00206"></a> 206 

<a id="l00217" name="l00217"></a>[ 217](group__SyscParticipantLibraryCAPI.xhtml#ga04bbb44826997f602707b9e01d07d78e)[SyscError](structSyscError.xhtml) [syscRegisterInputScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga04bbb44826997f602707b9e01d07d78e)(

<a id="l00218" name="l00218"></a> 218 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00219" name="l00219"></a> 219 [SyscInputScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gad41922f1a4f5abb891d5a913ba5fcccf) dataAccess);

<a id="l00220" name="l00220"></a> 220 

<a id="l00228" name="l00228"></a>[ 228](group__SyscParticipantLibraryCAPI.xhtml#ga6b2aee555f07109357958edc9898b8b5)[SyscError](structSyscError.xhtml) [syscRegisterInputScalarDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga6b2aee555f07109357958edc9898b8b5)(

<a id="l00229" name="l00229"></a> 229 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00230" name="l00230"></a> 230 [SyscInputScalarDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga844dc6322bd6e4eabc2d3d2d9e69bdb1) dataAccess);

<a id="l00231" name="l00231"></a> 231 

<a id="l00239" name="l00239"></a>[ 239](group__SyscParticipantLibraryCAPI.xhtml#ga36e9fe53c70f9c15cbcfc3957f80852b)[SyscError](structSyscError.xhtml) [syscRegisterInputVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga36e9fe53c70f9c15cbcfc3957f80852b)(

<a id="l00240" name="l00240"></a> 240 [SyscInputVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga8d5f53de4e65a4bacef0f25ba8b46483) dataAccess);

<a id="l00241" name="l00241"></a> 241 

<a id="l00252" name="l00252"></a>[ 252](group__SyscParticipantLibraryCAPI.xhtml#ga46b386f0c3ed52071dd851b55763b1c8)[SyscError](structSyscError.xhtml) [syscRegisterInputVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga46b386f0c3ed52071dd851b55763b1c8)(

<a id="l00253" name="l00253"></a> 253 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00254" name="l00254"></a> 254 [SyscInputVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gae7c6372393f3ec720b8d6d1535fcf9b3) dataAccess);

<a id="l00255" name="l00255"></a> 255 

<a id="l00263" name="l00263"></a>[ 263](group__SyscParticipantLibraryCAPI.xhtml#gad7774418be78b8b39c9b45b7fcade1d3)[SyscError](structSyscError.xhtml) [syscRegisterInputVectorDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gad7774418be78b8b39c9b45b7fcade1d3)(

<a id="l00264" name="l00264"></a> 264 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00265" name="l00265"></a> 265 [SyscInputVectorDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gae2e92f1b7ae911c36bf3606c60a01511) dataAccess);

<a id="l00266" name="l00266"></a> 266 

<a id="l00274" name="l00274"></a>[ 274](group__SyscParticipantLibraryCAPI.xhtml#ga6e187589ca426402ee045ccecfec21d3)[SyscError](structSyscError.xhtml) [syscRegisterOutputScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga6e187589ca426402ee045ccecfec21d3)(

<a id="l00275" name="l00275"></a> 275 [SyscOutputScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gabd35283796cae3d3dbc851ac66b8564f) dataAccess);

<a id="l00276" name="l00276"></a> 276 

<a id="l00287" name="l00287"></a>[ 287](group__SyscParticipantLibraryCAPI.xhtml#ga2c90e2ea571de3b7ce5e1ca65a996d8a)[SyscError](structSyscError.xhtml) [syscRegisterOutputScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga2c90e2ea571de3b7ce5e1ca65a996d8a)(

<a id="l00288" name="l00288"></a> 288 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00289" name="l00289"></a> 289 [SyscOutputScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gab378ed75ffd9b081ad7eccf8107a5542) dataAccess);

<a id="l00290" name="l00290"></a> 290 

<a id="l00298" name="l00298"></a>[ 298](group__SyscParticipantLibraryCAPI.xhtml#ga7880daf983c8bac7db920281fdc937c1)[SyscError](structSyscError.xhtml) [syscRegisterOutputScalarDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga7880daf983c8bac7db920281fdc937c1)(

<a id="l00299" name="l00299"></a> 299 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00300" name="l00300"></a> 300 [SyscOutputScalarDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga7767f728d880014dfbd853bbb8e0eb07) dataAccess);

<a id="l00301" name="l00301"></a> 301 

<a id="l00309" name="l00309"></a>[ 309](group__SyscParticipantLibraryCAPI.xhtml#gaa3956909f65a425bec64c86ec5d5515b)[SyscError](structSyscError.xhtml) [syscRegisterOutputVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gaa3956909f65a425bec64c86ec5d5515b)(

<a id="l00310" name="l00310"></a> 310 [SyscOutputVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gae99c8cb78199403b9e74217557be206a) dataAccess);

<a id="l00311" name="l00311"></a> 311 

<a id="l00322" name="l00322"></a>[ 322](group__SyscParticipantLibraryCAPI.xhtml#ga9793fb31fe905768b175842ceab722e5)[SyscError](structSyscError.xhtml) [syscRegisterOutputVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga9793fb31fe905768b175842ceab722e5)(

<a id="l00323" name="l00323"></a> 323 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00324" name="l00324"></a> 324 [SyscOutputVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gab30cbe5478bf769c81f5c0a07e885afd) dataAccess);

<a id="l00325" name="l00325"></a> 325 

<a id="l00333" name="l00333"></a>[ 333](group__SyscParticipantLibraryCAPI.xhtml#gad5c33007c0067ab6edf8a72ab422ff7d)[SyscError](structSyscError.xhtml) [syscRegisterOutputVectorDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gad5c33007c0067ab6edf8a72ab422ff7d)(

<a id="l00334" name="l00334"></a> 334 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00335" name="l00335"></a> 335 [SyscOutputVectorDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga1d6d5d9fa806ac5820d9a6ed85811804) dataAccess);

<a id="l00336" name="l00336"></a> 336 

<a id="l00344" name="l00344"></a>[ 344](group__SyscParticipantLibraryCAPI.xhtml#ga1f4ab3d781755660f64b5a2cb691abe9)[SyscError](structSyscError.xhtml) [syscRegisterInputComplexScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga1f4ab3d781755660f64b5a2cb691abe9)(

<a id="l00345" name="l00345"></a> 345 [SyscInputComplexScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gab388f936f3a73b9b480a792c401a95a1) dataAccess);

<a id="l00346" name="l00346"></a> 346 

<a id="l00357" name="l00357"></a>[ 357](group__SyscParticipantLibraryCAPI.xhtml#ga55a307bf13f2d002f05660d781fef50e)[SyscError](structSyscError.xhtml) [syscRegisterInputComplexScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga55a307bf13f2d002f05660d781fef50e)(

<a id="l00358" name="l00358"></a> 358 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00359" name="l00359"></a> 359 [SyscInputComplexScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga7a0c5889de7b17b59d44595d7636747e) dataAccess);

<a id="l00360" name="l00360"></a> 360 

<a id="l00368" name="l00368"></a>[ 368](group__SyscParticipantLibraryCAPI.xhtml#gaf281613584c91fb460de5e4557f16767)[SyscError](structSyscError.xhtml) [syscRegisterInputComplexVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gaf281613584c91fb460de5e4557f16767)(

<a id="l00369" name="l00369"></a> 369 [SyscInputComplexVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gace54794852b48d8725b930f1aed89c4d) dataAccess);

<a id="l00370" name="l00370"></a> 370 

<a id="l00381" name="l00381"></a>[ 381](group__SyscParticipantLibraryCAPI.xhtml#gadfee511d3a3021907ee187716fff0944)[SyscError](structSyscError.xhtml) [syscRegisterInputComplexVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gadfee511d3a3021907ee187716fff0944)(

<a id="l00382" name="l00382"></a> 382 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00383" name="l00383"></a> 383 [SyscInputComplexVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga68dcce877e8cc69f13bee845c76f1b4d) dataAccess);

<a id="l00384" name="l00384"></a> 384 

<a id="l00392" name="l00392"></a>[ 392](group__SyscParticipantLibraryCAPI.xhtml#ga1c0e074f2239faf10594e3139d32efe1)[SyscError](structSyscError.xhtml) [syscRegisterOutputComplexScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga1c0e074f2239faf10594e3139d32efe1)(

<a id="l00393" name="l00393"></a> 393 [SyscOutputComplexScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17d96c2c29a44374309efafdfb8fef62) dataAccess);

<a id="l00394" name="l00394"></a> 394 

<a id="l00405" name="l00405"></a>[ 405](group__SyscParticipantLibraryCAPI.xhtml#ga5a7faf0c3fe80ffc7925da217ecce202)[SyscError](structSyscError.xhtml) [syscRegisterOutputComplexScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga5a7faf0c3fe80ffc7925da217ecce202)(

<a id="l00406" name="l00406"></a> 406 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00407" name="l00407"></a> 407 [SyscOutputComplexScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga71ac4910edd87d8d62e871001258c698) dataAccess);

<a id="l00408" name="l00408"></a> 408 

<a id="l00416" name="l00416"></a>[ 416](group__SyscParticipantLibraryCAPI.xhtml#ga1cb92c5ccc643abce68fba25f61e3d41)[SyscError](structSyscError.xhtml) [syscRegisterOutputComplexVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga1cb92c5ccc643abce68fba25f61e3d41)(

<a id="l00417" name="l00417"></a> 417 [SyscOutputComplexVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga65a0f3a119f2cec715ac89798f16a97c) dataAccess);

<a id="l00418" name="l00418"></a> 418 

<a id="l00429" name="l00429"></a>[ 429](group__SyscParticipantLibraryCAPI.xhtml#ga859961191e2943afd73b8e31cbd010c9)[SyscError](structSyscError.xhtml) [syscRegisterOutputComplexVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga859961191e2943afd73b8e31cbd010c9)(

<a id="l00430" name="l00430"></a> 430 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00431" name="l00431"></a> 431 [SyscOutputComplexVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga18e31a00d833843895c731e69ca006b0) dataAccess);

<a id="l00432" name="l00432"></a> 432 

<a id="l00440" name="l00440"></a>[ 440](group__SyscParticipantLibraryCAPI.xhtml#ga044974d4f159fd35669b77e5111fe7e0)[SyscError](structSyscError.xhtml) [syscRegisterSurfMeshAccess](group__SyscParticipantLibraryCAPI.xhtml#ga044974d4f159fd35669b77e5111fe7e0)([SyscSurfMeshAccess](group__SyscParticipantLibraryCAPI.xhtml#ga71e4eb102d00dd0a211f6dc2f4d24222) meshAccess);

<a id="l00441" name="l00441"></a> 441 

<a id="l00452" name="l00452"></a>[ 452](group__SyscParticipantLibraryCAPI.xhtml#gadddd0903fcab2450b14f54157e283302)[SyscError](structSyscError.xhtml) [syscRegisterSurfaceMeshAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gadddd0903fcab2450b14f54157e283302)(

<a id="l00453" name="l00453"></a> 453 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00454" name="l00454"></a> 454 [SyscSurfaceMeshAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gafbfb299099d65e3f232bb67a04d1a8e9) meshAccess);

<a id="l00455" name="l00455"></a> 455 

<a id="l00466" name="l00466"></a>[ 466](group__SyscParticipantLibraryCAPI.xhtml#ga3261b0b3eb6278c380a5b59894a7b533)[SyscError](structSyscError.xhtml) [syscRegisterSurfaceMeshMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga3261b0b3eb6278c380a5b59894a7b533)(

<a id="l00467" name="l00467"></a> 467 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00468" name="l00468"></a> 468 [SyscSurfaceMeshMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga9ffe052c4c28ff40b4a14b32cd9f227c) meshAccess);

<a id="l00469" name="l00469"></a> 469 

<a id="l00477" name="l00477"></a>[ 477](group__SyscParticipantLibraryCAPI.xhtml#ga27ba2e330c4d2c20b692a7ab66852721)[SyscError](structSyscError.xhtml) [syscRegisterVolumeMeshAccess](group__SyscParticipantLibraryCAPI.xhtml#ga27ba2e330c4d2c20b692a7ab66852721)([SyscVolumeMeshAccess](group__SyscParticipantLibraryCAPI.xhtml#gad0ff77c2af045d3294b149219123a084) meshAccess);

<a id="l00478" name="l00478"></a> 478 

<a id="l00489" name="l00489"></a>[ 489](group__SyscParticipantLibraryCAPI.xhtml#ga3b90426f24a434668b5270930192fec6)[SyscError](structSyscError.xhtml) [syscRegisterVolumeMeshAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga3b90426f24a434668b5270930192fec6)(

<a id="l00490" name="l00490"></a> 490 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00491" name="l00491"></a> 491 [SyscVolumeMeshAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gadcb6262e27485836632696e52cf80fb9) meshAccess);

<a id="l00492" name="l00492"></a> 492 

<a id="l00503" name="l00503"></a>[ 503](group__SyscParticipantLibraryCAPI.xhtml#gab71a3bc5775e830b2dac81dd6828cb13)[SyscError](structSyscError.xhtml) [syscRegisterVolumeMeshMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gab71a3bc5775e830b2dac81dd6828cb13)(

<a id="l00504" name="l00504"></a> 504 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00505" name="l00505"></a> 505 [SyscVolumeMeshMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gaf381b799bec1baf9f3ab727b61458b59) meshAccess);

<a id="l00506" name="l00506"></a> 506 

<a id="l00514" name="l00514"></a>[ 514](group__SyscParticipantLibraryCAPI.xhtml#gade30d8ccbbad0236ace57edfe55181d5)[SyscError](structSyscError.xhtml) [syscRegisterPointCloudAccess](group__SyscParticipantLibraryCAPI.xhtml#gade30d8ccbbad0236ace57edfe55181d5)([SyscPointCloudAccess](group__SyscParticipantLibraryCAPI.xhtml#gae999907f608779e525e34f60d2803038) pointCloudAccess);

<a id="l00515" name="l00515"></a> 515 

<a id="l00526" name="l00526"></a>[ 526](group__SyscParticipantLibraryCAPI.xhtml#gaedae298744b65c453c7dac3e8dc1d68a)[SyscError](structSyscError.xhtml) [syscRegisterPointCloudAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gaedae298744b65c453c7dac3e8dc1d68a)(

<a id="l00527" name="l00527"></a> 527 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00528" name="l00528"></a> 528 [SyscPointCloudAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gafa62fd6d86905625ae071dea4749a8df) pointCloudAccess);

<a id="l00529" name="l00529"></a> 529 

<a id="l00540" name="l00540"></a>[ 540](group__SyscParticipantLibraryCAPI.xhtml#ga77d6e90a118be65eeb86ce08a3a3dea5)[SyscError](structSyscError.xhtml) [syscRegisterPointCloudMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga77d6e90a118be65eeb86ce08a3a3dea5)(

<a id="l00541" name="l00541"></a> 541 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00542" name="l00542"></a> 542 [SyscPointCloudMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gac4a0788f14f0d473372f07638e9dceaa) pointCloudAccess);

<a id="l00543" name="l00543"></a> 543 

<a id="l00548" name="l00548"></a>[ 548](group__SyscParticipantLibraryCAPI.xhtml#gad49e03082ae93fdd7f96a3b7601ca9a8)[SyscError](structSyscError.xhtml) [syscRegisterZoneCountAccess](group__SyscParticipantLibraryCAPI.xhtml#gad49e03082ae93fdd7f96a3b7601ca9a8)(

<a id="l00549" name="l00549"></a> 549 [SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b) opaqueDataAccess,

<a id="l00550" name="l00550"></a> 550 [SyscZoneCountAccess](group__SyscParticipantLibraryCAPI.xhtml#gaabc0678095ad5a5efb8be4d666ce2677) zoneCountAccess);

<a id="l00551" name="l00551"></a> 551 

<a id="l00560" name="l00560"></a>[ 560](group__SyscParticipantLibraryCAPI.xhtml#ga30880d98428a08962ab027267c66c2ae)[SyscError](structSyscError.xhtml) [syscRegisterRestartPointCreation](group__SyscParticipantLibraryCAPI.xhtml#ga30880d98428a08962ab027267c66c2ae)(

<a id="l00561" name="l00561"></a> 561 [SyscRestartPointCreation](group__SyscParticipantLibraryCAPI.xhtml#ga800a36e5223ab1f89d2207333fb4f959) restartPointCreation);

<a id="l00562" name="l00562"></a> 562 

<a id="l00574" name="l00574"></a>[ 574](group__SyscParticipantLibraryCAPI.xhtml#gaa26049072c61f17c4e1296490c00abc5)[SyscError](structSyscError.xhtml) [syscInitializeAnalysis](group__SyscParticipantLibraryCAPI.xhtml#gaa26049072c61f17c4e1296490c00abc5)();

<a id="l00575" name="l00575"></a> 575 

<a id="l00583" name="l00583"></a>[ 583](group__SyscParticipantLibraryCAPI.xhtml#gaea2bf4afeff9dd606125e00bb6c475a0)int [syscDoIteration](group__SyscParticipantLibraryCAPI.xhtml#gaea2bf4afeff9dd606125e00bb6c475a0)();

<a id="l00584" name="l00584"></a> 584 

<a id="l00602" name="l00602"></a>[ 602](group__SyscParticipantLibraryCAPI.xhtml#gaf701624f0add6b5d7a5fd2d9dcf8e298)int [syscDoTimeStep](group__SyscParticipantLibraryCAPI.xhtml#gaf701624f0add6b5d7a5fd2d9dcf8e298)();

<a id="l00603" name="l00603"></a> 603 

<a id="l00615" name="l00615"></a>[ 615](group__SyscParticipantLibraryCAPI.xhtml#gace1009120d02713ffe0b625d1cadd33d)[SyscTimeStep](structSyscTimeStep.xhtml) [syscGetCurrentTimeStep](group__SyscParticipantLibraryCAPI.xhtml#gace1009120d02713ffe0b625d1cadd33d)();

<a id="l00616" name="l00616"></a> 616 

<a id="l00636" name="l00636"></a>[ 636](group__SyscParticipantLibraryCAPI.xhtml#ga8445069f0234978743203e1d5c0cb62c)[SyscError](structSyscError.xhtml) [syscUpdateInputs](group__SyscParticipantLibraryCAPI.xhtml#ga8445069f0234978743203e1d5c0cb62c)();

<a id="l00637" name="l00637"></a> 637 

<a id="l00646" name="l00646"></a>[ 646](group__SyscParticipantLibraryCAPI.xhtml#ga3b5e8e0315bbbe48526324439c422733)[SyscError](structSyscError.xhtml) [syscUpdateOutputs](group__SyscParticipantLibraryCAPI.xhtml#ga3b5e8e0315bbbe48526324439c422733)(const enum [SyscConvergenceStatus](group__SyscParticipantLibraryCAPI.xhtml#ga10ce3774353dfbc811147a9ad211b3cd) convStatus);

<a id="l00647" name="l00647"></a> 647 

<a id="l00653" name="l00653"></a>[ 653](group__SyscParticipantLibraryCAPI.xhtml#ga09a7259037537f2d3d0403788d80e2e1)[SyscError](structSyscError.xhtml) [syscDisconnect](group__SyscParticipantLibraryCAPI.xhtml#ga09a7259037537f2d3d0403788d80e2e1)();

<a id="l00654" name="l00654"></a> 654 

<a id="l00657" name="l00657"></a>[ 657](group__SyscParticipantLibraryCAPI.xhtml#ga009687c58ccf588d2c94d879a2769541)void [syscFatalError](group__SyscParticipantLibraryCAPI.xhtml#ga009687c58ccf588d2c94d879a2769541)(const char* errorMessage);

<a id="l00658" name="l00658"></a> 658 

<a id="l00677" name="l00677"></a>[ 677](group__SyscParticipantLibraryCAPI.xhtml#ga456487cb20f8a9b6c392eec4d0eaceb7)[SyscError](structSyscError.xhtml) [syscCheckSurfaceMeshValidity](group__SyscParticipantLibraryCAPI.xhtml#ga456487cb20f8a9b6c392eec4d0eaceb7)([SyscSurfaceMesh](structSyscSurfaceMesh.xhtml) mesh);

<a id="l00678" name="l00678"></a> 678 

<a id="l00692" name="l00692"></a>[ 692](group__SyscParticipantLibraryCAPI.xhtml#gad55adabb4ed5bdb44833c06671541921)int [syscWriteSetupFile](group__SyscParticipantLibraryCAPI.xhtml#gad55adabb4ed5bdb44833c06671541921)(const [SyscSetupFileInfo](structSyscSetupFileInfo.xhtml) setupFileInfo);

<a id="l00693" name="l00693"></a> 693 

<a id="l00696" name="l00696"></a>[ 696](group__SyscParticipantLibraryCAPI.xhtml#gafb6abc910fc014d46cb46dc86cf48c60)[SyscError](structSyscError.xhtml) [syscWriteResults](group__SyscParticipantLibraryCAPI.xhtml#gafb6abc910fc014d46cb46dc86cf48c60)(const [SyscResultsInfo](structSyscResultsInfo.xhtml) resultsInfo);

<a id="l00697" name="l00697"></a> 697 

<a id="l00704" name="l00704"></a>[ 704](group__SyscParticipantLibraryCAPI.xhtml#ga5783653d3a5994b0bccb7471843e72eb)size\_t [syscGetNumRegions](group__SyscParticipantLibraryCAPI.xhtml#ga5783653d3a5994b0bccb7471843e72eb)();

<a id="l00705" name="l00705"></a> 705 

<a id="l00715" name="l00715"></a>[ 715](group__SyscParticipantLibraryCAPI.xhtml#ga73a2e2125fd1a583b152012a8d7f9ce9)[SyscRegion](structSyscRegion.xhtml) [syscGetAddedRegion](group__SyscParticipantLibraryCAPI.xhtml#ga73a2e2125fd1a583b152012a8d7f9ce9)(size\_t index);

<a id="l00716" name="l00716"></a> 716 

<a id="l00719" name="l00719"></a>[ 719](group__SyscParticipantLibraryCAPI.xhtml#ga47273dac1bc54d406c085bee823c5131)[SyscSolutionControl](structSyscSolutionControl.xhtml) [syscGetSolutionControl](group__SyscParticipantLibraryCAPI.xhtml#ga47273dac1bc54d406c085bee823c5131)();

<a id="l00720" name="l00720"></a> 720 

<a id="l00727" name="l00727"></a>[ 727](group__SyscParticipantLibraryCAPI.xhtml#ga8987dbe52eb06c7d089663d4c29c17ed)size\_t [syscGetNumCouplingInterfaces](group__SyscParticipantLibraryCAPI.xhtml#ga8987dbe52eb06c7d089663d4c29c17ed)();

<a id="l00728" name="l00728"></a> 728 

<a id="l00729" name="l00729"></a> 729 

<a id="l00730" name="l00730"></a> 730[SyscCouplingInterface](structSyscCouplingInterface.xhtml) syscGetAddedCouplingInterface(size\_t index);

<a id="l00731" name="l00731"></a> 731 

<a id="l00734" name="l00734"></a> 734\#ifdef \_\_cplusplus

<a id="l00735" name="l00735"></a> 735}

<a id="l00736" name="l00736"></a> 736\#endif

[syscFatalError](group__SyscParticipantLibraryCAPI.xhtml#ga009687c58ccf588d2c94d879a2769541)

void syscFatalError(const char *errorMessage)

Provide a function to notify System Coupling about a fatal error.



[syscRegisterSurfMeshAccess](group__SyscParticipantLibraryCAPI.xhtml#ga044974d4f159fd35669b77e5111fe7e0)

SyscError syscRegisterSurfMeshAccess(SyscSurfMeshAccess meshAccess)

Provide a function to register surface mesh access.



[syscRegisterInputScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga04bbb44826997f602707b9e01d07d78e)

SyscError syscRegisterInputScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputScalarDataAccessWithPointer dataAccess)

Provide a function to register input scalar data access.



[syscRegisterInputScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga06c366cb935ade55b7b90de9691d3f38)

SyscError syscRegisterInputScalarDataAccess(SyscInputScalarDataAccess dataAccess)

Provide a function to register input scalar data access.



[syscDisconnect](group__SyscParticipantLibraryCAPI.xhtml#ga09a7259037537f2d3d0403788d80e2e1)

SyscError syscDisconnect()

Provide a function to end the analysis and disconnect from System Coupling.



[SyscConvergenceStatus](group__SyscParticipantLibraryCAPI.xhtml#ga10ce3774353dfbc811147a9ad211b3cd)

SyscConvergenceStatus

Provide enum for participant's solver convergence status.

**Definition:** [syscCommonTypes.h:97](syscCommonTypes_8h_source.xhtml#l00097)



[syscConnect](group__SyscParticipantLibraryCAPI.xhtml#ga1404ad75fb1f5b1515dae967b71b1725)

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](group__SyscParticipantLibraryCAPI.xhtml#ga17d96c2c29a44374309efafdfb8fef62)

SyscOutputComplexScalarData(* SyscOutputComplexScalarDataAccess)(const char *regionName, const char *variableName)

Provide function prototype for access to output complex scalar data.

**Definition:** [syscFunctionTypes.h:165](syscFunctionTypes_8h_source.xhtml#l00165)



[SyscOpaqueDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga17ef60969b3c919163ba2471eb95a28b)

void * SyscOpaqueDataAccess

**Definition:** [syscCommonTypes.h:144](syscCommonTypes_8h_source.xhtml#l00144)



[SyscOutputComplexVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga18e31a00d833843895c731e69ca006b0)

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](syscFunctionTypes_8h_source.xhtml#l00187)



[syscRegisterOutputComplexScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga1c0e074f2239faf10594e3139d32efe1)

SyscError syscRegisterOutputComplexScalarDataAccess(SyscOutputComplexScalarDataAccess dataAccess)

Provide a function to register output complex scalar data access.



[syscRegisterOutputComplexVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga1cb92c5ccc643abce68fba25f61e3d41)

SyscError syscRegisterOutputComplexVectorDataAccess(SyscOutputComplexVectorDataAccess dataAccess)

Provide a function to register output complex vector data access.



[SyscOutputVectorDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga1d6d5d9fa806ac5820d9a6ed85811804)

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](syscFunctionTypes_8h_source.xhtml#l00126)



[syscRegisterInputComplexScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga1f4ab3d781755660f64b5a2cb691abe9)

SyscError syscRegisterInputComplexScalarDataAccess(SyscInputComplexScalarDataAccess dataAccess)

Provide a function to register input complex scalar data access.



[syscRegisterVolumeMeshAccess](group__SyscParticipantLibraryCAPI.xhtml#ga27ba2e330c4d2c20b692a7ab66852721)

SyscError syscRegisterVolumeMeshAccess(SyscVolumeMeshAccess meshAccess)

Provide a function to register volume mesh access.



[syscRegisterOutputScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga2c90e2ea571de3b7ce5e1ca65a996d8a)

SyscError syscRegisterOutputScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputScalarDataAccessWithPointer dataAccess)

Provide a function to register output scalar data access.



[syscRegisterRestartPointCreation](group__SyscParticipantLibraryCAPI.xhtml#ga30880d98428a08962ab027267c66c2ae)

SyscError syscRegisterRestartPointCreation(SyscRestartPointCreation restartPointCreation)

Provide a function to register restart point creation callback.



[syscRegisterSurfaceMeshMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga3261b0b3eb6278c380a5b59894a7b533)

SyscError syscRegisterSurfaceMeshMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscSurfaceMeshMultiZoneAccess meshAccess)

Provide a function to register surface mesh multi-zone access.



[syscRegisterInputVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga36e9fe53c70f9c15cbcfc3957f80852b)

SyscError syscRegisterInputVectorDataAccess(SyscInputVectorDataAccess dataAccess)

Provide a function to register input vector data access.



[syscUpdateOutputs](group__SyscParticipantLibraryCAPI.xhtml#ga3b5e8e0315bbbe48526324439c422733)

SyscError syscUpdateOutputs(const enum SyscConvergenceStatus convStatus)

Provide a function to update the participants output variables.



[syscRegisterVolumeMeshAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga3b90426f24a434668b5270930192fec6)

SyscError syscRegisterVolumeMeshAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscVolumeMeshAccessWithPointer meshAccess)

Provide a function to register volume mesh access.



[syscAddRegion](group__SyscParticipantLibraryCAPI.xhtml#ga3c895512d255076ce0b7dcc0b527991b)

SyscError syscAddRegion(const SyscRegion region)

Provide a function to add a region that could be used in a coupled analysis.



[syscCheckSurfaceMeshValidity](group__SyscParticipantLibraryCAPI.xhtml#ga456487cb20f8a9b6c392eec4d0eaceb7)

SyscError syscCheckSurfaceMeshValidity(SyscSurfaceMesh mesh)

Provide a function to perform simple mesh validity checks.



[syscRegisterInputVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga46b386f0c3ed52071dd851b55763b1c8)

SyscError syscRegisterInputVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputVectorDataAccessWithPointer dataAccess)

Provide a function to register input vector data access.



[syscGetSolutionControl](group__SyscParticipantLibraryCAPI.xhtml#ga47273dac1bc54d406c085bee823c5131)

SyscSolutionControl syscGetSolutionControl()

Get solution control.



[syscAddCouplingInterface](group__SyscParticipantLibraryCAPI.xhtml#ga5330416d093678fc96231257a88ea337)

SyscError syscAddCouplingInterface(const SyscCouplingInterface couplingInterface)

Provide a function to add a coupling interface.



[syscRegisterInputComplexScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga55a307bf13f2d002f05660d781fef50e)

SyscError syscRegisterInputComplexScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputComplexScalarDataAccessWithPointer dataAccess)

Provide a function to register input complex scalar data access.



[syscGetNumRegions](group__SyscParticipantLibraryCAPI.xhtml#ga5783653d3a5994b0bccb7471843e72eb)

size_t syscGetNumRegions()

Provide a function to return the number of added regions.



[syscRegisterOutputComplexScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga5a7faf0c3fe80ffc7925da217ecce202)

SyscError syscRegisterOutputComplexScalarDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputComplexScalarDataAccessWithPointer dataAccess)

Provide a function to register output complex scalar data access.



[SyscOutputComplexVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga65a0f3a119f2cec715ac89798f16a97c)

SyscOutputComplexVectorData(* SyscOutputComplexVectorDataAccess)(const char *regionName, const char *variableName)

Provide function prototype for access to output complex vector data.

**Definition:** [syscFunctionTypes.h:180](syscFunctionTypes_8h_source.xhtml#l00180)



[syscConnectParallel](group__SyscParticipantLibraryCAPI.xhtml#ga68a9b5b64715ad6ffde1c7b145bb4d0f)

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](group__SyscParticipantLibraryCAPI.xhtml#ga68dcce877e8cc69f13bee845c76f1b4d)

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](syscFunctionTypes_8h_source.xhtml#l00157)



[syscRegisterInputScalarDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga6b2aee555f07109357958edc9898b8b5)

SyscError syscRegisterInputScalarDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscInputScalarDataMultiZoneAccess dataAccess)

Provide a function to register input scalar data multi-zone access.



[syscRegisterOutputScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga6e187589ca426402ee045ccecfec21d3)

SyscError syscRegisterOutputScalarDataAccess(SyscOutputScalarDataAccess dataAccess)

Provide a function to register output scalar data access.



[SyscOutputComplexScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga71ac4910edd87d8d62e871001258c698)

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](syscFunctionTypes_8h_source.xhtml#l00172)



[SyscSurfMeshAccess](group__SyscParticipantLibraryCAPI.xhtml#ga71e4eb102d00dd0a211f6dc2f4d24222)

SyscSurfaceMesh(* SyscSurfMeshAccess)(const char *regionName)

Provide function prototype for access to surface mesh.

**Definition:** [syscFunctionTypes.h:195](syscFunctionTypes_8h_source.xhtml#l00195)



[syscGetAddedRegion](group__SyscParticipantLibraryCAPI.xhtml#ga73a2e2125fd1a583b152012a8d7f9ce9)

SyscRegion syscGetAddedRegion(size_t index)

Provide a function to return added region given the region index.



[SyscOutputScalarDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga7767f728d880014dfbd853bbb8e0eb07)

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](syscFunctionTypes_8h_source.xhtml#l00102)



[syscRegisterPointCloudMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga77d6e90a118be65eeb86ce08a3a3dea5)

SyscError syscRegisterPointCloudMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscPointCloudMultiZoneAccess pointCloudAccess)

Provide a function to register point cloud multi-zone access.



[syscRegisterOutputScalarDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga7880daf983c8bac7db920281fdc937c1)

SyscError syscRegisterOutputScalarDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputScalarDataMultiZoneAccess dataAccess)

Provide a function to register output scalar data multi-zone access.



[SyscInputComplexScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga7a0c5889de7b17b59d44595d7636747e)

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](syscFunctionTypes_8h_source.xhtml#l00142)



[SyscRestartPointCreation](group__SyscParticipantLibraryCAPI.xhtml#ga800a36e5223ab1f89d2207333fb4f959)

const char *(* SyscRestartPointCreation)()

Provide function prototype for creating restart points.

**Definition:** [syscFunctionTypes.h:263](syscFunctionTypes_8h_source.xhtml#l00263)



[syscCompleteSetup](group__SyscParticipantLibraryCAPI.xhtml#ga831884747873b947fcdc57ef31adce27)

SyscError syscCompleteSetup(const SyscSetupInfo setupInfo)

Provide a function to notify System Coupling that setup can be completed.



[syscUpdateInputs](group__SyscParticipantLibraryCAPI.xhtml#ga8445069f0234978743203e1d5c0cb62c)

SyscError syscUpdateInputs()

Provide a function to update the participants input variables.



[SyscInputScalarDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga844dc6322bd6e4eabc2d3d2d9e69bdb1)

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](syscFunctionTypes_8h_source.xhtml#l00054)



[syscRegisterOutputComplexVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga859961191e2943afd73b8e31cbd010c9)

SyscError syscRegisterOutputComplexVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputComplexVectorDataAccessWithPointer dataAccess)

Provide a function to register output complex vector data access.



[syscStartStandaloneParallel](group__SyscParticipantLibraryCAPI.xhtml#ga862e7375111dcee847bc05463c72b329)

SyscError syscStartStandaloneParallel(const size_t mpiCommunicator)

Provide a function to start standalone mode in parallel.



[syscGetNumCouplingInterfaces](group__SyscParticipantLibraryCAPI.xhtml#ga8987dbe52eb06c7d089663d4c29c17ed)

size_t syscGetNumCouplingInterfaces()

Provide a function to return the number of added coupling interfaces.



[SyscInputVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#ga8d5f53de4e65a4bacef0f25ba8b46483)

SyscInputVectorData(* SyscInputVectorDataAccess)(const char *regionName, const char *variableName)

Provide function prototype for access to input vector data.

**Definition:** [syscFunctionTypes.h:63](syscFunctionTypes_8h_source.xhtml#l00063)



[syscConnectUseStruct](group__SyscParticipantLibraryCAPI.xhtml#ga8d84278ef4d48a739948f0a952cb2a00)

SyscError syscConnectUseStruct(SyscParticipantInfo participantInfo)

Provide a function to establish connection to System Coupling in serial using a C structure.



[syscRegisterOutputVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#ga9793fb31fe905768b175842ceab722e5)

SyscError syscRegisterOutputVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputVectorDataAccessWithPointer dataAccess)

Provide a function to register output vector data access.



[SyscSurfaceMeshMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#ga9ffe052c4c28ff40b4a14b32cd9f227c)

SyscSurfaceMesh(* SyscSurfaceMeshMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)

Provide function prototype for access to multi-zone surface mesh.

**Definition:** [syscFunctionTypes.h:206](syscFunctionTypes_8h_source.xhtml#l00206)



[syscInitializeAnalysis](group__SyscParticipantLibraryCAPI.xhtml#gaa26049072c61f17c4e1296490c00abc5)

SyscError syscInitializeAnalysis()

Provide a function to notify System Coupling that analysis initialization can be completed.



[syscRegisterOutputVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gaa3956909f65a425bec64c86ec5d5515b)

SyscError syscRegisterOutputVectorDataAccess(SyscOutputVectorDataAccess dataAccess)

Provide a function to register output vector data access.



[SyscZoneCountAccess](group__SyscParticipantLibraryCAPI.xhtml#gaabc0678095ad5a5efb8be4d666ce2677)

uint16_t(* SyscZoneCountAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)

Provide function prototype for access to zone count.

**Definition:** [syscFunctionTypes.h:252](syscFunctionTypes_8h_source.xhtml#l00252)



[SyscInputScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gaaf3788ac706a730edbf6093c7e543681)

SyscInputScalarData(* SyscInputScalarDataAccess)(const char *regionName, const char *variableName)

Provide function prototype for access to input scalar data.

**Definition:** [syscFunctionTypes.h:39](syscFunctionTypes_8h_source.xhtml#l00039)



[SyscOutputVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gab30cbe5478bf769c81f5c0a07e885afd)

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](syscFunctionTypes_8h_source.xhtml#l00118)



[SyscOutputScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gab378ed75ffd9b081ad7eccf8107a5542)

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](syscFunctionTypes_8h_source.xhtml#l00094)



[SyscInputComplexScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gab388f936f3a73b9b480a792c401a95a1)

SyscInputComplexScalarData(* SyscInputComplexScalarDataAccess)(const char *regionName, const char *variableName)

Provide function prototype for access to input complex scalar data.

**Definition:** [syscFunctionTypes.h:135](syscFunctionTypes_8h_source.xhtml#l00135)



[syscRegisterVolumeMeshMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gab71a3bc5775e830b2dac81dd6828cb13)

SyscError syscRegisterVolumeMeshMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscVolumeMeshMultiZoneAccess meshAccess)

Provide a function to register volume mesh multi-zone access.



[SyscOutputScalarDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gabd35283796cae3d3dbc851ac66b8564f)

SyscOutputScalarData(* SyscOutputScalarDataAccess)(const char *regionName, const char *variableName)

Provide function prototype for access to output scalar data.

**Definition:** [syscFunctionTypes.h:87](syscFunctionTypes_8h_source.xhtml#l00087)



[SyscPointCloudMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gac4a0788f14f0d473372f07638e9dceaa)

SyscPointCloud(* SyscPointCloudMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)

Provide function prototype for access to multi-zone point cloud.

**Definition:** [syscFunctionTypes.h:244](syscFunctionTypes_8h_source.xhtml#l00244)



[syscConnectParallelUseStruct](group__SyscParticipantLibraryCAPI.xhtml#gac695e9f06d272958b8fc81bff07708fb)

SyscError syscConnectParallelUseStruct(SyscParticipantInfo participantInfo, const size_t communicator)

Provide a function to establish connection to System Coupling in parellel using a C structure.



[syscGetCurrentTimeStep](group__SyscParticipantLibraryCAPI.xhtml#gace1009120d02713ffe0b625d1cadd33d)

SyscTimeStep syscGetCurrentTimeStep()

Provide a function to get current time step.



[SyscInputComplexVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gace54794852b48d8725b930f1aed89c4d)

SyscInputComplexVectorData(* SyscInputComplexVectorDataAccess)(const char *regionName, const char *variableName)

Provide function prototype for access to input complex vector data.

**Definition:** [syscFunctionTypes.h:150](syscFunctionTypes_8h_source.xhtml#l00150)



[SyscVolumeMeshAccess](group__SyscParticipantLibraryCAPI.xhtml#gad0ff77c2af045d3294b149219123a084)

SyscVolumeMesh(* SyscVolumeMeshAccess)(const char *regionName)

Provide function prototype for access to volume mesh.

**Definition:** [syscFunctionTypes.h:214](syscFunctionTypes_8h_source.xhtml#l00214)



[SyscInputScalarDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gad41922f1a4f5abb891d5a913ba5fcccf)

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](syscFunctionTypes_8h_source.xhtml#l00046)



[syscRegisterZoneCountAccess](group__SyscParticipantLibraryCAPI.xhtml#gad49e03082ae93fdd7f96a3b7601ca9a8)

SyscError syscRegisterZoneCountAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscZoneCountAccess zoneCountAccess)

Provide a function to register zone count access.



[syscWriteSetupFile](group__SyscParticipantLibraryCAPI.xhtml#gad55adabb4ed5bdb44833c06671541921)

int syscWriteSetupFile(const SyscSetupFileInfo setupFileInfo)

Provide a function to write the setup file.



[syscRegisterOutputVectorDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gad5c33007c0067ab6edf8a72ab422ff7d)

SyscError syscRegisterOutputVectorDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscOutputVectorDataMultiZoneAccess dataAccess)

Provide a function to register output vector data multi-zone access.



[syscRegisterInputVectorDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gad7774418be78b8b39c9b45b7fcade1d3)

SyscError syscRegisterInputVectorDataMultiZoneAccess(SyscOpaqueDataAccess opaqueDataAccess, SyscInputVectorDataMultiZoneAccess dataAccess)

Provide a function to register input vector data multi-zone access.



[SyscVolumeMeshAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gadcb6262e27485836632696e52cf80fb9)

SyscVolumeMesh(* SyscVolumeMeshAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)

Provide function prototype for access to volume mesh with opaque pointer.

**Definition:** [syscFunctionTypes.h:220](syscFunctionTypes_8h_source.xhtml#l00220)



[syscRegisterSurfaceMeshAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gadddd0903fcab2450b14f54157e283302)

SyscError syscRegisterSurfaceMeshAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscSurfaceMeshAccessWithPointer meshAccess)

Provide a function to register surface mesh access.



[syscRegisterPointCloudAccess](group__SyscParticipantLibraryCAPI.xhtml#gade30d8ccbbad0236ace57edfe55181d5)

SyscError syscRegisterPointCloudAccess(SyscPointCloudAccess pointCloudAccess)

Provide a function to register point cloud access.



[syscAddCouplingInterfaceA](group__SyscParticipantLibraryCAPI.xhtml#gadec9e44f001d4ec2b8139e096ab93ac7)

SyscError syscAddCouplingInterfaceA(const SyscCouplingInterface couplingInterface, int autoGenerateDataTransfers)

Provide a function to add a coupling interface.



[syscRegisterInputComplexVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gadfee511d3a3021907ee187716fff0944)

SyscError syscRegisterInputComplexVectorDataAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscInputComplexVectorDataAccessWithPointer dataAccess)

Provide a function to register input complex vector data access.



[SyscInputVectorDataMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gae2e92f1b7ae911c36bf3606c60a01511)

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](syscFunctionTypes_8h_source.xhtml#l00078)



[SyscInputVectorDataAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gae7c6372393f3ec720b8d6d1535fcf9b3)

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](syscFunctionTypes_8h_source.xhtml#l00070)



[SyscPointCloudAccess](group__SyscParticipantLibraryCAPI.xhtml#gae999907f608779e525e34f60d2803038)

SyscPointCloud(* SyscPointCloudAccess)(const char *regionName)

Provide function prototype for access to point cloud.

**Definition:** [syscFunctionTypes.h:233](syscFunctionTypes_8h_source.xhtml#l00233)



[SyscOutputVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gae99c8cb78199403b9e74217557be206a)

SyscOutputVectorData(* SyscOutputVectorDataAccess)(const char *regionName, const char *variableName)

Provide function prototype for access to output vector data.

**Definition:** [syscFunctionTypes.h:111](syscFunctionTypes_8h_source.xhtml#l00111)



[syscDoIteration](group__SyscParticipantLibraryCAPI.xhtml#gaea2bf4afeff9dd606125e00bb6c475a0)

int syscDoIteration()

Provide a function to check whether to do a coupling iteration.



[syscRegisterPointCloudAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gaedae298744b65c453c7dac3e8dc1d68a)

SyscError syscRegisterPointCloudAccessWithPointer(SyscOpaqueDataAccess opaqueDataAccess, SyscPointCloudAccessWithPointer pointCloudAccess)

Provide a function to register point cloud access.



[syscRegisterInputComplexVectorDataAccess](group__SyscParticipantLibraryCAPI.xhtml#gaf281613584c91fb460de5e4557f16767)

SyscError syscRegisterInputComplexVectorDataAccess(SyscInputComplexVectorDataAccess dataAccess)

Provide a function to register input complex vector data access.



[SyscVolumeMeshMultiZoneAccess](group__SyscParticipantLibraryCAPI.xhtml#gaf381b799bec1baf9f3ab727b61458b59)

SyscVolumeMesh(* SyscVolumeMeshMultiZoneAccess)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName, uint16_t zoneIndex)

Provide function prototype for access to multi-zone volume mesh.

**Definition:** [syscFunctionTypes.h:225](syscFunctionTypes_8h_source.xhtml#l00225)



[syscDoTimeStep](group__SyscParticipantLibraryCAPI.xhtml#gaf701624f0add6b5d7a5fd2d9dcf8e298)

int syscDoTimeStep()

Provide a function to check whether to do a coupling time step.



[SyscPointCloudAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gafa62fd6d86905625ae071dea4749a8df)

SyscPointCloud(* SyscPointCloudAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)

Provide function prototype for access to point cloud with an opaque pointer.

**Definition:** [syscFunctionTypes.h:239](syscFunctionTypes_8h_source.xhtml#l00239)



[syscWriteResults](group__SyscParticipantLibraryCAPI.xhtml#gafb6abc910fc014d46cb46dc86cf48c60)

SyscError syscWriteResults(const SyscResultsInfo resultsInfo)

Write results to a file.



[SyscSurfaceMeshAccessWithPointer](group__SyscParticipantLibraryCAPI.xhtml#gafbfb299099d65e3f232bb67a04d1a8e9)

SyscSurfaceMesh(* SyscSurfaceMeshAccessWithPointer)(SyscOpaqueDataAccess opaqueDataAccess, const char *regionName)

Provide function prototype for access to surface mesh with opaque pointer.

**Definition:** [syscFunctionTypes.h:201](syscFunctionTypes_8h_source.xhtml#l00201)



[SyscCouplingInterface](structSyscCouplingInterface.xhtml)

Provide a struct for a coupling interface.

**Definition:** [syscCouplingInterface.h:45](syscCouplingInterface_8h_source.xhtml#l00045)



[SyscError](structSyscError.xhtml)

Provide a struct for detecting errors from the interface calls.

**Definition:** [syscCommonTypes.h:125](syscCommonTypes_8h_source.xhtml#l00125)



[SyscParticipantInfo](structSyscParticipantInfo.xhtml)

Provide a structure to provide connection info to System Coupling.

**Definition:** [syscCommonTypes.h:271](syscCommonTypes_8h_source.xhtml#l00271)



[SyscRegion](structSyscRegion.xhtml)

Provide a struct for a System Coupling region.

**Definition:** [syscRegion.h:42](syscRegion_8h_source.xhtml#l00042)



[SyscResultsInfo](structSyscResultsInfo.xhtml)

Provide a structure for writing results files.

**Definition:** [syscCommonTypes.h:232](syscCommonTypes_8h_source.xhtml#l00232)



[SyscSetupFileInfo](structSyscSetupFileInfo.xhtml)

Provide a structure for writing System Coupling setup files.

**Definition:** [syscCommonTypes.h:212](syscCommonTypes_8h_source.xhtml#l00212)



[SyscSetupInfo](structSyscSetupInfo.xhtml)

Provide a structure for System Coupling setup information.

**Definition:** [syscCommonTypes.h:160](syscCommonTypes_8h_source.xhtml#l00160)



[SyscSolutionControl](structSyscSolutionControl.xhtml)

Provide a structure containing solution control.

**Definition:** [syscCommonTypes.h:119](syscCommonTypes_8h_source.xhtml#l00119)



[SyscSurfaceMesh](structSyscSurfaceMesh.xhtml)

Provide a surface mesh access struct.

**Definition:** [syscSurfaceMesh.h:31](syscSurfaceMesh_8h_source.xhtml#l00031)



[SyscTimeStep](structSyscTimeStep.xhtml)

Provide a struct for time step.

**Definition:** [syscCommonTypes.h:112](syscCommonTypes_8h_source.xhtml#l00112)