Interface fortran::syscgetvariablef

Definition: syscVariableF.fi (line 44)

Provide an interface to get a System Coupling variable.

Members

• syscgetvariablef
• syscgetvariablef_dtelqd
• syscgetvariablef_q
• syscgetvariablef_te
• syscgetvariablef_teq

Public functions

Function syscgetvariablef

type(syscvariablef) function syscgetvariablef(variableName)

Create variable to be used in a coupled analysis.

Parameters:

• 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

Parameters:

• variableNamevariableName

Return type: type(syscvariablef) function

Function syscgetvariablef_te

type(syscvariablef) function syscgetvariablef_te(variableName, tensorType, isExtensive, location)

Create variable to be used in a coupled analysis.

Parameters:

• variableName: - Unique name for this variable. String length should not exceed SyscStrLen.
• tensorType: - variable tensor type.
• isExtensive: - flag indicating if it's an extensive property.
• 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

Parameters:

• variableNamevariableName
• tensorTypetensorType
• isExtensiveisExtensive
• locationlocation

Return type: type(syscvariablef) function

Function syscgetvariablef_q

type(syscvariablef) function syscgetvariablef_q(variableName, displayName, location, quantityType)

Create variable to be used in a coupled analysis.

Parameters:

• variableName: - Unique name for this variable. String length should not exceed SyscStrLen.
• displayName: - variable display name. String length should not exceed SyscStrLen.
• location: - variable location (e.g element or node).
• 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

Parameters:

• variableNamevariableName
• displayNamedisplayName
• locationlocation
• quantityTypequantityType

Return type: type(syscvariablef) function

Function syscgetvariablef_teq

type(syscvariablef) function syscgetvariablef_teq(variableName, displayName, tensorType, isExtensive, location, quantityType)

Create variable to be used in a coupled analysis.

Parameters:

• variableName: - Unique name for this variable. String length should not exceed SyscStrLen.
• displayName: - variable display name. String length should not exceed SyscStrLen.
• tensorType: - variable tensor type.
• isExtensive: - flag indicating if it's an extensive property.
• location: - variable location (e.g element or node).
• quantityType: - variable quantity type.

Returns:

a SyscVariableF type

Parameters:

• variableNamevariableName
• displayNamedisplayName
• tensorTypetensorType
• isExtensiveisExtensive
• locationlocation
• quantityTypequantityType

Return type: type(syscvariablef) function

Function syscgetvariablef_dtelqd

type(syscvariablef) function syscgetvariablef_dtelqd(variableName, displayName, tensorType, isExtensive, location, quantityType, dataType)

Create variable to be used in a coupled analysis.

Parameters:

• variableName: - Unique name for this variable. String length should not exceed SyscStrLen.
• displayName: - variable display name. String length should not exceed SyscStrLen.
• tensorType: - variable tensor type.
• isExtensive: - flag indicating if it's an extensive property.
• location: - variable location (e.g element or node).
• quantityType: - variable quantity type.
• dataType: - variable data type.

Returns:

a SyscVariableF type

Parameters:

• variableNamevariableName
• displayNamedisplayName
• tensorTypetensorType
• isExtensiveisExtensive
• locationlocation
• quantityTypequantityType
• dataTypedataType

Return type: type(syscvariablef) function