syscgetvariablef Interface Reference
Last update: 17.07.2025Provide an interface to get a System Coupling variable. More...
Public Member Functions | |
| type(syscvariablef) function | syscgetvariablef (variablename) |
| Create variable to be used in a coupled analysis. | |
| type(syscvariablef) function | syscgetvariablef_te (variablename, tensortype, isextensive, location) |
| Create variable to be used in a coupled analysis. | |
| type(syscvariablef) function | syscgetvariablef_q (variablename, displayname, location, quantitytype) |
| Create variable to be used in a coupled analysis. | |
| type(syscvariablef) function | syscgetvariablef_teq (variablename, displayname, tensortype, isextensive, location, quantitytype) |
| Create variable to be used in a coupled analysis. | |
| type(syscvariablef) function | syscgetvariablef_dtelqd (variablename, displayname, tensortype, isextensive, location, quantitytype, datatype) |
| Create variable to be used in a coupled analysis. | |
Detailed Description
Provide an interface to get a System Coupling variable.
Definition at line 44 of file syscVariableF.fi.
Constructor & Destructor Documentation
◆ syscgetvariablef()
| type(syscvariablef) function syscgetvariablef | ( | 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.
- Returns
- a SyscVariableF type
Definition at line 64 of file syscVariableF.fi.
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
◆ syscgetvariablef_dtelqd()
| type(syscvariablef) 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.
- Returns
- a SyscVariableF type
Definition at line 221 of file syscVariableF.fi.
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!
◆ syscgetvariablef_q()
| type(syscvariablef) 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.
- Returns
- a SyscVariableF type
Definition at line 144 of file syscVariableF.fi.
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!
◆ syscgetvariablef_te()
| type(syscvariablef) 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.
- Returns
- a SyscVariableF type
Definition at line 95 of file syscVariableF.fi.
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!
◆ syscgetvariablef_teq()
| type(syscvariablef) 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.
- Returns
- a SyscVariableF type
Definition at line 180 of file syscVariableF.fi.
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!
