add_interface_by_display_names

class ansys.systemcoupling.core.adaptor.api_24_2.add_interface_by_display_names.add_interface_by_display_names(name=None, parent=None)

Bases: Command

Important: This command is deprecated. To add an interface, use the add_interface command instead.

Adds an interface based on the participant and region display names specified as arguments for each side of the interface. This command requires that you specify participants and regions using their display names (see parameter descriptions for details).

Cannot be run after participants have been started.

Returns the name of the Interface created.

Parameters:

side_one_participantstr

String indicating the name of the participant to be associated with side “One” of the interface.

side_one_regionsList

List specifying the name(s) of region(s) to be added to side “One” of the interface.

side_two_participantstr

String indicating the name of the participant to be associated with side “Two” of the interface.

side_two_regionsList

List specifying the name(s) of region(s) to be added to side “Two” of the interface.

Included in:

Parent	Summary
setup_root	‘root’ object