## On this page

  

 

 # SyscVariable Struct Reference

 Last update: 17.07.2025 

Provide a struct for a System Coupling variable. [More...](structSyscVariable.xhtml#details)

`#include <<a class="el" href="syscVariable_8h_source.xhtml">syscVariable.h</a>>`

## <a name="pub-attribs"></a>Data Fields

char [name](structSyscVariable.xhtml#a2eba6c9ae1b937d16229bb14abfd0b8c) \[[SYSC\_STRING\_LENGTH](group__SyscParticipantLibraryCAPI.xhtml#gab4cd55b5b37dd76c5755020302086b15)\] enum [SyscQuantityType](group__SyscParticipantLibraryCAPI.xhtml#gaa28a3de6c7c91003a8a15721a5301f12) [quantityType](structSyscVariable.xhtml#ac986a066454132f9f70180349586ab8b) enum [SyscLocation](group__SyscParticipantLibraryCAPI.xhtml#gade42aba1a68acbbf5956edcd388cdcda) [location](structSyscVariable.xhtml#a417605c130a691478393fbb05840a5ab) char [displayName](structSyscVariable.xhtml#a04451c3da4978114e5aba6bcf2713731) \[[SYSC\_STRING\_LENGTH](group__SyscParticipantLibraryCAPI.xhtml#gab4cd55b5b37dd76c5755020302086b15)\] enum [SyscTensorType](group__SyscParticipantLibraryCAPI.xhtml#ga007e2fd66e7263a63c114a6d12b3808d) [tensorType](structSyscVariable.xhtml#a0293955653368e2f48d36587d4d90ca8) int [isExtensive](structSyscVariable.xhtml#aed5ddca8dd956e1b4935aa69c323e011) enum SyscDataType [dataType](structSyscVariable.xhtml#aedd58bab04a4c0036cd07cef9016a91c) <a id="details" name="details"></a>## Detailed Description

Provide a struct for a System Coupling variable.

To create and/or initialize the [SyscVariable](structSyscVariable.xhtml "Provide a struct for a System Coupling variable.") struct, it is highly recommended to use one of the functions with names starting with `syscGetVariable`. These functions will initialize all members to the correct values and will help to avoid back-compatibility issues in the future. For example:

[SyscVariable](structSyscVariable.xhtml) var = [syscGetVariableTE](group__SyscParticipantLibraryCAPI.xhtml#ga3aceb66e0d37a5de11b76fd4c1d7293d)(

 "Temperature", [SyscScalar](group__SyscParticipantLibraryCAPI.xhtml#gga007e2fd66e7263a63c114a6d12b3808dacb8fa2f95d3959accf13d5f9da32bec2), 0, [SyscNode](group__SyscParticipantLibraryCAPI.xhtml#ggade42aba1a68acbbf5956edcd388cdcdaae4692f269a846a3f5bec23a9e61f0b8b));

[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.



[SyscScalar](group__SyscParticipantLibraryCAPI.xhtml#gga007e2fd66e7263a63c114a6d12b3808dacb8fa2f95d3959accf13d5f9da32bec2)

@ SyscScalar

**Definition:** [syscCommonTypes.h:33](syscCommonTypes_8h_source.xhtml#l00033)



[SyscNode](group__SyscParticipantLibraryCAPI.xhtml#ggade42aba1a68acbbf5956edcd388cdcdaae4692f269a846a3f5bec23a9e61f0b8b)

@ SyscNode

**Definition:** [syscCommonTypes.h:27](syscCommonTypes_8h_source.xhtml#l00027)



[SyscVariable](structSyscVariable.xhtml)

Provide a struct for a System Coupling variable.

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





Definition at line [37](syscVariable_8h_source.xhtml#l00037) of file [syscVariable.h](syscVariable_8h_source.xhtml).



## Field Documentation

<a id="aedd58bab04a4c0036cd07cef9016a91c"></a>## [◆ ](#aedd58bab04a4c0036cd07cef9016a91c)dataType

 enum SyscDataType SyscVariable::dataType

Variable data type.

Definition at line [43](syscVariable_8h_source.xhtml#l00043) of file [syscVariable.h](syscVariable_8h_source.xhtml).





<a id="a04451c3da4978114e5aba6bcf2713731"></a>## [◆ ](#a04451c3da4978114e5aba6bcf2713731)displayName

 char SyscVariable::displayName\[[SYSC\_STRING\_LENGTH](group__SyscParticipantLibraryCAPI.xhtml#gab4cd55b5b37dd76c5755020302086b15)\]

User-friendly name.

Definition at line [41](syscVariable_8h_source.xhtml#l00041) of file [syscVariable.h](syscVariable_8h_source.xhtml).





<a id="aed5ddca8dd956e1b4935aa69c323e011"></a>## [◆ ](#aed5ddca8dd956e1b4935aa69c323e011)isExtensive

 int SyscVariable::isExtensive

Flag indicating whether it's an extensive property.

Definition at line [43](syscVariable_8h_source.xhtml#l00043) of file [syscVariable.h](syscVariable_8h_source.xhtml).





<a id="a417605c130a691478393fbb05840a5ab"></a>## [◆ ](#a417605c130a691478393fbb05840a5ab)location

 enum [SyscLocation](group__SyscParticipantLibraryCAPI.xhtml#gade42aba1a68acbbf5956edcd388cdcda) SyscVariable::location

Location (e.g element or node).

Definition at line [38](syscVariable_8h_source.xhtml#l00038) of file [syscVariable.h](syscVariable_8h_source.xhtml).





<a id="a2eba6c9ae1b937d16229bb14abfd0b8c"></a>## [◆ ](#a2eba6c9ae1b937d16229bb14abfd0b8c)name

 char SyscVariable::name\[[SYSC\_STRING\_LENGTH](group__SyscParticipantLibraryCAPI.xhtml#gab4cd55b5b37dd76c5755020302086b15)\]

Unique name for this variable.

Definition at line [38](syscVariable_8h_source.xhtml#l00038) of file [syscVariable.h](syscVariable_8h_source.xhtml).





<a id="ac986a066454132f9f70180349586ab8b"></a>## [◆ ](#ac986a066454132f9f70180349586ab8b)quantityType

 enum [SyscQuantityType](group__SyscParticipantLibraryCAPI.xhtml#gaa28a3de6c7c91003a8a15721a5301f12) SyscVariable::quantityType

Quantity type (e.g. temperature).

Definition at line [38](syscVariable_8h_source.xhtml#l00038) of file [syscVariable.h](syscVariable_8h_source.xhtml).





<a id="a0293955653368e2f48d36587d4d90ca8"></a>## [◆ ](#a0293955653368e2f48d36587d4d90ca8)tensorType

 enum [SyscTensorType](group__SyscParticipantLibraryCAPI.xhtml#ga007e2fd66e7263a63c114a6d12b3808d) SyscVariable::tensorType

Tensor type (e.g. scalar, vector).

Definition at line [41](syscVariable_8h_source.xhtml#l00041) of file [syscVariable.h](syscVariable_8h_source.xhtml).