coupling_participant_child

class ansys.systemcoupling.core.adaptor.api_25_2.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” - “FMU-PROXY” - “EXTERNALDATA” - “FORTE” - “DEFAULT-SRV” - “MECH-SRV” - “CFD-SRV” - “SCDT-SRV” - “THERMAL-DESKTOP” - “LS-DYNA” - “ROCKY”

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”).

input_variablesStringListType

Input variables for the region or FMU.

output_variablesStringListType

Output variables for the region or FMU.

input_parametersStringListType

Input parameters for the solver.

output_parametersStringListType

Output parameters for the solver.

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 Fluent/MAPDL/AEDT/CFX participant should communicate using new APIs.

restarts_supportedbool

Indicates whether the participant supports restarts.

can_serialize_fmu_statebool

Indicates whether the FMU can state can be serialized.

can_get_and_set_fmu_statebool

Indicates whether the FMU can get and set its state.

free_fmu_statebool

Optionally Frees the FMU state prior to calling CanGetAndSetFmuState

instancingstr

Set instancing on the participant.

Children

Child	Summary
variable	Configure a variable for the coupling participant.
parameter	Configure a parameter for the coupling participant.
attribute	Configure an attribute.
region	Configure a region for the coupling participant.
properties	UNDOCUMENTED
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.
record_interactions	“Controls whether the System Coupling Participant library will record the setup and solution data files for testing and debugging.

Included in:

Parent	Summary
coupling_participant	Configure a coupling participant.