## On this page

  

 

 # syscgetvariablef Interface Reference

 Last update: 17.07.2025 

Provide an interface to get a System Coupling variable. [More...](interfacefortran_1_1syscgetvariablef.xhtml#details)

## <a name="pub-methods"></a>Public Member Functions

type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function [syscgetvariablef](interfacefortran_1_1syscgetvariablef.xhtml#a608cb70dd0a2392044f91c81fbfd3935) (variableName) Create variable to be used in a coupled analysis. [More...](interfacefortran_1_1syscgetvariablef.xhtml#a608cb70dd0a2392044f91c81fbfd3935)  
 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function [syscgetvariablef\_te](interfacefortran_1_1syscgetvariablef.xhtml#a500912aab7a473fba9e3b2ef73d0cdc2) (variableName, tensorType, isExtensive, location) Create variable to be used in a coupled analysis. [More...](interfacefortran_1_1syscgetvariablef.xhtml#a500912aab7a473fba9e3b2ef73d0cdc2)  
 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function [syscgetvariablef\_q](interfacefortran_1_1syscgetvariablef.xhtml#aa98302cabc43b69aba1ba8e4c4b25b25) (variableName, displayName, location, quantityType) Create variable to be used in a coupled analysis. [More...](interfacefortran_1_1syscgetvariablef.xhtml#aa98302cabc43b69aba1ba8e4c4b25b25)  
 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function [syscgetvariablef\_teq](interfacefortran_1_1syscgetvariablef.xhtml#a28db29bc33d8fa7aec1ee121dd156485) (variableName, displayName, tensorType, isExtensive, location, quantityType) Create variable to be used in a coupled analysis. [More...](interfacefortran_1_1syscgetvariablef.xhtml#a28db29bc33d8fa7aec1ee121dd156485)  
 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function [syscgetvariablef\_dtelqd](interfacefortran_1_1syscgetvariablef.xhtml#a7ccf1db6c97ad5fbc08fc1a850a48343) (variableName, displayName, tensorType, isExtensive, location, quantityType, dataType) Create variable to be used in a coupled analysis. [More...](interfacefortran_1_1syscgetvariablef.xhtml#a7ccf1db6c97ad5fbc08fc1a850a48343)  
 <a id="details" name="details"></a>## Detailed Description

Provide an interface to get a System Coupling variable.

Definition at line [44](syscVariableF_8fi_source.xhtml#l00044) of file [syscVariableF.fi](syscVariableF_8fi_source.xhtml).



## Constructor &amp; Destructor Documentation

<a id="a608cb70dd0a2392044f91c81fbfd3935"></a>## [◆ ](#a608cb70dd0a2392044f91c81fbfd3935)syscgetvariablef()

 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function [syscgetvariablef](interfacefortran_1_1syscgetvariablef.xhtml)  ( character(len=\*), intent(in)  *variableName*) 

Create variable to be used in a coupled analysis.

Parameters \[in\]variableName- Unique name for this variable. String length should not exceed SyscStrLen.Display name will default to the same as name.

Tensor type will default to scalar.

Is extensive flag will default to false (to non-extensive).

Location will default to nodes.

Quantity type will default to unspecified.

Returnsa SyscVariableF type Definition at line [64](syscVariableF_8fi_source.xhtml#l00064) of file [syscVariableF.fi](syscVariableF_8fi_source.xhtml).

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

<a name="l00066"></a> 66 import :: syscvariablef

<a name="l00067"></a> 67 character(len=\*), intent(in) :: variableName

<a name="l00068"></a> 68 type(SyscVariableF) :: ret

<a name="l00069"></a> 69 !

<a name="l00070"></a> 70 !DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

<a name="l00071"></a> 71 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF

<a name="l00072"></a> 72 !DIR$ ENDIF

<a name="l00073"></a> 73 !







## Member Function/Subroutine Documentation

<a id="a7ccf1db6c97ad5fbc08fc1a850a48343"></a>## [◆ ](#a7ccf1db6c97ad5fbc08fc1a850a48343)syscgetvariablef\_dtelqd()

 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function syscgetvariablef\_dtelqd  ( character(len=\*), intent(in)  *variableName*,    character(len=\*), intent(in)  *displayName*,    integer(kind=4), intent(in)  *tensorType*,    logical, intent(in)  *isExtensive*,    integer(kind=4), intent(in)  *location*,    integer(kind=4), intent(in)  *quantityType*,    integer(kind=4), intent(in)  *dataType*   ) 

Create variable to be used in a coupled analysis.

Parameters \[in\]variableName- Unique name for this variable. String length should not exceed SyscStrLen.\[in\]displayName- variable display name. String length should not exceed SyscStrLen.\[in\]tensorType- variable tensor type.\[in\]isExtensive- flag indicating if it's an extensive property.\[in\]location- variable location (e.g element or node).\[in\]quantityType- variable quantity type.\[in\]dataType- variable data type.Returnsa SyscVariableF type Definition at line [221](syscVariableF_8fi_source.xhtml#l00221) of file [syscVariableF.fi](syscVariableF_8fi_source.xhtml).

<a name="l00224"></a> 224 !

<a name="l00225"></a> 225 import :: syscvariablef

<a name="l00226"></a> 226 character(len=\*), intent(in) :: variableName

<a name="l00227"></a> 227 character(len=\*), intent(in) :: displayName

<a name="l00228"></a> 228 integer(kind=4), intent(in) :: tensorType

<a name="l00229"></a> 229 logical, intent(in) :: isExtensive

<a name="l00230"></a> 230 integer(kind=4), intent(in) :: location

<a name="l00231"></a> 231 integer(kind=4), intent(in) :: quantityType

<a name="l00232"></a> 232 integer(kind=4), intent(in) :: dataType

<a name="l00233"></a> 233 type(SyscVariableF) :: ret

<a name="l00234"></a> 234 !

<a name="l00235"></a> 235 !DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

<a name="l00236"></a> 236 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF\_DTELQD

<a name="l00237"></a> 237 !DIR$ ENDIF

<a name="l00238"></a> 238 !







<a id="aa98302cabc43b69aba1ba8e4c4b25b25"></a>## [◆ ](#aa98302cabc43b69aba1ba8e4c4b25b25)syscgetvariablef\_q()

 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function syscgetvariablef\_q  ( character(len=\*), intent(in)  *variableName*,    character(len=\*), intent(in)  *displayName*,    integer(kind=4), intent(in)  *location*,    integer(kind=4), intent(in)  *quantityType*   ) 

Create variable to be used in a coupled analysis.

Parameters \[in\]variableName- Unique name for this variable. String length should not exceed SyscStrLen.\[in\]displayName- variable display name. String length should not exceed SyscStrLen.\[in\]location- variable location (e.g element or node).\[in\]quantityType- variable quantity type.The variable tensor type and is extensive properties will be inferred from the quantity type, according to the following rules:

quantity Type tensor Type Is extensive

----------------------------------------------------------------

force vector true

incremental displacement vector false

temperature scalar false

heat rate scalar true

heat transfer coefficient scalar false

convection reference temperature scalar false



If any other quantity type is specified, tensor type will be set to scalar and is extensive will be set to false.

Returnsa SyscVariableF type Definition at line [144](syscVariableF_8fi_source.xhtml#l00144) of file [syscVariableF.fi](syscVariableF_8fi_source.xhtml).

<a name="l00146"></a> 146 !

<a name="l00147"></a> 147 import :: syscvariablef

<a name="l00148"></a> 148 character(len=\*), intent(in) :: variableName

<a name="l00149"></a> 149 character(len=\*), intent(in) :: displayName

<a name="l00150"></a> 150 integer(kind=4), intent(in) :: location

<a name="l00151"></a> 151 integer(kind=4), intent(in) :: quantityType 

<a name="l00152"></a> 152 type(SyscVariableF) :: ret

<a name="l00153"></a> 153 !

<a name="l00154"></a> 154 !DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

<a name="l00155"></a> 155 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF\_Q

<a name="l00156"></a> 156 !DIR$ ENDIF

<a name="l00157"></a> 157 !







<a id="a500912aab7a473fba9e3b2ef73d0cdc2"></a>## [◆ ](#a500912aab7a473fba9e3b2ef73d0cdc2)syscgetvariablef\_te()

 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function syscgetvariablef\_te  ( character(len=\*), intent(in)  *variableName*,    integer(kind=4), intent(in)  *tensorType*,    logical, intent(in)  *isExtensive*,    integer(kind=4), intent(in)  *location*   ) 

Create variable to be used in a coupled analysis.

Parameters \[in\]variableName- Unique name for this variable. String length should not exceed SyscStrLen.\[in\]tensorType- variable tensor type.\[in\]isExtensive- flag indicating if it's an extensive property.\[in\]location- variable location (e.g element or node).Display name will default to the same as name.

Quantity type will default to unspecified.

Returnsa SyscVariableF type Definition at line [95](syscVariableF_8fi_source.xhtml#l00095) of file [syscVariableF.fi](syscVariableF_8fi_source.xhtml).

<a name="l00098"></a> 98 !

<a name="l00099"></a> 99 import :: syscvariablef

<a name="l00100"></a> 100 character(len=\*), intent(in) :: variableName

<a name="l00101"></a> 101 integer(kind=4), intent(in) :: tensorType

<a name="l00102"></a> 102 logical, intent(in) :: isExtensive

<a name="l00103"></a> 103 integer(kind=4), intent(in) :: location

<a name="l00104"></a> 104 type(SyscVariableF) :: ret

<a name="l00105"></a> 105 !

<a name="l00106"></a> 106 !DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

<a name="l00107"></a> 107 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF\_TE

<a name="l00108"></a> 108 !DIR$ ENDIF

<a name="l00109"></a> 109 !







<a id="a28db29bc33d8fa7aec1ee121dd156485"></a>## [◆ ](#a28db29bc33d8fa7aec1ee121dd156485)syscgetvariablef\_teq()

 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function syscgetvariablef\_teq  ( character(len=\*), intent(in)  *variableName*,    character(len=\*), intent(in)  *displayName*,    integer(kind=4), intent(in)  *tensorType*,    logical, intent(in)  *isExtensive*,    integer(kind=4), intent(in)  *location*,    integer(kind=4), intent(in)  *quantityType*   ) 

Create variable to be used in a coupled analysis.

Parameters \[in\]variableName- Unique name for this variable. String length should not exceed SyscStrLen.\[in\]displayName- variable display name. String length should not exceed SyscStrLen.\[in\]tensorType- variable tensor type.\[in\]isExtensive- flag indicating if it's an extensive property.\[in\]location- variable location (e.g element or node).\[in\]quantityType- variable quantity type.Returnsa SyscVariableF type Definition at line [180](syscVariableF_8fi_source.xhtml#l00180) of file [syscVariableF.fi](syscVariableF_8fi_source.xhtml).

<a name="l00183"></a> 183 !

<a name="l00184"></a> 184 import :: syscvariablef

<a name="l00185"></a> 185 character(len=\*), intent(in) :: variableName

<a name="l00186"></a> 186 character(len=\*), intent(in) :: displayName

<a name="l00187"></a> 187 integer(kind=4), intent(in) :: tensorType

<a name="l00188"></a> 188 logical, intent(in) :: isExtensive

<a name="l00189"></a> 189 integer(kind=4), intent(in) :: location

<a name="l00190"></a> 190 integer(kind=4), intent(in) :: quantityType 

<a name="l00191"></a> 191 type(SyscVariableF) :: ret

<a name="l00192"></a> 192 !

<a name="l00193"></a> 193 !DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

<a name="l00194"></a> 194 !DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF\_TEQ

<a name="l00195"></a> 195 !DIR$ ENDIF

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