## 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 id="pub-methods" name="pub-methods"></a>Public Member Functions

type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function [syscgetvariablef](interfacefortran_1_1syscgetvariablef.xhtml#a8dd21e666858e69c69343a8a1145ceeb) (variablename) Create variable to be used in a coupled analysis.   
 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function [syscgetvariablef\_te](interfacefortran_1_1syscgetvariablef.xhtml#a889fefd03b86f60b08c74a5a28475cf2) (variablename, tensortype, isextensive, location) Create variable to be used in a coupled analysis.   
 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function [syscgetvariablef\_q](interfacefortran_1_1syscgetvariablef.xhtml#a0665e5454c9b7df4205539b6c07476e4) (variablename, displayname, location, quantitytype) Create variable to be used in a coupled analysis.   
 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function [syscgetvariablef\_teq](interfacefortran_1_1syscgetvariablef.xhtml#ae20d858d6873e2c82a6bd385c0f08a13) (variablename, displayname, tensortype, isextensive, location, quantitytype) Create variable to be used in a coupled analysis.   
 type([syscvariablef](structfortran_1_1syscvariablef.xhtml)) function [syscgetvariablef\_dtelqd](interfacefortran_1_1syscgetvariablef.xhtml#ad77ffe80eaeed67dcb5c207189543a80) (variablename, displayname, tensortype, isextensive, location, quantitytype, datatype) Create variable to be used in a coupled analysis.   
 <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="a8dd21e666858e69c69343a8a1145ceeb" name="a8dd21e666858e69c69343a8a1145ceeb"></a>## [◆ ](#a8dd21e666858e69c69343a8a1145ceeb)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).

 65!

 66 import :: syscvariablef

 67 character(len=\*), intent(in) :: variableName

 68 type(SyscVariableF) :: ret

 69!

 70!DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

 71!DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF

 72!DIR$ ENDIF

 73!







## Member Function/Subroutine Documentation

<a id="ad77ffe80eaeed67dcb5c207189543a80" name="ad77ffe80eaeed67dcb5c207189543a80"></a>## [◆ ](#ad77ffe80eaeed67dcb5c207189543a80)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).

 224!

 225import :: syscvariablef

 226character(len=\*), intent(in) :: variableName

 227character(len=\*), intent(in) :: displayName

 228integer(kind=4), intent(in) :: tensorType

 229logical, intent(in) :: isExtensive

 230integer(kind=4), intent(in) :: location

 231integer(kind=4), intent(in) :: quantityType

 232integer(kind=4), intent(in) :: dataType

 233type(SyscVariableF) :: ret

 234!

 235!DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

 236!DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF\_DTELQD

 237!DIR$ ENDIF

 238!







<a id="a0665e5454c9b7df4205539b6c07476e4" name="a0665e5454c9b7df4205539b6c07476e4"></a>## [◆ ](#a0665e5454c9b7df4205539b6c07476e4)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).

 146!

 147 import :: syscvariablef

 148 character(len=\*), intent(in) :: variableName

 149 character(len=\*), intent(in) :: displayName

 150 integer(kind=4), intent(in) :: location

 151 integer(kind=4), intent(in) :: quantityType 

 152 type(SyscVariableF) :: ret

 153!

 154!DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

 155!DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF\_Q

 156!DIR$ ENDIF

 157!







<a id="a889fefd03b86f60b08c74a5a28475cf2" name="a889fefd03b86f60b08c74a5a28475cf2"></a>## [◆ ](#a889fefd03b86f60b08c74a5a28475cf2)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).

 98!

 99 import :: syscvariablef

 100 character(len=\*), intent(in) :: variableName

 101 integer(kind=4), intent(in) :: tensorType

 102 logical, intent(in) :: isExtensive

 103 integer(kind=4), intent(in) :: location

 104 type(SyscVariableF) :: ret

 105!

 106!DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

 107!DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF\_TE

 108!DIR$ ENDIF

 109!







<a id="ae20d858d6873e2c82a6bd385c0f08a13" name="ae20d858d6873e2c82a6bd385c0f08a13"></a>## [◆ ](#ae20d858d6873e2c82a6bd385c0f08a13)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).

 183!

 184 import :: syscvariablef

 185 character(len=\*), intent(in) :: variableName

 186 character(len=\*), intent(in) :: displayName

 187 integer(kind=4), intent(in) :: tensorType

 188 logical, intent(in) :: isExtensive

 189 integer(kind=4), intent(in) :: location

 190 integer(kind=4), intent(in) :: quantityType 

 191 type(SyscVariableF) :: ret

 192!

 193!DIR$ IF DEFINED(\_WIN32) .and. ( .not. DEFINED(SYSTEM\_COUPLING\_PARTICIPANT\_PROXY))

 194!DIR$ ATTRIBUTES DLLIMPORT :: syscGetVariableF\_TEQ

 195!DIR$ ENDIF

 196!