AddInterface()

Given the coupling participant and region names as arguments for each interface side, adds a coupling interface object to the data model.

Requires that you specify participants using their internal object names as described below in Essential Keyword Arguments.

Non-FMU (Functional Mock-up Unit) participants must provide a list of regions as described below in Optional Keyword Arguments. For FMU interfaces, specifying the regions are not allowed.

Returns the name of the coupling interface created.

Cannot be run after participants have started.

For more detailed information on the object created, see CouplingInterface.

Essential Keyword Arguments

SideOneParticipant : string: String indicating the internal object name of the participant to be associated with side One of the interface.
SideTwoParticipant : string: String indicating the internal object name of the participant to be associated with side Two of the interface.

Optional Keyword Arguments

SideOneRegions : string list: List of strings specifying the internal object name(s) of region(s) to be added to side One of the interface. Must be provided if SideOneParticipant is not an FMU.
SideTwoRegions : string list: List of strings specifying the internal object name(s) of region(s) to be added to side Two of the interface. Must be provided if SideOneParticipant is not an FMU.

Return Type

String

Examples

Example 10: Create an interface by specifying participant name and region names for each side of the interface

AddInterface(SideOneParticipant = "MAPDL-1",
                         SideOneRegions = ["FSIN_1"],
                         SideTwoParticipant = "FLUENT-2",
                         SideTwoRegions = ["wall"])

Example 11: Create an interface between an FMU and a non-FMU participant

AddInterface(SideOneParticipant = "MAPDL-1",
                         SideOneRegions = ["FSIN_1"],
                         SideTwoParticipant = "FMU-2")