ansys-systemcoupling-core 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

ansys/systemcoupling/core/__init__.py

@@ -73,8 +73,7 @@ def launch(
         version=version,
         extra_args=extra_args,
     )
-    syc = Session(rpc)
-    return syc
+    return Session(rpc)
 
 
 def launch_container(
@@ -97,8 +96,7 @@ def launch_container(
     """
     rpc = SycGrpc()
     rpc.start_container_and_connect(mounted_from, mounted_to, network, version=version)
-    syc = Session(rpc)
-    return syc
+    return Session(rpc)
 
 
 def connect(host: str, port: int) -> Session:  # pragma: no cover

ansys/systemcoupling/core/adaptor/api_23_2/_add_participant.py

@@ -0,0 +1,70 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class _add_participant(Command):
+    """
+    For internal use only.
+
+    Parameters
+    ----------
+    participant_type : str, optional
+        ...
+    input_file : str, optional
+        ...
+    executable : str, optional
+        ...
+    additional_arguments : str, optional
+        ...
+    working_directory : str, optional
+        ...
+
+    """
+
+    syc_name = "AddParticipant"
+
+    argument_names = [
+        "participant_type",
+        "input_file",
+        "executable",
+        "additional_arguments",
+        "working_directory",
+    ]
+
+    class participant_type(String):
+        """
+        ...
+        """
+
+        syc_name = "ParticipantType"
+
+    class input_file(String):
+        """
+        ...
+        """
+
+        syc_name = "InputFile"
+
+    class executable(String):
+        """
+        ...
+        """
+
+        syc_name = "Executable"
+
+    class additional_arguments(String):
+        """
+        ...
+        """
+
+        syc_name = "AdditionalArguments"
+
+    class working_directory(String):
+        """
+        ...
+        """
+
+        syc_name = "WorkingDirectory"

ansys/systemcoupling/core/adaptor/api_23_2/_solve.py

@@ -0,0 +1,13 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class _solve(Command):
+    """
+    For internal use only.
+    """
+
+    syc_name = "Solve"

ansys/systemcoupling/core/adaptor/api_23_2/add_participant.py

@@ -5,8 +5,32 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 
-class add_participant(Command):
+class add_participant(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 data model.
 
     When executed, this command adds the new participant to the analysis
@@ -31,6 +55,8 @@ class add_participant(Command):
 
     Parameters
     ----------
+    participant_session : ParticipantProtocol, optional
+        Participant session object conforming to the ``ParticipantProtocol`` protocol class.
     participant_type : str, optional
         Participant type. Currently supported types are:
 
@@ -61,9 +87,12 @@ class add_participant(Command):
 
     """
 
-    syc_name = "AddParticipant"
+    syc_name = "add_participant"
+
+    cmd_name = "add_participant"
 
     argument_names = [
+        "participant_session",
         "participant_type",
         "input_file",
         "executable",
@@ -71,6 +100,13 @@ class add_participant(Command):
         "working_directory",
     ]
 
+    class participant_session(ParticipantSession):
+        """
+        Participant session object conforming to the ``ParticipantProtocol`` protocol class.
+        """
+
+        syc_name = "participant_session"
+
     class participant_type(String):
         """
         Participant type. Currently supported types are:

ansys/systemcoupling/core/adaptor/api_23_2/case_root.py

@@ -24,39 +24,39 @@ class case_root(Container):
 
     command_names = [
         "clear_state",
+        "delete_snapshot",
+        "get_snapshots",
         "open",
+        "open_snapshot",
         "save",
         "save_snapshot",
-        "open_snapshot",
-        "delete_snapshot",
-        "get_snapshots",
     ]
 
     clear_state: clear_state = clear_state
     """
     clear_state command of case_root.
     """
-    open: open = open
+    delete_snapshot: delete_snapshot = delete_snapshot
     """
-    open command of case_root.
+    delete_snapshot command of case_root.
     """
-    save: save = save
+    get_snapshots: get_snapshots = get_snapshots
     """
-    save command of case_root.
+    get_snapshots command of case_root.
     """
-    save_snapshot: save_snapshot = save_snapshot
+    open: open = open
     """
-    save_snapshot command of case_root.
+    open command of case_root.
     """
     open_snapshot: open_snapshot = open_snapshot
     """
     open_snapshot command of case_root.
     """
-    delete_snapshot: delete_snapshot = delete_snapshot
+    save: save = save
     """
-    delete_snapshot command of case_root.
+    save command of case_root.
     """
-    get_snapshots: get_snapshots = get_snapshots
+    save_snapshot: save_snapshot = save_snapshot
     """
-    get_snapshots command of case_root.
+    save_snapshot command of case_root.
     """

ansys/systemcoupling/core/adaptor/api_23_2/setup_root.py

@@ -2,10 +2,11 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "f0b84f45a076885c3300d060703c9aa41ff964ebaf19d26017f53d9b71df370f"
+SHASH = "d452d4fc3cb91437bd3661ce0cb39dad813458b231800e10af3246b0c6a508f2"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
+from ._add_participant import _add_participant
 from .activate_hidden import activate_hidden
 from .add_data_transfer import add_data_transfer
 from .add_data_transfer_by_display_names import add_data_transfer_by_display_names
@@ -80,36 +81,31 @@ class setup_root(Container):
     output_control child of setup_root.
     """
     command_names = [
-        "add_interface",
-        "add_interface_by_display_names",
+        "_add_participant",
         "add_data_transfer",
         "add_data_transfer_by_display_names",
-        "get_region_names_for_participant",
+        "add_expression_function",
+        "add_interface",
+        "add_interface_by_display_names",
+        "add_named_expression",
+        "add_participant",
         "add_reference_frame",
         "add_transformation",
         "delete_transformation",
-        "add_participant",
-        "update_participant",
-        "get_execution_command",
         "generate_input_file",
-        "import_system_coupling_input_file",
-        "add_named_expression",
-        "add_expression_function",
-        "reload_expression_function_modules",
-        "has_input_file_changed",
+        "get_execution_command",
+        "get_region_names_for_participant",
         "get_setup_summary",
         "get_status_messages",
+        "has_input_file_changed",
+        "import_system_coupling_input_file",
+        "reload_expression_function_modules",
+        "update_participant",
     ]
 
-    add_interface: add_interface = add_interface
+    _add_participant: _add_participant = _add_participant
     """
-    add_interface command of setup_root.
-    """
-    add_interface_by_display_names: add_interface_by_display_names = (
-        add_interface_by_display_names
-    )
-    """
-    add_interface_by_display_names command of setup_root.
+    _add_participant command of setup_root.
     """
     add_data_transfer: add_data_transfer = add_data_transfer
     """
@@ -121,11 +117,27 @@ class setup_root(Container):
     """
     add_data_transfer_by_display_names command of setup_root.
     """
-    get_region_names_for_participant: get_region_names_for_participant = (
-        get_region_names_for_participant
+    add_expression_function: add_expression_function = add_expression_function
+    """
+    add_expression_function command of setup_root.
+    """
+    add_interface: add_interface = add_interface
+    """
+    add_interface command of setup_root.
+    """
+    add_interface_by_display_names: add_interface_by_display_names = (
+        add_interface_by_display_names
     )
     """
-    get_region_names_for_participant command of setup_root.
+    add_interface_by_display_names command of setup_root.
+    """
+    add_named_expression: add_named_expression = add_named_expression
+    """
+    add_named_expression command of setup_root.
+    """
+    add_participant: add_participant = add_participant
+    """
+    add_participant command of setup_root.
     """
     add_reference_frame: add_reference_frame = add_reference_frame
     """
@@ -139,35 +151,37 @@ class setup_root(Container):
     """
     delete_transformation command of setup_root.
     """
-    add_participant: add_participant = add_participant
-    """
-    add_participant command of setup_root.
-    """
-    update_participant: update_participant = update_participant
+    generate_input_file: generate_input_file = generate_input_file
     """
-    update_participant command of setup_root.
+    generate_input_file command of setup_root.
     """
     get_execution_command: get_execution_command = get_execution_command
     """
     get_execution_command command of setup_root.
     """
-    generate_input_file: generate_input_file = generate_input_file
+    get_region_names_for_participant: get_region_names_for_participant = (
+        get_region_names_for_participant
+    )
     """
-    generate_input_file command of setup_root.
+    get_region_names_for_participant command of setup_root.
     """
-    import_system_coupling_input_file: import_system_coupling_input_file = (
-        import_system_coupling_input_file
-    )
+    get_setup_summary: get_setup_summary = get_setup_summary
     """
-    import_system_coupling_input_file command of setup_root.
+    get_setup_summary command of setup_root.
     """
-    add_named_expression: add_named_expression = add_named_expression
+    get_status_messages: get_status_messages = get_status_messages
     """
-    add_named_expression command of setup_root.
+    get_status_messages command of setup_root.
     """
-    add_expression_function: add_expression_function = add_expression_function
+    has_input_file_changed: has_input_file_changed = has_input_file_changed
     """
-    add_expression_function command of setup_root.
+    has_input_file_changed command of setup_root.
+    """
+    import_system_coupling_input_file: import_system_coupling_input_file = (
+        import_system_coupling_input_file
+    )
+    """
+    import_system_coupling_input_file command of setup_root.
     """
     reload_expression_function_modules: reload_expression_function_modules = (
         reload_expression_function_modules
@@ -175,15 +189,7 @@ class setup_root(Container):
     """
     reload_expression_function_modules command of setup_root.
     """
-    has_input_file_changed: has_input_file_changed = has_input_file_changed
-    """
-    has_input_file_changed command of setup_root.
-    """
-    get_setup_summary: get_setup_summary = get_setup_summary
-    """
-    get_setup_summary command of setup_root.
-    """
-    get_status_messages: get_status_messages = get_status_messages
+    update_participant: update_participant = update_participant
     """
-    get_status_messages command of setup_root.
+    update_participant command of setup_root.
     """

ansys/systemcoupling/core/adaptor/api_23_2/solution_root.py

@@ -2,10 +2,11 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "5ea5d97aed6965ab7eb7bb9d10061e138b000af99b3419e5b772e92989f1c903"
+SHASH = "9d14945e18aa7dc6f7ad86397c62f0ceb910440e6ac3753ce8a1d0d2f91b84f5"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
+from ._solve import _solve
 from .abort import abort
 from .create_restart_point import create_restart_point
 from .get_machines import get_machines
@@ -30,75 +31,80 @@ class solution_root(Container):
     syc_name = "SolutionCommands"
 
     command_names = [
-        "start_participants",
+        "_solve",
+        "abort",
+        "create_restart_point",
+        "get_machines",
+        "get_transformation",
         "initialize",
+        "interrupt",
+        "open_results_in_en_sight",
+        "partition_participants",
         "shutdown",
         "solve",
+        "start_participants",
         "step",
-        "partition_participants",
-        "open_results_in_en_sight",
-        "write_ensight",
-        "create_restart_point",
-        "get_transformation",
         "write_csv_chart_files",
-        "get_machines",
-        "interrupt",
-        "abort",
+        "write_ensight",
     ]
 
-    start_participants: start_participants = start_participants
+    _solve: _solve = _solve
     """
-    start_participants command of solution_root.
+    _solve command of solution_root.
     """
-    initialize: initialize = initialize
+    abort: abort = abort
     """
-    initialize command of solution_root.
+    abort command of solution_root.
     """
-    shutdown: shutdown = shutdown
+    create_restart_point: create_restart_point = create_restart_point
     """
-    shutdown command of solution_root.
+    create_restart_point command of solution_root.
     """
-    solve: solve = solve
+    get_machines: get_machines = get_machines
     """
-    solve command of solution_root.
+    get_machines command of solution_root.
     """
-    step: step = step
+    get_transformation: get_transformation = get_transformation
     """
-    step command of solution_root.
+    get_transformation command of solution_root.
     """
-    partition_participants: partition_participants = partition_participants
+    initialize: initialize = initialize
     """
-    partition_participants command of solution_root.
+    initialize command of solution_root.
+    """
+    interrupt: interrupt = interrupt
+    """
+    interrupt command of solution_root.
     """
     open_results_in_en_sight: open_results_in_en_sight = open_results_in_en_sight
     """
     open_results_in_en_sight command of solution_root.
     """
-    write_ensight: write_ensight = write_ensight
+    partition_participants: partition_participants = partition_participants
     """
-    write_ensight command of solution_root.
+    partition_participants command of solution_root.
     """
-    create_restart_point: create_restart_point = create_restart_point
+    shutdown: shutdown = shutdown
     """
-    create_restart_point command of solution_root.
+    shutdown command of solution_root.
     """
-    get_transformation: get_transformation = get_transformation
+    solve: solve = solve
     """
-    get_transformation command of solution_root.
+    solve command of solution_root.
     """
-    write_csv_chart_files: write_csv_chart_files = write_csv_chart_files
+    start_participants: start_participants = start_participants
     """
-    write_csv_chart_files command of solution_root.
+    start_participants command of solution_root.
     """
-    get_machines: get_machines = get_machines
+    step: step = step
     """
-    get_machines command of solution_root.
+    step command of solution_root.
     """
-    interrupt: interrupt = interrupt
+    write_csv_chart_files: write_csv_chart_files = write_csv_chart_files
     """
-    interrupt command of solution_root.
+    write_csv_chart_files command of solution_root.
     """
-    abort: abort = abort
+    write_ensight: write_ensight = write_ensight
     """
-    abort command of solution_root.
+    write_ensight command of solution_root.
     """

ansys/systemcoupling/core/adaptor/api_23_2/solve.py

@@ -25,6 +25,6 @@ class solve(InjectedCommand):
     System Coupling is solving in the current working directory.
     """
 
-    syc_name = "Solve"
+    syc_name = "solve"
 
     cmd_name = "solve"

ansys/systemcoupling/core/adaptor/api_24_1/_add_participant.py

@@ -0,0 +1,70 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class _add_participant(Command):
+    """
+    For internal use only.
+
+    Parameters
+    ----------
+    participant_type : str, optional
+        ...
+    input_file : str, optional
+        ...
+    executable : str, optional
+        ...
+    additional_arguments : str, optional
+        ...
+    working_directory : str, optional
+        ...
+
+    """
+
+    syc_name = "AddParticipant"
+
+    argument_names = [
+        "participant_type",
+        "input_file",
+        "executable",
+        "additional_arguments",
+        "working_directory",
+    ]
+
+    class participant_type(String):
+        """
+        ...
+        """
+
+        syc_name = "ParticipantType"
+
+    class input_file(String):
+        """
+        ...
+        """
+
+        syc_name = "InputFile"
+
+    class executable(String):
+        """
+        ...
+        """
+
+        syc_name = "Executable"
+
+    class additional_arguments(String):
+        """
+        ...
+        """
+
+        syc_name = "AdditionalArguments"
+
+    class working_directory(String):
+        """
+        ...
+        """
+
+        syc_name = "WorkingDirectory"

ansys/systemcoupling/core/adaptor/api_24_1/_solve.py

@@ -0,0 +1,13 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class _solve(Command):
+    """
+    For internal use only.
+    """
+
+    syc_name = "Solve"

ansys/systemcoupling/core/adaptor/api_24_1/abort.py

@@ -0,0 +1,39 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class abort(InjectedCommand):
+    """
+    Aborts a solve in progress.
+
+    See also ``interrupt``. In contrast to an interrupted solve,
+    an aborted solve cannot be resumed.
+
+    Parameters
+    ----------
+    reason_msg : str, optional
+        Text to describe the reason for the abort.
+
+        This might be used for such purposes as providing
+        additional annotation in transcript output.
+
+    """
+
+    syc_name = "abort"
+
+    cmd_name = "abort"
+
+    argument_names = ["reason_msg"]
+
+    class reason_msg(String):
+        """
+        Text to describe the reason for the abort.
+
+        This might be used for such purposes as providing
+        additional annotation in transcript output.
+        """
+
+        syc_name = "reason_msg"