coupling_participant_child

class ansys.systemcoupling.core.adaptor.api_23_1.coupling_participant_child.coupling_participant_child(name=None, parent=None)

Bases: Container

Configure a coupling participant.

These settings are typically populated by using the add_participant command.

Properties

participant_typestr

Coupling participant type.

Allowed values: - “DEFAULT” - “CFX” - “FLUENT” - “MAPDL” - “AEDT” - “FMU” - “EXTERNALDATA” - “FORTE” - “DEFAULT-SRV” - “MECH-SRV” - “CFD-SRV”

participant_display_namestr

Participant’s display name as defined by the participant solver (as opposed to System Coupling’s display_name for the participant).

display_namestr

Participant’s display name as defined in System Coupling.

dimensionstr

Dimension of the participant (“2D” or “3D”).

participant_file_loadedstr

File used to generate the participant.

logging_onbool

Specifies whether logging is activated for the participant.

participant_analysis_typestr

Coupling participant analysis type (“Steady” or “Transient”).

use_new_apisbool

Controls whether a Fluent or MAPDL participant should communicate using new APIs.

restarts_supportedbool

Indicates whether the participant supports restarts.

instancingstr

Set instancing on the participant.

Children

Child	Summary
variable	Configure a variable for the coupling participant.
region	Configure a region for the coupling participant.
update_control	Configure update controls.
fmu_parameter	Configure a parameter for an FMU coupling participant.
execution_control	Configure execution control for a coupling participant.
external_data_file	Participant external data file settings.

Included in:

Parent	Summary
coupling_participant	Configure a coupling participant.