ansys-systemcoupling-core 0.5.0__py3-none-any.whl → 0.7.0__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/add_interface.py

@@ -21,13 +21,13 @@ class add_interface(Command):
     side_one_participant : str
         String indicating the name of the participant to be associated with
         side \"One\" of the interface.
-    side_one_regions : typing.List[str]
+    side_one_regions : List
         List specifying the name(s) of region(s) to be added to side \"One\" of
         the interface.
     side_two_participant : str
         String indicating the name of the participant to be associated with
         side \"Two\" of the interface.
-    side_two_regions : typing.List[str]
+    side_two_regions : List
         List specifying the name(s) of region(s) to be added to side \"Two\" of
         the interface.
 

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

@@ -21,13 +21,13 @@ class add_interface_by_display_names(Command):
     side_one_participant : str
         String indicating the name of the participant to be associated with
         side \"One\" of the interface.
-    side_one_regions : typing.List[str]
+    side_one_regions : List
         List specifying the name(s) of region(s) to be added to side \"One\" of
         the interface.
     side_two_participant : str
         String indicating the name of the participant to be associated with
         side \"Two\" of the interface.
-    side_two_regions : typing.List[str]
+    side_two_regions : List
         List specifying the name(s) of region(s) to be added to side \"Two\"
         of the interface.
 

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

@@ -41,7 +41,7 @@ class add_transformation(Command):
         Axis about which a rotation is applied. Used with
         Rotation ``transformation_type``. Available options are: \"XAxis\", \"YAxis\",
         \"ZAxis\", and \"UserDefined\".
-    vector : typing.Tuple[real, real, real], optional
+    vector : Tuple, optional
         A vector for use with \"Translation\" ``transformation_type`` or \"Rotation\"
         ``transformation_type`` if the ``axis`` is \"UserDefined\".
 

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

@@ -33,7 +33,7 @@ class partition_participants(Command):
 
         See the System Coupling documentation for more details of the
         partitioning algorithms.
-    names_and_fractions : typing.List[typing.Tuple[str, float]], optional
+    names_and_fractions : List, optional
         List of tuples specifying the fractions of core count applied for
         each participant
 
@@ -41,14 +41,14 @@ class partition_participants(Command):
         associated fraction as its second item. If this parameter is omitted,
         then cores will be allocated for all participants set in the
         data model.
-    machine_list : typing.List[typing.Dict[str, typing.Union[str, int]]], optional
+    machine_list : List, optional
         List of dictionaries specifying machines available for distributed run.
         Each dictionary must have a key \"machine-name\" with machine name as its
         value, and key \"core-count\" with number of cores for that machine as
         its value. Providing this argument will override any machine list
         information detected from the scheduler environment and any information
         provided by the ``--cnf`` command-line argument.
-    partitioning_info : typing.Dict[str, typing.List[typing.Dict[str, typing.Union[str, int]]]], optional
+    partitioning_info : Dict, optional
         Dictionary specifying machines resources assigned to each participant by user.
         Dictionary must have participant names as keys and machine lists containing
         machine resources as values. The value of a ``partitioning_info`` machine list is

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 : List, 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_1/start_participants.py

@@ -30,7 +30,7 @@ class start_participants(Command):
 
     Parameters
     ----------
-    participant_names : typing.List[str], optional
+    participant_names : List, optional
         This argument has been deprecated and will be removed in future releases.
 
     """

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

@@ -21,13 +21,13 @@ class add_interface(Command):
     side_one_participant : str
         String indicating the name of the participant to be associated with
         side \"One\" of the interface.
-    side_one_regions : typing.List[str]
+    side_one_regions : List
         List specifying the name(s) of region(s) to be added to side \"One\" of
         the interface.
     side_two_participant : str
         String indicating the name of the participant to be associated with
         side \"Two\" of the interface.
-    side_two_regions : typing.List[str]
+    side_two_regions : List
         List specifying the name(s) of region(s) to be added to side \"Two\" of
         the interface.
 

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

@@ -21,13 +21,13 @@ class add_interface_by_display_names(Command):
     side_one_participant : str
         String indicating the name of the participant to be associated with
         side \"One\" of the interface.
-    side_one_regions : typing.List[str]
+    side_one_regions : List
         List specifying the name(s) of region(s) to be added to side \"One\" of
         the interface.
     side_two_participant : str
         String indicating the name of the participant to be associated with
         side \"Two\" of the interface.
-    side_two_regions : typing.List[str]
+    side_two_regions : List
         List specifying the name(s) of region(s) to be added to side \"Two\"
         of the interface.
 

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

@@ -41,7 +41,7 @@ class add_transformation(Command):
         Axis about which a rotation is applied. Used with
         Rotation ``transformation_type``. Available options are: \"XAxis\", \"YAxis\",
         \"ZAxis\", and \"UserDefined\".
-    vector : typing.Tuple[real, real, real], optional
+    vector : Tuple, optional
         A vector for use with \"Translation\" ``transformation_type`` or \"Rotation\"
         ``transformation_type`` if the ``axis`` is \"UserDefined\".
 

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

@@ -33,7 +33,7 @@ class partition_participants(Command):
 
         See the System Coupling documentation for more details of the
         partitioning algorithms.
-    names_and_fractions : typing.List[typing.Tuple[str, float]], optional
+    names_and_fractions : List, optional
         List of tuples specifying the fractions of core count applied for
         each participant
 
@@ -41,14 +41,14 @@ class partition_participants(Command):
         associated fraction as its second item. If this parameter is omitted,
         then cores will be allocated for all participants set in the
         data model.
-    machine_list : typing.List[typing.Dict[str, typing.Union[str, int]]], optional
+    machine_list : List, optional
         List of dictionaries specifying machines available for distributed run.
         Each dictionary must have a key \"machine-name\" with machine name as its
         value, and key \"core-count\" with number of cores for that machine as
         its value. Providing this argument will override any machine list
         information detected from the scheduler environment and any information
         provided by the ``--cnf`` command-line argument.
-    partitioning_info : typing.Dict[str, typing.List[typing.Dict[str, typing.Union[str, int]]]], optional
+    partitioning_info : Dict, optional
         Dictionary specifying machines resources assigned to each participant by user.
         Dictionary must have participant names as keys and machine lists containing
         machine resources as values. The value of a ``partitioning_info`` machine list is

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 : List, 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_23_2/start_participants.py

@@ -30,7 +30,7 @@ class start_participants(Command):
 
     Parameters
     ----------
-    participant_names : typing.List[str], optional
+    participant_names : List, optional
         This argument has been deprecated and will be removed in future releases.
 
     """

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

@@ -16,7 +16,7 @@ class add_aerodamping_data_transfers(Command):
     interface : str
         String indicating the name of the interface on which the data transfer
         is to be created.
-    mode_shapes : typing.List[str], optional
+    mode_shapes : List, optional
         List of mode shapes to transfer. If not provided, a
         data transfer is created for each available modeshape.
 

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

@@ -26,10 +26,10 @@ class add_interface(Command):
     side_two_participant : str
         String indicating the name of the participant to be associated with
         side \"Two"\ of the interface.
-    side_one_regions : typing.List[str], optional
+    side_one_regions : List, optional
         List specifying the name(s) of region(s) to be added to side One of
         the interface. Must be provided if ``side_one_participant`` is not an FMU.
-    side_two_regions : typing.List[str], optional
+    side_two_regions : List, optional
         List specifying the name(s) of region(s) to be added to side Two of
         the interface. Must be provided if ``side_one_participant`` is not an FMU.
 

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

@@ -24,13 +24,13 @@ class add_interface_by_display_names(Command):
     side_one_participant : str
         String indicating the name of the participant to be associated with
         side \"One\" of the interface.
-    side_one_regions : typing.List[str]
+    side_one_regions : List
         List specifying the name(s) of region(s) to be added to side \"One\" of
         the interface.
     side_two_participant : str
         String indicating the name of the participant to be associated with
         side \"Two\" of the interface.
-    side_two_regions : typing.List[str]
+    side_two_regions : List
         List specifying the name(s) of region(s) to be added to side \"Two\"
         of the interface.
 

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

@@ -41,7 +41,7 @@ class add_transformation(Command):
         Axis about which a rotation is applied. Used with
         Rotation ``transformation_type``. Available options are: \"XAxis\", \"YAxis\",
         \"ZAxis\", and \"UserDefined\".
-    vector : typing.Tuple[real, real, real], optional
+    vector : Tuple, optional
         A vector for use with \"Translation\" ``transformation_type`` or \"Rotation\"
         ``transformation_type`` if the ``axis`` is \"UserDefined\".
 

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

@@ -33,7 +33,7 @@ class partition_participants(Command):
 
         See the System Coupling documentation for more details of the
         partitioning algorithms.
-    names_and_fractions : typing.List[typing.Tuple[str, float]], optional
+    names_and_fractions : List, optional
         List of tuples specifying the fractions of core count applied for
         each participant
 
@@ -41,14 +41,14 @@ class partition_participants(Command):
         associated fraction as its second item. If this parameter is omitted,
         then cores will be allocated for all participants set in the
         data model.
-    machine_list : typing.List[typing.Dict[str, typing.Union[str, int]]], optional
+    machine_list : List, optional
         List of dictionaries specifying machines available for distributed run.
         Each dictionary must have a key \"machine-name\" with machine name as its
         value, and key \"core-count\" with number of cores for that machine as
         its value. Providing this argument will override any machine list
         information detected from the scheduler environment and any information
         provided by the ``--cnf`` command-line argument.
-    partitioning_info : typing.Dict[str, typing.List[typing.Dict[str, typing.Union[str, int]]]], optional
+    partitioning_info : Dict, optional
         Dictionary specifying machines resources assigned to each participant by user.
         Dictionary must have participant names as keys and machine lists containing
         machine resources as values. The value of a ``partitioning_info`` machine list is

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 : List, 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_1/start_participants.py

@@ -30,7 +30,7 @@ class start_participants(Command):
 
     Parameters
     ----------
-    participant_names : typing.List[str], optional
+    participant_names : List, optional
         This argument has been deprecated and will be removed in future releases.
 
     """

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

@@ -16,7 +16,7 @@ class add_aerodamping_data_transfers(Command):
     interface : str
         String indicating the name of the interface on which the data transfer
         is to be created.
-    mode_shapes : typing.List[str], optional
+    mode_shapes : List, optional
         List of mode shapes to transfer. If not provided, a
         data transfer is created for each available modeshape.
 

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

@@ -26,10 +26,10 @@ class add_interface(Command):
     side_two_participant : str
         String indicating the name of the participant to be associated with
         side \"Two"\ of the interface.
-    side_one_regions : typing.List[str], optional
+    side_one_regions : List, optional
         List specifying the name(s) of region(s) to be added to side One of
         the interface. Must be provided if ``side_one_participant`` is not an FMU.
-    side_two_regions : typing.List[str], optional
+    side_two_regions : List, optional
         List specifying the name(s) of region(s) to be added to side Two of
         the interface. Must be provided if ``side_one_participant`` is not an FMU.