<CosimulationControl>

Container element for settings that control how the participant can act in a co-simulation. Provides the information necessary to set up couplings and to execute the participant in the co-simulation.

Required.

Contains the following sub-elements:

 
<CosimulationControl>
	<Type/>
	<Dimension/>
	<AnalysisType/>
	<DisplayName/>
	<RestartsSupported/>
	<Variables/>
	<Regions/>
</CosimulationControl>
 
<Type>

Specifies the type of participant.

Optional. When not specified, the DEFAULT type is used.

Possible values:

  • DEFAULT (default value)

  • AEDT

  • CFX

  • FLUENT

  • MAPDL

 
<Dimension>

Specifies the dimension of the participant.

Optional.

Possible values:

  • 3D (default value)

  • 2D

 
<AnalysisType>

Specifies the type of analysis the participant is running.

Optional. If not specified, defaults to Steady.

Possible values:

  • Steady (default value)

  • Transient

 
<DisplayName>

Specifies the participant name to be displayed in user-facing communications.

Optional. When not specified, the name of the participant object in the data model is used.

 
<RestartsSupported>

Indicates whether the participant supports restarts for this type of coupled analysis.

If any participant in a coupled analysis does not support restarts, then restarts are disabled for the analysis as whole. A participant's restart capabilities may vary according to the type of analysis being performed.

Optional. If not specified, either in the participant's coupling .scp file or in the data model, then the default value is determined by the participant's <ParticipantType> value, as described below:

Possible values:

  • False: Indicates that the participant does not support restarts.

    If not specified, then this is the default value for participants of type FORTE or DEFAULT.

  • True: Indicates that the participant supports restarts.

    If not specified, then this is the default value for participants not of type FORTE or DEFAULT.

 
<Variables>

Container element for the set of variables that are available for coupled simulations.

Optional. If no output/input variables are defined, then the participant is ignored.

Contains one or more <Variable> sub-elements:

  
<Variables>
	<Variable>
</Variables>
 
<Variable>

Defines a variable that is available for coupled simulations. Nested under <Variables>.

Optional. If no output/input variables are defined, then the participant is ignored.

Contains the following sub-elements:

 
<Variable>
	<Name>
	<DisplayName>
	<QuantityType>
	<TensorType>
	<IsExtenstive>
	<Location>
</Variable>
 
<Name>

Specifies the variable name to be used internally by System Coupling and the participant.

Required.

 
<DisplayName>

Specifies the variable name to be displayed in user-facing communications.

Optional. If not specified, the variable's data model <Name> is used.

 
<QuantityType>

Indicates the quantity type of the data provided by the variable.

Required when values are not specified for the variable's <TensorType> and/or <IsExtensive> elements.

Otherwise, optional. If a quantity type is not available (that is, either the <QuantityType> element is left blank or set to Unspecified), then:

  • Values for the <TensorType> and/or <IsExtensive> elements are required.

  • Any variables with the same <TensorType> can be coupled.

Possible values:

  • Unspecified

  • Convection Reference Temperature

  • Force

  • Incremental Displacement

  • Heat Rate

  • Heat Transfer Coefficient

  • Temperature

 
<TensorType>

Indicates the tensor type of the variable being transferred.

Required when the <QuantityType> is not available (that is, either the <QuantityType> element is left blank or set to Unspecified).

Otherwise, optional. If a value is not specified for the <TensorType> element, then System Coupling infers this value, either from the variable's <Name> (for MAPDL participants) or from its <QuantityType> (for all other participant types).

Possible values:

  • Scalar

  • Vector

 
<IsExtensive>

Indicates whether the variable is extensive. A property is extensive if its value depends on the size of the system.

Not available for FMU participants.

Required when the <QuantityType> is not available (that is, either the <QuantityType> element is left blank or set to Unspecified).

Otherwise, optional. If a value is not specified for the <IsExtensive> element, then System Coupling infers this value, either from the variable's <Name> (for MAPDL participants) or from its <QuantityType> (for all other participant types).

Possible values:

  • True: The variable is extensive.

  • False: The variable is intensive.

 
<Location>

Defines the mesh location on which data exists.

Optional. If not specified, defaults to Node.

Possible values:

  • Element

  • Node (default value)