ansys-systemcoupling-core 0.4.1__py3-none-any.whl → 0.6__py3-none-any.whl

ansys/systemcoupling/core/__init__.py

@@ -46,6 +46,7 @@ def launch(
     nprocs: int = None,
     sycnprocs: int = None,
     version: str = None,
+    start_output: bool = False,
     extra_args: List[str] = [],
 ) -> Session:
     """Start a local instance of System Coupling and connect to it.
@@ -67,13 +68,17 @@ def launch(
         ``None``, in which case the System Coupling server uses its own default.
     version : str, optional
         String specifying the version of System Coupling to use. For example,
-        to use System Coupling from the Ansys "2023 R1" release, specify ``"231"``.
-        (The forms ``"23.1"`` and ``"23_1"`` are also acceptable.)
+        to use System Coupling from the Ansys "2024 R1" release, specify ``"241"``.
+        (The forms ``"24.1"`` and ``"24_1"`` are also acceptable.)
         The version will be sought in the standard installation location. The
         default is ``None``, which is equivalent to specifying
-        ``"241"`` ("2024 R1" release), unless either of the environment
+        ``"242"`` ("2024 R2" release), unless either of the environment
         variables ``SYSC_ROOT`` or ``AWP_ROOT`` has been set. It is considered
         to be an error if either these is set *and* ``version`` is provided.
+    start_output: bool, optional
+        Boolean to specify if the user wants to stream system coupling output.
+        The default is ``False``, in which case the output stream is kept hidden.
+        If ``True``, the output information is printed to standard output.
     extra_args : List[str]
         List of any additional arguments to specify when the server
         process is launched. The default is ``[]``. If a list of additional
@@ -92,9 +97,9 @@ def launch(
     if pypim.is_configured():
         LOG.info(
             "Starting System Coupling remotely. Any launch arguments other "
-            "than 'version' are ignored."
+            "than 'version' and 'start_output' are ignored."
         )
-        rpc.start_pim_and_connect(version)
+        rpc.start_pim_and_connect(version, start_output)
     else:
         rpc.start_and_connect(
             port=port,
@@ -102,6 +107,7 @@ def launch(
             nprocs=nprocs,
             sycnprocs=sycnprocs,
             version=version,
+            start_output=start_output,
             extra_args=extra_args,
         )
     return Session(rpc)

ansys/systemcoupling/core/adaptor/api_23_1/_clear_state.py

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

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

@@ -2,10 +2,11 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "0fbfd3e7593591d8e52193a6e92828c6174e531b26437aee17285b3d0d114664"
+SHASH = "c6427eb39292f21707811cf7093268eb2b0d3d9f2780ddaf390bf51bb916e546"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
+from ._clear_state import _clear_state
 from .clear_state import clear_state
 from .delete_snapshot import delete_snapshot
 from .get_snapshots import get_snapshots
@@ -23,6 +24,7 @@ class case_root(Container):
     syc_name = "CaseCommands"
 
     command_names = [
+        "_clear_state",
         "clear_state",
         "delete_snapshot",
         "get_snapshots",
@@ -32,6 +34,10 @@ class case_root(Container):
         "save_snapshot",
     ]
 
+    _clear_state: _clear_state = _clear_state
+    """
+    _clear_state command of case_root.
+    """
     clear_state: clear_state = clear_state
     """
     clear_state command of case_root.

ansys/systemcoupling/core/adaptor/api_23_1/clear_state.py

@@ -5,7 +5,7 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 
-class clear_state(Command):
+class clear_state(InjectedCommand):
     """
     Clears the state of the entire System Coupling service, removing all
     data model items, parameter values, and calculated values.
@@ -13,4 +13,6 @@ class clear_state(Command):
     Cannot be run after participants have been started.
     """
 
-    syc_name = "ClearState"
+    syc_name = "clear_state"
+
+    cmd_name = "clear_state"

ansys/systemcoupling/core/adaptor/api_23_1/show_plot.py

@@ -0,0 +1,75 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class show_plot(InjectedCommand):
+    """
+    Shows plots of transfer values and convergence for data transfers
+    of a coupling interface.
+
+    Parameters
+    ----------
+    interface_name : str
+        Specification of which interface to plot.
+    transfer_names : typing.List[str], optional
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+    working_dir : str, optional
+        Working directory (defaults = ".").
+    show_convergence : bool, optional
+        Whether to show convergence plots (defaults to ``True``).
+    show_transfer_values : bool, optional
+        Whether to show transfer value plots (defaults to ``True``).
+
+    """
+
+    syc_name = "show_plot"
+
+    cmd_name = "show_plot"
+
+    argument_names = [
+        "interface_name",
+        "transfer_names",
+        "working_dir",
+        "show_convergence",
+        "show_transfer_values",
+    ]
+
+    class interface_name(String):
+        """
+        Specification of which interface to plot.
+        """
+
+        syc_name = "interface_name"
+
+    class transfer_names(StringList):
+        """
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+        """
+
+        syc_name = "transfer_names"
+
+    class working_dir(String):
+        """
+        Working directory (defaults = ".").
+        """
+
+        syc_name = "working_dir"
+
+    class show_convergence(Boolean):
+        """
+        Whether to show convergence plots (defaults to ``True``).
+        """
+
+        syc_name = "show_convergence"
+
+    class show_transfer_values(Boolean):
+        """
+        Whether to show transfer value plots (defaults to ``True``).
+        """
+
+        syc_name = "show_transfer_values"

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

@@ -2,7 +2,7 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "54b4aa678f0aea8cebeca86bcd71b2877e846e53079c2bf52974d5e039ed3719"
+SHASH = "2774672445bd1c461a14acd1d3f26dcc93710777fea4556f16e3a79c35e271c9"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
@@ -14,6 +14,7 @@ from .initialize import initialize
 from .interrupt import interrupt
 from .open_results_in_ensight import open_results_in_ensight
 from .partition_participants import partition_participants
+from .show_plot import show_plot
 from .shutdown import shutdown
 from .solve import solve
 from .start_participants import start_participants
@@ -38,6 +39,7 @@ class solution_root(Container):
         "interrupt",
         "open_results_in_ensight",
         "partition_participants",
+        "show_plot",
         "shutdown",
         "solve",
         "start_participants",
@@ -78,6 +80,10 @@ class solution_root(Container):
     """
     partition_participants command of solution_root.
     """
+    show_plot: show_plot = show_plot
+    """
+    show_plot command of solution_root.
+    """
     shutdown: shutdown = shutdown
     """
     shutdown command of solution_root.

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

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

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

@@ -2,10 +2,11 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "0fbfd3e7593591d8e52193a6e92828c6174e531b26437aee17285b3d0d114664"
+SHASH = "c6427eb39292f21707811cf7093268eb2b0d3d9f2780ddaf390bf51bb916e546"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
+from ._clear_state import _clear_state
 from .clear_state import clear_state
 from .delete_snapshot import delete_snapshot
 from .get_snapshots import get_snapshots
@@ -23,6 +24,7 @@ class case_root(Container):
     syc_name = "CaseCommands"
 
     command_names = [
+        "_clear_state",
         "clear_state",
         "delete_snapshot",
         "get_snapshots",
@@ -32,6 +34,10 @@ class case_root(Container):
         "save_snapshot",
     ]
 
+    _clear_state: _clear_state = _clear_state
+    """
+    _clear_state command of case_root.
+    """
     clear_state: clear_state = clear_state
     """
     clear_state command of case_root.

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

@@ -5,7 +5,7 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 
-class clear_state(Command):
+class clear_state(InjectedCommand):
     """
     Clears the state of the entire System Coupling service, removing all
     data model items, parameter values, and calculated values.
@@ -13,4 +13,6 @@ class clear_state(Command):
     Cannot be run after participants have been started.
     """
 
-    syc_name = "ClearState"
+    syc_name = "clear_state"
+
+    cmd_name = "clear_state"

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

@@ -0,0 +1,75 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class show_plot(InjectedCommand):
+    """
+    Shows plots of transfer values and convergence for data transfers
+    of a coupling interface.
+
+    Parameters
+    ----------
+    interface_name : str
+        Specification of which interface to plot.
+    transfer_names : typing.List[str], optional
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+    working_dir : str, optional
+        Working directory (defaults = ".").
+    show_convergence : bool, optional
+        Whether to show convergence plots (defaults to ``True``).
+    show_transfer_values : bool, optional
+        Whether to show transfer value plots (defaults to ``True``).
+
+    """
+
+    syc_name = "show_plot"
+
+    cmd_name = "show_plot"
+
+    argument_names = [
+        "interface_name",
+        "transfer_names",
+        "working_dir",
+        "show_convergence",
+        "show_transfer_values",
+    ]
+
+    class interface_name(String):
+        """
+        Specification of which interface to plot.
+        """
+
+        syc_name = "interface_name"
+
+    class transfer_names(StringList):
+        """
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+        """
+
+        syc_name = "transfer_names"
+
+    class working_dir(String):
+        """
+        Working directory (defaults = ".").
+        """
+
+        syc_name = "working_dir"
+
+    class show_convergence(Boolean):
+        """
+        Whether to show convergence plots (defaults to ``True``).
+        """
+
+        syc_name = "show_convergence"
+
+    class show_transfer_values(Boolean):
+        """
+        Whether to show transfer value plots (defaults to ``True``).
+        """
+
+        syc_name = "show_transfer_values"

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

@@ -2,7 +2,7 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "9d14945e18aa7dc6f7ad86397c62f0ceb910440e6ac3753ce8a1d0d2f91b84f5"
+SHASH = "a713a451f17d724fabb76832c57ba91cb2d9a7426f9cd3be60bb1a03197d351a"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
@@ -15,6 +15,7 @@ from .initialize import initialize
 from .interrupt import interrupt
 from .open_results_in_en_sight import open_results_in_en_sight
 from .partition_participants import partition_participants
+from .show_plot import show_plot
 from .shutdown import shutdown
 from .solve import solve
 from .start_participants import start_participants
@@ -40,6 +41,7 @@ class solution_root(Container):
         "interrupt",
         "open_results_in_en_sight",
         "partition_participants",
+        "show_plot",
         "shutdown",
         "solve",
         "start_participants",
@@ -84,6 +86,10 @@ class solution_root(Container):
     """
     partition_participants command of solution_root.
     """
+    show_plot: show_plot = show_plot
+    """
+    show_plot command of solution_root.
+    """
     shutdown: shutdown = shutdown
     """
     shutdown command of solution_root.

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

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

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

@@ -2,10 +2,11 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "430648f7df949b91819d62a5c2d5a5c49d1d67217fb3474ee31e0c78e5ffbd43"
+SHASH = "34d232b251e1d4a5a6b88e3deb9591863eac6afb1446228951276f9b1700da9f"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
+from ._clear_state import _clear_state
 from .clear_state import clear_state
 from .delete_snapshot import delete_snapshot
 from .open import open
@@ -22,6 +23,7 @@ class case_root(Container):
     syc_name = "CaseCommands"
 
     command_names = [
+        "_clear_state",
         "clear_state",
         "delete_snapshot",
         "open",
@@ -30,6 +32,10 @@ class case_root(Container):
         "save_snapshot",
     ]
 
+    _clear_state: _clear_state = _clear_state
+    """
+    _clear_state command of case_root.
+    """
     clear_state: clear_state = clear_state
     """
     clear_state command of case_root.

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

@@ -5,7 +5,7 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 
-class clear_state(Command):
+class clear_state(InjectedCommand):
     """
     Clears the state of the entire System Coupling service, removing all
     data model items, parameter values, and calculated values.
@@ -13,4 +13,6 @@ class clear_state(Command):
     Cannot be run after participants have been started.
     """
 
-    syc_name = "ClearState"
+    syc_name = "clear_state"
+
+    cmd_name = "clear_state"

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

@@ -0,0 +1,75 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class show_plot(InjectedCommand):
+    """
+    Shows plots of transfer values and convergence for data transfers
+    of a coupling interface.
+
+    Parameters
+    ----------
+    interface_name : str
+        Specification of which interface to plot.
+    transfer_names : typing.List[str], optional
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+    working_dir : str, optional
+        Working directory (defaults = ".").
+    show_convergence : bool, optional
+        Whether to show convergence plots (defaults to ``True``).
+    show_transfer_values : bool, optional
+        Whether to show transfer value plots (defaults to ``True``).
+
+    """
+
+    syc_name = "show_plot"
+
+    cmd_name = "show_plot"
+
+    argument_names = [
+        "interface_name",
+        "transfer_names",
+        "working_dir",
+        "show_convergence",
+        "show_transfer_values",
+    ]
+
+    class interface_name(String):
+        """
+        Specification of which interface to plot.
+        """
+
+        syc_name = "interface_name"
+
+    class transfer_names(StringList):
+        """
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+        """
+
+        syc_name = "transfer_names"
+
+    class working_dir(String):
+        """
+        Working directory (defaults = ".").
+        """
+
+        syc_name = "working_dir"
+
+    class show_convergence(Boolean):
+        """
+        Whether to show convergence plots (defaults to ``True``).
+        """
+
+        syc_name = "show_convergence"
+
+    class show_transfer_values(Boolean):
+        """
+        Whether to show transfer value plots (defaults to ``True``).
+        """
+
+        syc_name = "show_transfer_values"

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

@@ -2,7 +2,7 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "92304eda8d03ebade30fb915bf1f0ab24f3d545b0d394f9d2ab9674b4bfd27fd"
+SHASH = "88f74a7fd899f469e2b44e28e2840af9f018c6891645f7974ecf900003b1c542"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
@@ -15,6 +15,7 @@ from .initialize import initialize
 from .interrupt import interrupt
 from .open_results_in_ensight import open_results_in_ensight
 from .partition_participants import partition_participants
+from .show_plot import show_plot
 from .shutdown import shutdown
 from .solve import solve
 from .start_participants import start_participants
@@ -40,6 +41,7 @@ class solution_root(Container):
         "interrupt",
         "open_results_in_ensight",
         "partition_participants",
+        "show_plot",
         "shutdown",
         "solve",
         "start_participants",
@@ -84,6 +86,10 @@ class solution_root(Container):
     """
     partition_participants command of solution_root.
     """
+    show_plot: show_plot = show_plot
+    """
+    show_plot command of solution_root.
+    """
     shutdown: shutdown = shutdown
     """
     shutdown command of solution_root.

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

@@ -0,0 +1,80 @@
+#
+# 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
+        ...
+    python_script : str, optional
+        ...
+
+    """
+
+    syc_name = "AddParticipant"
+
+    argument_names = [
+        "participant_type",
+        "input_file",
+        "executable",
+        "additional_arguments",
+        "working_directory",
+        "python_script",
+    ]
+
+    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"
+
+    class python_script(String):
+        """
+        ...
+        """
+
+        syc_name = "PythonScript"

ansys/systemcoupling/core/adaptor/api_24_2/_clear_state.py

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

ansys/systemcoupling/core/adaptor/api_24_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"