variable_child

class ansys.systemcoupling.core.adaptor.api_25_2.variable_child.variable_child(name=None, parent=None)

Bases: Container

Configure a variable for the coupling participant.

Properties

quantity_typestr

Quantity type of the variable.

Allowed values:

• “Unspecified”

• “Force”

• “Incremental Displacement”

• “Temperature”

• “Heat Rate”

• “Heat Transfer Coefficient”

• “Convection Reference Temperature”

• “Mode Shape”

• “Electrical Conductivity”

locationstr

Data location of the variable (“Node” or “Element”).

participant_display_namestr

Variable’s display name as defined by the participant solver.

display_namestr

Variable’s display name as defined in System Coupling.

data_typestr

Variable’s data type as reported by the participant.

Allowed values (non-FMU case):

• Real

• Complex

Allowed values (FMU):

• Real

• Integer

• Logical

• String

• Enumeration

real_initial_valueRealType

Real data start value.

integer_initial_valueint

Integer data start value.

logical_initial_valuebool

Logical data start value.

string_initial_valuestr

String data start value.

enumeration_initial_valueint

Enumeration data start value.

real_minRealType

Real data minimum value.

real_maxRealType

Real data maximum value.

integer_minint

Integer data minimum value.

integer_maxint

Integer data maximum value.

enumeration_minint

Enumeration data minimum value.

enumeration_maxint

Enumeration data maximum value.

tensor_typestr

Indicates the variable tensor type (“Scalar” or “Vector”).

“Vector” is not supported for the FMU case.

is_extensivebool

Indicates whether this is an extensive property.

Children

Child	Summary
attribute	Configure an attribute.

Included in:

Parent	Summary
variable	Configure a variable for the coupling participant.