<Regions>

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

Optional. When no regions are defined, the participant is ignored.

Contains one or more <Region> sub-elements:

 
<Regions>
	<Region>
</Regions> 
 
<Region>

Defines a region that is potentially available for coupled simulations. Nested under <Regions>.

Optional. When no regions are defined, the participant is ignored.

Contains the following sub-elements:

<Regions>
	<Topology>
	<Name>
	<DisplayName>
	<OutputVariables>
	<InputVariables>
</Regions>   
 
<Topology>

Defines the spatial dimensionality of the data being transferred to/from the region.

Required.

Possible values:

  • Surface

  • Volume

<Name>

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

Required.

<DisplayName>

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

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

<OutputVariables>

Container element for the set of output variables for which the region can send data.

Optional. If no output variables are defined, then no data transfers may be created with the region as a source.

Contains one or more <Variable> sub-elements.

<OutputVariables>
	<Variable>
</OutputVariables>
      
<Variable>

Defines an output variable for which the region can send data. Must correspond to the <Name> of a variable defined under the <Variables> element.

Optional. If no output variables are defined, then no data transfers may be created with the region as a source.

<InputVariables>

Container element for the set of input variables for which the region can receive data.

Optional. If no input variables are defined, then no data transfers may be created with the region as a target.

Contains one or more <Variable> sub-elements.

<InputVariables>
	<Variable>
</InputVariables>
      
<Variable>

Defines an input variable for which the region can receive data. Must correspond to the <Name> of a variable defined under the <Variables> element.

Optional. If no input variables are defined, then no data transfers may be created with the region as a target.