## On this page

  

 

 # syscRegion

 Last update: 17.07.2025 

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

<a id="l00002" name="l00002"></a> 2\* Copyright 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/syscVariable.h"

<a id="l00011" name="l00011"></a> 11 

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

<a id="l00013" name="l00013"></a> 13 

<a id="l00014" name="l00014"></a> 14\#ifdef \_\_cplusplus

<a id="l00015" name="l00015"></a> 15extern "C" {

<a id="l00016" name="l00016"></a> 16\#endif

<a id="l00017" name="l00017"></a> 17 

<a id="l00042" name="l00042"></a>[ 42](structSyscRegion.xhtml)typedef struct [SyscRegion](structSyscRegion.xhtml) {

<a id="l00043" name="l00043"></a>[ 43](structSyscRegion.xhtml#a9ad96fdd8a6a46c8d0b4ac7ffb23d7a8) char [name](structSyscRegion.xhtml#a9ad96fdd8a6a46c8d0b4ac7ffb23d7a8)[[SYSC\_STRING\_LENGTH](group__SyscParticipantLibraryCAPI.xhtml#gab4cd55b5b37dd76c5755020302086b15)]; 

<a id="l00044" name="l00044"></a>[ 44](structSyscRegion.xhtml#a7fd5681f99d4737e705ef1c670ad6268) enum [SyscTopology](group__SyscParticipantLibraryCAPI.xhtml#gabf36499a0f333dc9b856c4bcbb25385a) [topology](structSyscRegion.xhtml#a7fd5681f99d4737e705ef1c670ad6268); 

<a id="l00045" name="l00045"></a>[ 45](structSyscRegion.xhtml#aba2c044546a908f37b3419408410b3a5) enum [SyscRegionDiscretizationType](group__SyscParticipantLibraryCAPI.xhtml#ga83942e23c7ff51ec76e4632612a34d45) [regionDiscretizationType](structSyscRegion.xhtml#aba2c044546a908f37b3419408410b3a5); 

<a id="l00046" name="l00046"></a>[ 46](structSyscRegion.xhtml#ac6572b0ff5814075613806b50506d7dd) char [displayName](structSyscRegion.xhtml#ac6572b0ff5814075613806b50506d7dd)[[SYSC\_STRING\_LENGTH](group__SyscParticipantLibraryCAPI.xhtml#gab4cd55b5b37dd76c5755020302086b15)]; 

<a id="l00047" name="l00047"></a>[ 47](group__SyscParticipantLibraryCAPI.xhtml#gac5687e76cd2c5d1249d8b3ac43ff29b4)} [SyscRegion](structSyscRegion.xhtml);



<a id="l00048" name="l00048"></a> 48 

<a id="l00063" name="l00063"></a>[ 63](group__SyscParticipantLibraryCAPI.xhtml#gaf8dee311cddc012ce6b54998fde8e29f)[SyscRegion](structSyscRegion.xhtml) [syscGetRegion](group__SyscParticipantLibraryCAPI.xhtml#gaf8dee311cddc012ce6b54998fde8e29f)(const char* name);

<a id="l00064" name="l00064"></a> 64 

<a id="l00077" name="l00077"></a>[ 77](group__SyscParticipantLibraryCAPI.xhtml#ga26c8d2435b5cd3c525d5221298ad3aaa)[SyscRegion](structSyscRegion.xhtml) [syscGetRegionT](group__SyscParticipantLibraryCAPI.xhtml#ga26c8d2435b5cd3c525d5221298ad3aaa)(const char* name, enum [SyscTopology](group__SyscParticipantLibraryCAPI.xhtml#gabf36499a0f333dc9b856c4bcbb25385a) topology);

<a id="l00078" name="l00078"></a> 78 

<a id="l00091" name="l00091"></a>[ 91](group__SyscParticipantLibraryCAPI.xhtml#ga88d428a1852eeec9b7b7156e33b57822)[SyscRegion](structSyscRegion.xhtml) [syscGetRegionDT](group__SyscParticipantLibraryCAPI.xhtml#ga88d428a1852eeec9b7b7156e33b57822)(

<a id="l00092" name="l00092"></a> 92 const char* name,

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

<a id="l00094" name="l00094"></a> 94 enum [SyscTopology](group__SyscParticipantLibraryCAPI.xhtml#gabf36499a0f333dc9b856c4bcbb25385a) topology);

<a id="l00095" name="l00095"></a> 95 

<a id="l00107" name="l00107"></a>[ 107](group__SyscParticipantLibraryCAPI.xhtml#ga9e0af352921275419da93341f7186f46)[SyscRegion](structSyscRegion.xhtml) [syscGetRegionTM](group__SyscParticipantLibraryCAPI.xhtml#ga9e0af352921275419da93341f7186f46)(

<a id="l00108" name="l00108"></a> 108 const char* name,

<a id="l00109" name="l00109"></a> 109 enum [SyscTopology](group__SyscParticipantLibraryCAPI.xhtml#gabf36499a0f333dc9b856c4bcbb25385a) topology,

<a id="l00110" name="l00110"></a> 110 enum [SyscRegionDiscretizationType](group__SyscParticipantLibraryCAPI.xhtml#ga83942e23c7ff51ec76e4632612a34d45) regionDiscretizationType);

<a id="l00111" name="l00111"></a> 111 

<a id="l00123" name="l00123"></a>[ 123](group__SyscParticipantLibraryCAPI.xhtml#gaaae89f288494cc67e8f05cab0f5d1b8b)[SyscRegion](structSyscRegion.xhtml) [syscGetRegionDTM](group__SyscParticipantLibraryCAPI.xhtml#gaaae89f288494cc67e8f05cab0f5d1b8b)(

<a id="l00124" name="l00124"></a> 124 const char* name,

<a id="l00125" name="l00125"></a> 125 const char* displayName,

<a id="l00126" name="l00126"></a> 126 enum [SyscTopology](group__SyscParticipantLibraryCAPI.xhtml#gabf36499a0f333dc9b856c4bcbb25385a) topology,

<a id="l00127" name="l00127"></a> 127 enum [SyscRegionDiscretizationType](group__SyscParticipantLibraryCAPI.xhtml#ga83942e23c7ff51ec76e4632612a34d45) regionDiscretizationType);

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

<a id="l00153" name="l00153"></a>[ 153](group__SyscParticipantLibraryCAPI.xhtml#ga9ae6fafcce6987fa18ba762a1ee7a7be)[SyscError](structSyscError.xhtml) [syscAddInputVariable](group__SyscParticipantLibraryCAPI.xhtml#ga9ae6fafcce6987fa18ba762a1ee7a7be)(

<a id="l00154" name="l00154"></a> 154 const [SyscRegion](structSyscRegion.xhtml) region,

<a id="l00155" name="l00155"></a> 155 const [SyscVariable](structSyscVariable.xhtml) variable);

<a id="l00156" name="l00156"></a> 156 

<a id="l00181" name="l00181"></a>[ 181](group__SyscParticipantLibraryCAPI.xhtml#ga9615f371d829935af745eb63a1ea99bc)[SyscError](structSyscError.xhtml) [syscAddOutputVariable](group__SyscParticipantLibraryCAPI.xhtml#ga9615f371d829935af745eb63a1ea99bc)(

<a id="l00182" name="l00182"></a> 182 const [SyscRegion](structSyscRegion.xhtml) region,

<a id="l00183" name="l00183"></a> 183 const [SyscVariable](structSyscVariable.xhtml) variable);

<a id="l00184" name="l00184"></a> 184 

<a id="l00194" name="l00194"></a>[ 194](group__SyscParticipantLibraryCAPI.xhtml#gabec39110fe9da4d54a32653e6bf43196)size\_t [syscGetNumInputVariables](group__SyscParticipantLibraryCAPI.xhtml#gabec39110fe9da4d54a32653e6bf43196)(const [SyscRegion](structSyscRegion.xhtml) region);

<a id="l00195" name="l00195"></a> 195 

<a id="l00206" name="l00206"></a>[ 206](group__SyscParticipantLibraryCAPI.xhtml#gaef15224138a4f29e892a63e5e8db2feb)[SyscVariable](structSyscVariable.xhtml) [syscGetInputVariable](group__SyscParticipantLibraryCAPI.xhtml#gaef15224138a4f29e892a63e5e8db2feb)(const [SyscRegion](structSyscRegion.xhtml) region, size\_t index);

<a id="l00207" name="l00207"></a> 207 

<a id="l00217" name="l00217"></a>[ 217](group__SyscParticipantLibraryCAPI.xhtml#ga99fda03ac99e590196d180ea23214217)size\_t [syscGetNumOutputVariables](group__SyscParticipantLibraryCAPI.xhtml#ga99fda03ac99e590196d180ea23214217)(const [SyscRegion](structSyscRegion.xhtml) region);

<a id="l00218" name="l00218"></a> 218 

<a id="l00229" name="l00229"></a>[ 229](group__SyscParticipantLibraryCAPI.xhtml#ga55a99079e5dc9d025f3816d5e7bdd163)[SyscVariable](structSyscVariable.xhtml) [syscGetOutputVariable](group__SyscParticipantLibraryCAPI.xhtml#ga55a99079e5dc9d025f3816d5e7bdd163)(const [SyscRegion](structSyscRegion.xhtml) region, size\_t index);

<a id="l00230" name="l00230"></a> 230 

<a id="l00233" name="l00233"></a> 233\#ifdef \_\_cplusplus

<a id="l00234" name="l00234"></a> 234}

<a id="l00235" name="l00235"></a> 235\#endif

[syscGetRegionT](group__SyscParticipantLibraryCAPI.xhtml#ga26c8d2435b5cd3c525d5221298ad3aaa)

SyscRegion syscGetRegionT(const char *name, enum SyscTopology topology)

Create region to be used in a coupled analysis.



[syscGetOutputVariable](group__SyscParticipantLibraryCAPI.xhtml#ga55a99079e5dc9d025f3816d5e7bdd163)

SyscVariable syscGetOutputVariable(const SyscRegion region, size_t index)

Return an output variable.



[SyscRegionDiscretizationType](group__SyscParticipantLibraryCAPI.xhtml#ga83942e23c7ff51ec76e4632612a34d45)

SyscRegionDiscretizationType

Provide an enum for region mesh type.

**Definition** [syscCommonTypes.h:44](syscCommonTypes_8h_source.xhtml#l00044)



[syscGetRegionDT](group__SyscParticipantLibraryCAPI.xhtml#ga88d428a1852eeec9b7b7156e33b57822)

SyscRegion syscGetRegionDT(const char *name, const char *displayName, enum SyscTopology topology)

Create region to be used in a coupled analysis.



[syscAddOutputVariable](group__SyscParticipantLibraryCAPI.xhtml#ga9615f371d829935af745eb63a1ea99bc)

SyscError syscAddOutputVariable(const SyscRegion region, const SyscVariable variable)

Provide a function to add an output variable to the region.



[syscGetNumOutputVariables](group__SyscParticipantLibraryCAPI.xhtml#ga99fda03ac99e590196d180ea23214217)

size_t syscGetNumOutputVariables(const SyscRegion region)

Provide a function to return the number of output variables.



[syscAddInputVariable](group__SyscParticipantLibraryCAPI.xhtml#ga9ae6fafcce6987fa18ba762a1ee7a7be)

SyscError syscAddInputVariable(const SyscRegion region, const SyscVariable variable)

Provide a function to add an input variable to the region.



[syscGetRegionTM](group__SyscParticipantLibraryCAPI.xhtml#ga9e0af352921275419da93341f7186f46)

SyscRegion syscGetRegionTM(const char *name, enum SyscTopology topology, enum SyscRegionDiscretizationType regionDiscretizationType)

Create region to be used in a coupled analysis.



[syscGetRegionDTM](group__SyscParticipantLibraryCAPI.xhtml#gaaae89f288494cc67e8f05cab0f5d1b8b)

SyscRegion syscGetRegionDTM(const char *name, const char *displayName, enum SyscTopology topology, enum SyscRegionDiscretizationType regionDiscretizationType)

Create region to be used in a coupled analysis.



[SYSC\_STRING\_LENGTH](group__SyscParticipantLibraryCAPI.xhtml#gab4cd55b5b37dd76c5755020302086b15)

\#define SYSC_STRING_LENGTH

Define maximum string length.

**Definition** [syscCommonTypes.h:23](syscCommonTypes_8h_source.xhtml#l00023)



[syscGetNumInputVariables](group__SyscParticipantLibraryCAPI.xhtml#gabec39110fe9da4d54a32653e6bf43196)

size_t syscGetNumInputVariables(const SyscRegion region)

Provide a function to return the number of input variables.



[SyscTopology](group__SyscParticipantLibraryCAPI.xhtml#gabf36499a0f333dc9b856c4bcbb25385a)

SyscTopology

Provide an enum for region topologies.

**Definition** [syscCommonTypes.h:38](syscCommonTypes_8h_source.xhtml#l00038)



[syscGetInputVariable](group__SyscParticipantLibraryCAPI.xhtml#gaef15224138a4f29e892a63e5e8db2feb)

SyscVariable syscGetInputVariable(const SyscRegion region, size_t index)

Return an input variable.



[syscGetRegion](group__SyscParticipantLibraryCAPI.xhtml#gaf8dee311cddc012ce6b54998fde8e29f)

SyscRegion syscGetRegion(const char *name)

Create region to be used in a coupled analysis.



[SyscError](structSyscError.xhtml)

Provide a struct for detecting errors from the interface calls.

**Definition** [syscCommonTypes.h:137](syscCommonTypes_8h_source.xhtml#l00137)



[SyscRegion](structSyscRegion.xhtml)

Provide a struct for a System Coupling region.

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



[SyscRegion::topology](structSyscRegion.xhtml#a7fd5681f99d4737e705ef1c670ad6268)

enum SyscTopology topology

**Definition** [syscRegion.h:44](syscRegion_8h_source.xhtml#l00044)



[SyscRegion::name](structSyscRegion.xhtml#a9ad96fdd8a6a46c8d0b4ac7ffb23d7a8)

char name[SYSC_STRING_LENGTH]

**Definition** [syscRegion.h:43](syscRegion_8h_source.xhtml#l00043)



[SyscRegion::regionDiscretizationType](structSyscRegion.xhtml#aba2c044546a908f37b3419408410b3a5)

enum SyscRegionDiscretizationType regionDiscretizationType

**Definition** [syscRegion.h:45](syscRegion_8h_source.xhtml#l00045)



[SyscRegion::displayName](structSyscRegion.xhtml#ac6572b0ff5814075613806b50506d7dd)

char displayName[SYSC_STRING_LENGTH]

**Definition** [syscRegion.h:46](syscRegion_8h_source.xhtml#l00046)



[SyscVariable](structSyscVariable.xhtml)

Provide a struct for a System Coupling variable.

**Definition** [syscVariable.h:37](syscVariable_8h_source.xhtml#l00037)