## On this page

  

 

 # syscVariable

 Last update: 17.07.2025 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<a name="l00037"></a>[ 37](structSyscVariable.xhtml) typedef struct [SyscVariable](structSyscVariable.xhtml) {

<a name="l00038"></a>[ 38](structSyscVariable.xhtml#ac986a066454132f9f70180349586ab8b) char [name](structSyscVariable.xhtml#a2eba6c9ae1b937d16229bb14abfd0b8c)[[SYSC\_STRING\_LENGTH](group__SyscParticipantLibraryCAPI.xhtml#gab4cd55b5b37dd76c5755020302086b15)]; 

<a name="l00039"></a> 39 enum [SyscQuantityType](group__SyscParticipantLibraryCAPI.xhtml#gaa28a3de6c7c91003a8a15721a5301f12) [quantityType](structSyscVariable.xhtml#ac986a066454132f9f70180349586ab8b); 

<a name="l00040"></a> 40 enum [SyscLocation](group__SyscParticipantLibraryCAPI.xhtml#gade42aba1a68acbbf5956edcd388cdcda) [location](structSyscVariable.xhtml#a417605c130a691478393fbb05840a5ab); 

<a name="l00041"></a>[ 41](structSyscVariable.xhtml#a0293955653368e2f48d36587d4d90ca8) char [displayName](structSyscVariable.xhtml#a04451c3da4978114e5aba6bcf2713731)[[SYSC\_STRING\_LENGTH](group__SyscParticipantLibraryCAPI.xhtml#gab4cd55b5b37dd76c5755020302086b15)]; 

<a name="l00042"></a> 42 enum [SyscTensorType](group__SyscParticipantLibraryCAPI.xhtml#ga007e2fd66e7263a63c114a6d12b3808d) [tensorType](structSyscVariable.xhtml#a0293955653368e2f48d36587d4d90ca8); 

<a name="l00043"></a>[ 43](structSyscVariable.xhtml#aed5ddca8dd956e1b4935aa69c323e011) int [isExtensive](structSyscVariable.xhtml#aed5ddca8dd956e1b4935aa69c323e011); 

<a name="l00044"></a> 44 enum SyscDataType [dataType](structSyscVariable.xhtml#aedd58bab04a4c0036cd07cef9016a91c); 

<a name="l00045"></a>[ 45](group__SyscParticipantLibraryCAPI.xhtml#ga7a8d294476240d2f3844a608e71efe29) } [SyscVariable](group__SyscParticipantLibraryCAPI.xhtml#ga7a8d294476240d2f3844a608e71efe29);

<a name="l00046"></a> 46 

<a name="l00063"></a>[ 63](group__SyscParticipantLibraryCAPI.xhtml#ga11cda8cc3f7f76d71b87baabbfe53304) [SyscVariable](structSyscVariable.xhtml) [syscGetVariable](group__SyscParticipantLibraryCAPI.xhtml#ga11cda8cc3f7f76d71b87baabbfe53304)(

<a name="l00064"></a> 64 const char* name);

<a name="l00065"></a> 65 

<a name="l00085"></a>[ 85](group__SyscParticipantLibraryCAPI.xhtml#ga41420b43584d7b7ab11d94c2c4e4ccdb) [SyscVariable](structSyscVariable.xhtml) [syscGetVariableDTELQD](group__SyscParticipantLibraryCAPI.xhtml#ga41420b43584d7b7ab11d94c2c4e4ccdb)(

<a name="l00086"></a> 86 const char* name,

<a name="l00087"></a> 87 const char* displayName,

<a name="l00088"></a> 88 enum [SyscTensorType](group__SyscParticipantLibraryCAPI.xhtml#ga007e2fd66e7263a63c114a6d12b3808d) tensorType,

<a name="l00089"></a> 89 int isExtensive,

<a name="l00090"></a> 90 enum [SyscLocation](group__SyscParticipantLibraryCAPI.xhtml#gade42aba1a68acbbf5956edcd388cdcda) location,

<a name="l00091"></a> 91 enum [SyscQuantityType](group__SyscParticipantLibraryCAPI.xhtml#gaa28a3de6c7c91003a8a15721a5301f12) quantityType,

<a name="l00092"></a> 92 enum SyscDataType dataType);

<a name="l00093"></a> 93 

<a name="l00107"></a>[ 107](group__SyscParticipantLibraryCAPI.xhtml#ga3aceb66e0d37a5de11b76fd4c1d7293d) [SyscVariable](structSyscVariable.xhtml) [syscGetVariableTE](group__SyscParticipantLibraryCAPI.xhtml#ga3aceb66e0d37a5de11b76fd4c1d7293d)(

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

<a name="l00109"></a> 109 enum [SyscTensorType](group__SyscParticipantLibraryCAPI.xhtml#ga007e2fd66e7263a63c114a6d12b3808d) tensorType,

<a name="l00110"></a> 110 int isExtensive,

<a name="l00111"></a> 111 enum [SyscLocation](group__SyscParticipantLibraryCAPI.xhtml#gade42aba1a68acbbf5956edcd388cdcda) location);

<a name="l00112"></a> 112 

<a name="l00125"></a>[ 125](group__SyscParticipantLibraryCAPI.xhtml#ga8c3a0f01eb353ffcb981281a76dde4b3) [SyscVariable](structSyscVariable.xhtml) [syscGetVariableTEQ](group__SyscParticipantLibraryCAPI.xhtml#ga8c3a0f01eb353ffcb981281a76dde4b3)(

<a name="l00126"></a> 126 const char* name,

<a name="l00127"></a> 127 const char* displayName,

<a name="l00128"></a> 128 enum [SyscTensorType](group__SyscParticipantLibraryCAPI.xhtml#ga007e2fd66e7263a63c114a6d12b3808d) tensorType,

<a name="l00129"></a> 129 int isExtensive,

<a name="l00130"></a> 130 enum [SyscLocation](group__SyscParticipantLibraryCAPI.xhtml#gade42aba1a68acbbf5956edcd388cdcda) location,

<a name="l00131"></a> 131 enum [SyscQuantityType](group__SyscParticipantLibraryCAPI.xhtml#gaa28a3de6c7c91003a8a15721a5301f12) quantityType);

<a name="l00132"></a> 132 

<a name="l00160"></a>[ 160](group__SyscParticipantLibraryCAPI.xhtml#gabcbdf21641e68a17e941a6c8da2afdc9) [SyscVariable](structSyscVariable.xhtml) [syscGetVariableQ](group__SyscParticipantLibraryCAPI.xhtml#gabcbdf21641e68a17e941a6c8da2afdc9)(

<a name="l00161"></a> 161 const char* name,

<a name="l00162"></a> 162 const char* displayName,

<a name="l00163"></a> 163 enum [SyscLocation](group__SyscParticipantLibraryCAPI.xhtml#gade42aba1a68acbbf5956edcd388cdcda) location,

<a name="l00164"></a> 164 enum [SyscQuantityType](group__SyscParticipantLibraryCAPI.xhtml#gaa28a3de6c7c91003a8a15721a5301f12) quantityType);

<a name="l00165"></a> 165 

<a name="l00168"></a>[ 168](group__SyscParticipantLibraryCAPI.xhtml#ga36e1b9748fe759040360468c2b863753) [SyscError](structSyscError.xhtml) [syscVariableAddRealAttribute](group__SyscParticipantLibraryCAPI.xhtml#ga36e1b9748fe759040360468c2b863753)(

<a name="l00169"></a> 169 [SyscVariable](structSyscVariable.xhtml) variable,

<a name="l00170"></a> 170 [SyscRealAttribute](structSyscRealAttribute.xhtml) attribute);

<a name="l00171"></a> 171 

<a name="l00174"></a>[ 174](group__SyscParticipantLibraryCAPI.xhtml#ga2c8d8b670d660f646fbe0d81dbc7914b) [SyscError](structSyscError.xhtml) [syscVariableAddIntegerAttribute](group__SyscParticipantLibraryCAPI.xhtml#ga2c8d8b670d660f646fbe0d81dbc7914b)(

<a name="l00175"></a> 175 [SyscVariable](structSyscVariable.xhtml) variable,

<a name="l00176"></a> 176 [SyscIntegerAttribute](structSyscIntegerAttribute.xhtml) attribute);

<a name="l00177"></a> 177 

<a name="l00180"></a>[ 180](group__SyscParticipantLibraryCAPI.xhtml#ga3cb95d52ef66ec8339bff5dc9c2c28bb) size\_t [syscVariableGetNumRealAttributes](group__SyscParticipantLibraryCAPI.xhtml#ga3cb95d52ef66ec8339bff5dc9c2c28bb)([SyscVariable](structSyscVariable.xhtml) variable);

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

<a name="l00184"></a>[ 184](group__SyscParticipantLibraryCAPI.xhtml#gae744a1029ca1d356c8ef9a81b6a41df6) size\_t [syscVariableGetNumIntegerAttributes](group__SyscParticipantLibraryCAPI.xhtml#gae744a1029ca1d356c8ef9a81b6a41df6)([SyscVariable](structSyscVariable.xhtml) variable);

<a name="l00185"></a> 185 

<a name="l00188"></a>[ 188](group__SyscParticipantLibraryCAPI.xhtml#ga7d8fce6af6169d53f48e92cb90224bff) [SyscRealAttribute](structSyscRealAttribute.xhtml) [syscVariableGetRealAttribute](group__SyscParticipantLibraryCAPI.xhtml#ga7d8fce6af6169d53f48e92cb90224bff)(

<a name="l00189"></a> 189 [SyscVariable](structSyscVariable.xhtml) variable,

<a name="l00190"></a> 190 size\_t index);

<a name="l00191"></a> 191 

<a name="l00194"></a>[ 194](group__SyscParticipantLibraryCAPI.xhtml#gacd6d89e8e016b12cf558b312619201a4) [SyscIntegerAttribute](structSyscIntegerAttribute.xhtml) [syscVariableGetIntegerAttribute](group__SyscParticipantLibraryCAPI.xhtml#gacd6d89e8e016b12cf558b312619201a4)(

<a name="l00195"></a> 195 [SyscVariable](structSyscVariable.xhtml) variable,

<a name="l00196"></a> 196 size\_t index);

<a name="l00197"></a> 197 

<a name="l00200"></a> 200 \#ifdef \_\_cplusplus

<a name="l00201"></a> 201 }

<a name="l00202"></a> 202 \#endif

[SyscTensorType](group__SyscParticipantLibraryCAPI.xhtml#ga007e2fd66e7263a63c114a6d12b3808d)

SyscTensorType

Provide an enum for variable tensor type.

**Definition:** [syscCommonTypes.h:32](syscCommonTypes_8h_source.xhtml#l00032)



[syscGetVariable](group__SyscParticipantLibraryCAPI.xhtml#ga11cda8cc3f7f76d71b87baabbfe53304)

SyscVariable syscGetVariable(const char *name)

Create variable to be used in a coupled analysis.



[syscVariableAddIntegerAttribute](group__SyscParticipantLibraryCAPI.xhtml#ga2c8d8b670d660f646fbe0d81dbc7914b)

SyscError syscVariableAddIntegerAttribute(SyscVariable variable, SyscIntegerAttribute attribute)

Add integer-valued attribute to the variable.



[syscVariableAddRealAttribute](group__SyscParticipantLibraryCAPI.xhtml#ga36e1b9748fe759040360468c2b863753)

SyscError syscVariableAddRealAttribute(SyscVariable variable, SyscRealAttribute attribute)

Add real-valued attribute to the variable.



[syscGetVariableTE](group__SyscParticipantLibraryCAPI.xhtml#ga3aceb66e0d37a5de11b76fd4c1d7293d)

SyscVariable syscGetVariableTE(const char *name, enum SyscTensorType tensorType, int isExtensive, enum SyscLocation location)

Create variable to be used in a coupled analysis.



[syscVariableGetNumRealAttributes](group__SyscParticipantLibraryCAPI.xhtml#ga3cb95d52ef66ec8339bff5dc9c2c28bb)

size_t syscVariableGetNumRealAttributes(SyscVariable variable)

Get number of real-valued attributes.



[syscGetVariableDTELQD](group__SyscParticipantLibraryCAPI.xhtml#ga41420b43584d7b7ab11d94c2c4e4ccdb)

SyscVariable syscGetVariableDTELQD(const char *name, const char *displayName, enum SyscTensorType tensorType, int isExtensive, enum SyscLocation location, enum SyscQuantityType quantityType, enum SyscDataType dataType)

Create variable to be used in a coupled analysis.



[SyscVariable](group__SyscParticipantLibraryCAPI.xhtml#ga7a8d294476240d2f3844a608e71efe29)

struct SyscVariable SyscVariable

Provide a struct for a System Coupling variable.



[syscVariableGetRealAttribute](group__SyscParticipantLibraryCAPI.xhtml#ga7d8fce6af6169d53f48e92cb90224bff)

SyscRealAttribute syscVariableGetRealAttribute(SyscVariable variable, size_t index)

Return the real-valued attribute at the given index.



[syscGetVariableTEQ](group__SyscParticipantLibraryCAPI.xhtml#ga8c3a0f01eb353ffcb981281a76dde4b3)

SyscVariable syscGetVariableTEQ(const char *name, const char *displayName, enum SyscTensorType tensorType, int isExtensive, enum SyscLocation location, enum SyscQuantityType quantityType)

Create variable to be used in a coupled analysis.



[SyscQuantityType](group__SyscParticipantLibraryCAPI.xhtml#gaa28a3de6c7c91003a8a15721a5301f12)

SyscQuantityType

Provide an enum for supported quantity types.

**Definition:** [syscCommonTypes.h:91](syscCommonTypes_8h_source.xhtml#l00091)



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

\#define SYSC_STRING_LENGTH

Define maximum string length.

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



[syscGetVariableQ](group__SyscParticipantLibraryCAPI.xhtml#gabcbdf21641e68a17e941a6c8da2afdc9)

SyscVariable syscGetVariableQ(const char *name, const char *displayName, enum SyscLocation location, enum SyscQuantityType quantityType)

Create variable to be used in a coupled analysis.



[syscVariableGetIntegerAttribute](group__SyscParticipantLibraryCAPI.xhtml#gacd6d89e8e016b12cf558b312619201a4)

SyscIntegerAttribute syscVariableGetIntegerAttribute(SyscVariable variable, size_t index)

Return the integer-valued attribute at the given index.



[SyscLocation](group__SyscParticipantLibraryCAPI.xhtml#gade42aba1a68acbbf5956edcd388cdcda)

SyscLocation

Provide an enum for variable mesh locations.

**Definition:** [syscCommonTypes.h:26](syscCommonTypes_8h_source.xhtml#l00026)



[syscVariableGetNumIntegerAttributes](group__SyscParticipantLibraryCAPI.xhtml#gae744a1029ca1d356c8ef9a81b6a41df6)

size_t syscVariableGetNumIntegerAttributes(SyscVariable variable)

Get number of integer-valued attributes.



[SyscError](structSyscError.xhtml)

Provide a struct for detecting errors from the interface calls.

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



[SyscIntegerAttribute](structSyscIntegerAttribute.xhtml)

Provide a struct for an integer-valued attribute.

**Definition:** [syscAttribute.h:70](syscAttribute_8h_source.xhtml#l00070)



[SyscRealAttribute](structSyscRealAttribute.xhtml)

Provide a struct for a real-valued attribute.

**Definition:** [syscAttribute.h:24](syscAttribute_8h_source.xhtml#l00024)



[SyscVariable](structSyscVariable.xhtml)

Provide a struct for a System Coupling variable.

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



[SyscVariable::tensorType](structSyscVariable.xhtml#a0293955653368e2f48d36587d4d90ca8)

enum SyscTensorType tensorType

**Definition:** [syscVariable.h:42](syscVariable_8h_source.xhtml#l00041)



[SyscVariable::displayName](structSyscVariable.xhtml#a04451c3da4978114e5aba6bcf2713731)

char displayName[SYSC_STRING_LENGTH]

**Definition:** [syscVariable.h:41](syscVariable_8h_source.xhtml#l00041)



[SyscVariable::name](structSyscVariable.xhtml#a2eba6c9ae1b937d16229bb14abfd0b8c)

char name[SYSC_STRING_LENGTH]

**Definition:** [syscVariable.h:38](syscVariable_8h_source.xhtml#l00038)



[SyscVariable::location](structSyscVariable.xhtml#a417605c130a691478393fbb05840a5ab)

enum SyscLocation location

**Definition:** [syscVariable.h:40](syscVariable_8h_source.xhtml#l00038)



[SyscVariable::quantityType](structSyscVariable.xhtml#ac986a066454132f9f70180349586ab8b)

enum SyscQuantityType quantityType

**Definition:** [syscVariable.h:39](syscVariable_8h_source.xhtml#l00038)



[SyscVariable::isExtensive](structSyscVariable.xhtml#aed5ddca8dd956e1b4935aa69c323e011)

int isExtensive

**Definition:** [syscVariable.h:43](syscVariable_8h_source.xhtml#l00043)



[SyscVariable::dataType](structSyscVariable.xhtml#aedd58bab04a4c0036cd07cef9016a91c)

enum SyscDataType dataType

**Definition:** [syscVariable.h:44](syscVariable_8h_source.xhtml#l00043)