Variable
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Mechanical.Fields.Variable#
Bases:
object
Represents an object that is either an input or an output for a P:Ansys.ACT.Mechanical.Fields.Variable.Field. Depending on whether it is an input or output and on the way it is defined, this object holds a series of discrete values or an expression that may involve other variables.
Overview#
|
Changes a value at a given position in the tabular definition of the variable. |
|
Changes a value at a given position in the tabular definition of the variable. |
|
Gets the owner field. |
|
Gets a value indicating whether this variable is an input for its container field. Otherwise, it is an output variable. |
|
Gets a value indicating whether this variable is an output for its container field. Otherwise, it is an input variable. |
|
Gets the index of this variable in its container field. |
|
Gets the variable’s name. |
|
Gets the domain of validity for variable’s value. |
|
Gets a value that indicates how this variable is defined. |
|
Gets the number of discrete values of this variable. |
|
Gets or sets the discrete values of this variable or |
|
Returns a Tuple containing the min and max values from the list of discrete values. |
|
Gets or sets the expression that is used to defined this variable, or |
|
Gets the symbol of the unit used to express this variable’s values. |
|
Gets the name of the quantity represented by this variable. |
Property detail#
- property Variable.Field: Ansys.ACT.Mechanical.Fields.Field | None
Gets the owner field.
- property Variable.IsInput: System.Boolean | None
Gets a value indicating whether this variable is an input for its container field. Otherwise, it is an output variable.
- property Variable.IsOutput: System.Boolean | None
Gets a value indicating whether this variable is an output for its container field. Otherwise, it is an input variable.
- property Variable.Index: System.Int32 | None
Gets the index of this variable in its container field.
- property Variable.Name: System.String | None
Gets the variable’s name.
- property Variable.Range: Ansys.ACT.Mechanical.Fields.Range | None
Gets the domain of validity for variable’s value.
- property Variable.DefinitionType: Ansys.ACT.Mechanical.Fields.VariableDefinitionType | None
Gets a value that indicates how this variable is defined.
- property Variable.DiscreteValueCount: System.Int32 | None
Gets the number of discrete values of this variable.
- property Variable.DiscreteValues: System.Collections.Generic.IList[Ansys.Core.Units.Quantity] | None
Gets or sets the discrete values of this variable or
- property Variable.MinMaxDiscreteValues: System.Tuple[Ansys.Core.Units.Quantity, Ansys.Core.Units.Quantity] | None
Returns a Tuple containing the min and max values from the list of discrete values.
- property Variable.Formula: System.String | None
Gets or sets the expression that is used to defined this variable, or
- property Variable.Unit: System.String | None
Gets the symbol of the unit used to express this variable’s values.
- property Variable.QuantityName: System.String | None
Gets the name of the quantity represented by this variable.
Method detail#
- Variable.GetDiscreteValue(index: System.Int32) Ansys.Core.Units.Quantity
Changes a value at a given position in the tabular definition of the variable.
- Variable.SetDiscreteValue(index: System.Int32, value: Ansys.Core.Units.Quantity) System.Void
Changes a value at a given position in the tabular definition of the variable.