Define the parameter’s settings.
Each parameter object has a participant-specified name that System Coupling uses to identify the object. Parameter object names must be unique within the participant, must be in ASCII format, and cannot include forward slashes (/).
Tip: Shown in the GUI as the Coupling Participant | Parameter branch.
Parameter contents:
Parameter's display name as defined in System Coupling.
By default, set to the same value as the parameter's ParticipantDisplayName. The display name may be user-specified.
Parameter display names should be unique. When duplicates exist, System Coupling
appends an integer to the end of the duplicate variable names, beginning with
the second instance. For example, two parameters in the same participant might
be named Current and
Current 2.
Because parameter display names are used in expressions, System Coupling automatically converts spaces to underscores ("_") and removes invalid characters.
Parameter display names are shown in the System Coupling GUI and in user-facing output such as Transcript/Log files, charting output, and EnSight-formatted results.
Tip: Shown in the GUI as the parameter object under the Parameter branch.
Parameters's display name as defined by the participant solver.
Tip: Shown in the GUI as the Coupling Participant | Parameter | Participant Display Name setting.
Parameter's data type as reported by the participant.
The only possible value is Real. The coupling participant is declaring a parameter with a real value.
Tip: Shown in the GUI as the Coupling Participant | Parameter | Data Type setting.
Tensor type of the parameter being transferred.
If the participant does not supply a value for the TensorType setting, then a value is inferred from other information provided by the participant.
The only possible value is Scalar.
Tip: Shown in the GUI as the Coupling Participant | Parameter | Tensor Type setting.
Set the parameter's dimensionality.
Tip: Shown in the GUI as the Coupling Participant | Parameter | Dimensionality branch.
Dimensionality contents:
The parameter's angle.
Accepts real values ≥
0.0. Defaults to 0.0.
Expressions are not supported.
Tip: Shown in the GUI as the Coupling Participant | Parameter | Dimensionality | Angle setting.
The parameter's amount of substance.
Accepts real values ≥
0.0. Defaults to 0.0.
Expressions are not supported.
Tip: Shown in the GUI as the Coupling Participant | Parameter | Dimensionality | Amount Of Substance setting.
The parameter's current.
Accepts real values ≥
0.0. Defaults to 0.0.
Expressions are not supported.
Tip: Shown in the GUI as the Coupling Participant | Parameter | Dimensionality | Current setting.
The parameter's length.
Accepts real values ≥
0.0. Defaults to 0.0.
Expressions are not supported.
Tip: Shown in the GUI as the Coupling Participant | Parameter | Dimensionality | Length setting.
The parameter's luminous intensity value.
Accepts real values ≥
0.0. Defaults to 0.0.
Expressions are not supported.
Tip: Shown in the GUI as the Coupling Participant | Parameter | Dimensionality | Luminous Intensity setting.
The parameter's mass.
Accepts real values ≥
0.0. Defaults to 0.0.
Expressions are not supported.
Tip: Shown in the GUI as the Coupling Participant | Parameter | Dimensionality | Mass setting.
The parameter's temperature.
Accepts real values ≥
0.0. Defaults to 0.0.
Expressions are not supported.
Tip: Shown in the GUI as the Coupling Participant | Parameter | Dimensionality | Temperature setting.