<Transfers>

The <Transfers> element contains details used to define the data transfers between any static and co-simulation coupling participants.

In this element, you can set the Count (an integer representing the total number of data transfers) as an attribute.

For each coupling transfer, the following properties are available:

<Name> (string)

Name of the participant. This is the name with which the participant identifies itself to System Coupling. This corresponds to the Component ID which is unique to a specific system's Solution cell in the Workbench user interface.

<Type> (integer attribute)

Type of coupling participant.

Possible values:

  • 0: Co-simulation

  • 1: Static data

<DisplayName> (wide string)

Display name of the participant, as provided in the Workbench user interface.

<FilePath> (string)

Full path to the primary file used to access source data from a static data participant.

<SupportsCouplingIterations> (Boolean)

Controls whether the co-simulation participant supports the execution of multiple coupling iterations per coupling step.

<UnitSystem>

Unit system used.

<Regions> (options below are applicable to an individual region)

For each region, the following properties are available:

<Name> (string)

Name of the region (intrinsic to the participant).

<DisplayName> (wide string)

Display name of the region, as provided in the Workbench user interface.

<TopologicalDimensionality> (integer)

Geometry type of the region.

Possible values:

  • 2: Surface

  • 3: Volume

<Variables> (options below are applicable to an individual variable)
<Name> (string)

Name of the variable (intrinsic to the participant).

<DisplayName> (wide string)

Display name of the variable, as in the Workbench user interface.

<PhysicalType> (string)

Physical type of the variable. Possible values include:

  • Length

  • Force

<BaseUnits> (strings denoting base units for all data of noted physical type)

Possible values:

  • Angle (string)

  • ChemicalAmount (string)

  • Current (string)

  • Length (string)

  • Luminance (string)

  • Mass (string)

  • SolidAngle (string)

  • Temperature (string)

  • Time (string)