add_participant

class ansys.systemcoupling.core.adaptor.api_25_2.add_participant.add_participant(name=None, parent=None)

Bases: InjectedCommand

This command operates in one of two modes, depending on how it is called. Either a single argument, participant_session, should be provided, or some combination of the other optional arguments not including participant_session should be provided.

In the participant_session mode, the session object is queried to extract the information needed to define a new coupling_participant object in the setup datamodel. A reference to the session is also retained, and this will play a further role if solve is called later. In that case, the participant solver will be driven from the Python environment in which the participant and PySystemCoupling sessions are active and System Coupling will regard the participant solver as “externally managed” (see the execution_control settings in coupling_participant for details of this mode).

Note

The participant_session mode currently has limited support in the broader Ansys Python ecosystem - at present, only PyFluent supports the API required of the session object and product versions of Fluent and System Coupling need to be at least 24.1. This capability should be regarded as Beta as it may be subject to revision when extended to other products.

The remainder of the documentation describes the more usual non-session mode.

Adds a coupling participant to the setup. Cannot be called after participants have been started. Returns the name of the participant.

There are several options that can be selected to add the participant - via a file, via a participant executable, or via a Python script. Some of these options may be combined. For example, sometimes it is useful to use an input file while at the same time providing a custom participant executable or Python script.

Option 1: Using an input file

Given an input file containing participant coupling information, reads the specified file, pushes the participant’s information to the data model.

Option 2: Using a participant executable

Given the path to the executable for this participant (and optionally, additional arguments and/or working directory), start the participant executable, connect to the participant using the socket connection, and get the participant’s information and add it to the data model.

Option 3: Using a Python script

This can be seen as a special case of Option 2 (using an executable), but instead of an executable, a Python script is used. System Coupling will invoke a specialized script to set up the environment so that the Python script can more easily interact with System Coupling.

Parameters:

participant_sessionParticipantProtocol, optional

Participant session object conforming to the ParticipantProtocol protocol class.

participant_typestr, optional

Participant type. To get a list of supported participant types, use the get_supported_participant_types() query. If unspecified, add_participant will attempt to deduce the type from input_file.

input_filestr, optional

Name of the input file for the participant to be added. Currently supported formats are SCP files, Forte input (FTSIM) files, Mechanical Server (*.rst) files, CFD Server (*.csv) files, FMU (*.fmu) files, and System Coupling Data Server (*.scdt/axdt/csv) files.

executablestr, optional

Path to the executable file for the participant to be added.

additional_argumentsstr, optional

Any additional arguments to be passed to the participant’s executable.

working_directorystr, optional

Path to the working directory for this participant.

python_scriptstr, optional

Instead of the executable, use a Python script and wrap it with System Coupling-provided .bat/.sh scripts to set up the environment correctly before calling this Python script. On Windows, a few lines will need to be included near the top of the Python script to add the required dll directories as follows:

import os
import sys
if sys.platform.startswith("win"):
    for p in os.environ["PYTHON_DLL_PATH"].split(os.pathsep):
        os.add_dll_directory(p)

Included in:

Parent	Summary
setup_root	‘root’ object