ansys-systemcoupling-core 0.9.0__py3-none-any.whl → 0.10.0__py3-none-any.whl

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

@@ -13,16 +13,32 @@ class partition_participants(Command):
     At least one participant must be defined for this command to be used. Use
     of this command is not recommended if participants are already running.
 
+    Note:
+    Ansys recommends only using this command for the Custom partitioning algorithm.
+
+    When other algorithms are used (SharedAllocateMachines,
+    DistributedAllocateCores, etc.) the algorithm should be specified directly,
+    for example:
+
+    ``setup.analysis_control.partitioning_algorithm = "SharedAllocateMachines"``
+
+    The participant parallel fractions can also be specified directly, for example:
+
+    ``setup.coupling_participant["FLUENT-1"].execution_control.parallel_fraction = 0.5``
+
+    The machine list should be specified via System Coupling command line arguments,
+    for example:
+
+    ``<v252>/SystemCoupling/binsystemcoupling --cnf="hostA:4,hostB:4"``
+
     Parameters
     ----------
     algorithm_name : str, optional
         Name of the partitioning algorithm. Available algorithms are:
-
-        - \"SharedAllocateMachines\" (default)
-        - \"SharedAllocateCores\"
-        - \"DistributedAllocateMachines\"
-        - \"DistributedAllocateCores\"
-        - \"Custom\" (see ``partitioning_info`` for more details)
+        'SharedAllocateMachines'(default), 'SharedAllocateCores',
+        'DistributedAllocateMachines', 'DistributedAllocateCores',
+        and 'Custom' (please see ``partitioning_info`` section below for more details
+        for this algorithm)
 
         The algorithms allow for both shared and distributed execution and for
         the allocation of machines or cores. The default value is generally the
@@ -37,29 +53,27 @@ class partition_participants(Command):
         List of tuples specifying the fractions of core count applied for
         each participant
 
-        Each tuple must have the participant name as its first item and the
+        Each tuple must have the ParticipantName as its first item and the
         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 : 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
+        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 over-ride any machine-list
         information detected from the scheduler environment and any information
-        provided by the ``--cnf`` command-line argument.
+        provided by the --cnf command-line argument.
     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
+        Dictionary must have participant names as keys and machineLists containing
+        machine resources as values. The value of ``partitioning_info`` machineList is
         a list of dictionaries specifying machines assigned to corresponding participants.
-        Each dictionary of the machine list must have a key \"machine-name\" with the
-        machine name as its value, and key \"core-count\" with number of cores for that
-        machine as its value.
-
+        Each dictionary of machine mist 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 disallow other arguments except ``algorithm_name``,
-        which must set as \"Custom\" if provided. Otherwise, ``algorithm_name`` will be
-        set as \"Custom\" internally if ``partitioning_info`` is provided.
+        which must set as 'Custom' if provided. Otherwise, ``algorithm_name`` will be set as
+        'Custom' internally if ``partitioning_info`` is provided.
 
     """
 
@@ -75,12 +89,10 @@ class partition_participants(Command):
     class algorithm_name(String):
         """
         Name of the partitioning algorithm. Available algorithms are:
-
-        - \"SharedAllocateMachines\" (default)
-        - \"SharedAllocateCores\"
-        - \"DistributedAllocateMachines\"
-        - \"DistributedAllocateCores\"
-        - \"Custom\" (see ``partitioning_info`` for more details)
+        'SharedAllocateMachines'(default), 'SharedAllocateCores',
+        'DistributedAllocateMachines', 'DistributedAllocateCores',
+        and 'Custom' (please see ``partitioning_info`` section below for more details
+        for this algorithm)
 
         The algorithms allow for both shared and distributed execution and for
         the allocation of machines or cores. The default value is generally the
@@ -100,7 +112,7 @@ class partition_participants(Command):
         List of tuples specifying the fractions of core count applied for
         each participant
 
-        Each tuple must have the participant name as its first item and the
+        Each tuple must have the ParticipantName as its first item and the
         associated fraction as its second item. If this parameter is omitted,
         then cores will be allocated for all participants set in the
         data model.
@@ -111,11 +123,11 @@ class partition_participants(Command):
     class machine_list(StrOrIntDictList):
         """
         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
+        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 over-ride any machine-list
         information detected from the scheduler environment and any information
-        provided by the ``--cnf`` command-line argument.
+        provided by the --cnf command-line argument.
         """
 
         syc_name = "MachineList"
@@ -123,16 +135,14 @@ class partition_participants(Command):
     class partitioning_info(StrOrIntDictListDict):
         """
         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
+        Dictionary must have participant names as keys and machineLists containing
+        machine resources as values. The value of ``partitioning_info`` machineList is
         a list of dictionaries specifying machines assigned to corresponding participants.
-        Each dictionary of the machine list must have a key \"machine-name\" with the
-        machine name as its value, and key \"core-count\" with number of cores for that
-        machine as its value.
-
+        Each dictionary of machine mist 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 disallow other arguments except ``algorithm_name``,
-        which must set as \"Custom\" if provided. Otherwise, ``algorithm_name`` will be
-        set as \"Custom\" internally if ``partitioning_info`` is provided.
+        which must set as 'Custom' if provided. Otherwise, ``algorithm_name`` will be set as
+        'Custom' internally if ``partitioning_info`` is provided.
         """
 
         syc_name = "PartitioningInfo"

ansys/systemcoupling/core/adaptor/api_25_2/save.py

@@ -9,32 +9,33 @@ class save(Command):
     """
     Saves the state of the coupled analysis data model.
 
-    -  Analysis settings are written to a single Settings.h5 file which
-       can be used to reload analysis settings.
+    --  Analysis settings are written to a single Settings.h5 file which
+        can be used to reload analysis settings.
 
-    -  Restart files for all restart points in the current co-simulation will
-       be written when this command is called. Existing restart files from
-       previous System Coupling versions will be renamed to conform to the new
-       naming scheme.
+    --  Restart files for all restart points in the current co-simulation will
+        be written when this command is called. Existing restart files from
+        previous System Coupling versions will be renamed to conform to the new
+        naming scheme.
 
-    -  Restart files are named according to the convention
-       ``Restart_step#.h5`` or ``Restart_iter#.h5``, where ``#`` is the index of
-       the corresponding coupling step or iteration.
+    --  Restart files are named according to the convention
+        Restart_step#.h5 or Restart_iter#.h5, where "#" is the index of
+        the corresponding coupling step or iteration.
 
-    Returns a Boolean value of ``True`` if the files were saved successfully;
-    otherwise, returns a value of ``False``.
+    Returns a Boolean value of 'True' if the files were saved successfully;
+    otherwise, returns a value of 'False'.
 
     Note that this command will raise an exception if another instance of
     System Coupling is solving in the current working directory.
 
-    By default, writes to the ``SyC`` sub-directory of the current working
-    directory. This behavior may be modified by providing ``file_path``.
+    If given optional arguments, then behaves as described below in "Optional
+    Keyword Arguments."
 
     Parameters
     ----------
     file_path : str, optional
         Writeable directory to which the SyC directory is added. (Settings and
-        results .h5 files will be written to the SyC directory.)
+        Results.h5 files will be written to the SyC directory.). Ansys does
+        not recommend changing the default value of this argument.
 
     """
 
@@ -45,7 +46,8 @@ class save(Command):
     class file_path(String):
         """
         Writeable directory to which the SyC directory is added. (Settings and
-        results .h5 files will be written to the SyC directory.)
+        Results.h5 files will be written to the SyC directory.). Ansys does
+        not recommend changing the default value of this argument.
         """
 
         syc_name = "FilePath"

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

@@ -2,7 +2,7 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "bb3a306a5f61f6aa15db0778cc94815e9d4f8176d4c372d9c4eb2c2664921947"
+SHASH = "de74a13bc10a8800dcb6f36be054801d70928ed5d61590540cefe133364d7adc"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
@@ -10,12 +10,10 @@ from ._add_participant import _add_participant
 from .activate_hidden import activate_hidden
 from .add_aerodamping_data_transfers import add_aerodamping_data_transfers
 from .add_data_transfer import add_data_transfer
-from .add_data_transfer_by_display_names import add_data_transfer_by_display_names
 from .add_expression_function import add_expression_function
 from .add_flow_boundary_data_transfers import add_flow_boundary_data_transfers
 from .add_fsi_data_transfers import add_fsi_data_transfers
 from .add_interface import add_interface
-from .add_interface_by_display_names import add_interface_by_display_names
 from .add_named_expression import add_named_expression
 from .add_ordered_data_transfers import add_ordered_data_transfers
 from .add_participant import add_participant
@@ -93,12 +91,10 @@ class setup_root(Container):
         "_add_participant",
         "add_aerodamping_data_transfers",
         "add_data_transfer",
-        "add_data_transfer_by_display_names",
         "add_expression_function",
         "add_flow_boundary_data_transfers",
         "add_fsi_data_transfers",
         "add_interface",
-        "add_interface_by_display_names",
         "add_named_expression",
         "add_ordered_data_transfers",
         "add_participant",
@@ -135,12 +131,6 @@ class setup_root(Container):
     """
     add_data_transfer command of setup_root.
     """
-    add_data_transfer_by_display_names: add_data_transfer_by_display_names = (
-        add_data_transfer_by_display_names
-    )
-    """
-    add_data_transfer_by_display_names command of setup_root.
-    """
     add_expression_function: add_expression_function = add_expression_function
     """
     add_expression_function command of setup_root.
@@ -159,12 +149,6 @@ class setup_root(Container):
     """
     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_named_expression: add_named_expression = add_named_expression
     """
     add_named_expression command of setup_root.

ansys/systemcoupling/core/adaptor/api_25_2/solution_control.py

@@ -29,6 +29,7 @@ class solution_control(Container):
         ("maximum_iterations", "MaximumIterations", "int"),
         ("use_ip_address_when_possible", "UseIPAddressWhenPossible", "str"),
         ("use_local_host_when_possible", "UseLocalHostWhenPossible", "str"),
+        ("write_participant_output_stream", "WriteParticipantOutputStream", "str"),
     ]
 
     @property
@@ -115,3 +116,12 @@ class solution_control(Container):
     @use_local_host_when_possible.setter
     def use_local_host_when_possible(self, value: str):
         self.set_property_state("use_local_host_when_possible", value)
+
+    @property
+    def write_participant_output_stream(self) -> str:
+        """Controls whether participant output stream is directed to an output file."""
+        return self.get_property_state("write_participant_output_stream")
+
+    @write_participant_output_stream.setter
+    def write_participant_output_stream(self, value: str):
+        self.set_property_state("write_participant_output_stream", value)

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

@@ -2,7 +2,7 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "5a1ce2bf8c6b59f120413651ed283c65b2593ebac9c4b8485e0817e00ecbd1e6"
+SHASH = "5752cfcb125c06b52c7d98fc8d1287154da25832c24c95eb0a98d3876d385b47"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 

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

@@ -7,16 +7,16 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
 
 class solve(InjectedCommand):
     """
-    Starts the participants (if necessary) and solves the coupled analysis. By
-    default, the solution runs straight through without pause unless stopped by
-    an scStop file.
+    Solves the coupled analysis. This command will execute until
+    end coupled analysis is reached, or it is interrupted or aborted
+    (for example, via scStop file).
 
     Disabled when a solution is already in progress.
 
     For restarts, the ``open`` command must be run before the ``solve`` command.
 
-    Note that if the ``execution_control`` option for a participant is set to
-    \"ExternallyManaged\", then System Coupling will not start the participant
+    Note that if the ``execution_control.option`` for a participant is set to
+    "ExternallyManaged", then System Coupling will not start the participant
     using either this command or any of the other commands that automatically
     start participants. The user is expected to manually start the participant.
     This function will not return until all participants have been connected.

ansys/systemcoupling/core/adaptor/api_25_2/update_participant.py

@@ -34,8 +34,8 @@ class update_participant(Command):
     input_file : str, optional
         Name of the input file for the participant to be added.
         Currently supported formats are SCP files, mechanical server
-        (*.rst) files, cfd server (*.csv) files, and system coupling
-        data server (*.scdt/axdt/csv) files.
+        (\*.rst) files, cfd server (\*.csv) files, and system coupling
+        data server (\*.scdt/axdt/csv) files.
 
     """
 
@@ -54,8 +54,8 @@ class update_participant(Command):
         """
         Name of the input file for the participant to be added.
         Currently supported formats are SCP files, mechanical server
-        (*.rst) files, cfd server (*.csv) files, and system coupling
-        data server (*.scdt/axdt/csv) files.
+        (\*.rst) files, cfd server (\*.csv) files, and system coupling
+        data server (\*.scdt/axdt/csv) files.
         """
 
         syc_name = "InputFile"

ansys/systemcoupling/core/adaptor/impl/get_syc_version.py

@@ -44,11 +44,14 @@ def get_syc_version(api) -> str:
     def clean_version_string(version_in: str) -> str:
         year, _, release = version_in.partition(" ")
         if len(year) == 4 and year.startswith("20") and release.startswith("R"):
+            # Exclude Bandit check. The try-except-pass is only used to simplify logic.
+            # An exception will be thrown in any case, but it *also* gets thrown for
+            # input that does not match the above 'if' condition.
             try:
                 year = int(year[2:])
                 release = int(release[1:])
                 return f"{year}.{release}"
-            except:
+            except:  # nosec B110
                 pass
         raise RuntimeError(
             f"Version string {version_in} has invalid format (expect '20yy Rn')."

ansys/systemcoupling/core/adaptor/impl/injected_commands.py

@@ -187,7 +187,9 @@ def _ensure_file_available(session: SessionProtocol, filepath: str) -> str:
     file_name = os.path.basename(filepath)
     root_name, _, ext = file_name.rpartition(".")
     ext = f".{ext}" if ext else ""
-    new_name = f"{root_name}_{int(time.time())}_{random.randint(1, 10000000)}{ext}"
+    # Exclude Bandit check as random number is simply being used to create a unique
+    # file name, not for security/cryptographic purposes.
+    new_name = f"{root_name}_{int(time.time())}_{random.randint(1, 10000000)}{ext}"  # nosec B311
 
     session._native_api.ExecPythonString(
         PythonString=f"import shutil\nshutil.copy('{filepath}', '{new_name}')"

ansys/systemcoupling/core/adaptor/impl/syc_proxy.py

@@ -28,7 +28,10 @@ from ansys.systemcoupling.core.adaptor.impl.static_info import (
     make_combined_metadata,
 )
 from ansys.systemcoupling.core.adaptor.impl.syc_proxy_interface import SycProxyInterface
-from ansys.systemcoupling.core.util.state_keys import adapt_native_named_object_keys
+from ansys.systemcoupling.core.util.state_keys import (
+    adapt_client_named_object_keys,
+    adapt_native_named_object_keys,
+)
 
 
 class SycProxy(SycProxyInterface):
@@ -37,13 +40,16 @@ class SycProxy(SycProxyInterface):
         self.__injected_cmds = {}
         self.__version = None
         self.__defunct = False
+        self.__named_obj_level_map: Dict = {}
+        self.__datamodel_metadata = None
 
     def reset_rpc(self, rpc):
         """Reset the original ``rpc`` instance with a new one if the remote connection is lost.
 
         When a remote connection is lost, this method is called, providing an
         ``rpc`` instance that replaces the original one from the initializer.
-        A sensible error is raised if any attempt is made to use this method.
+        The intent is that a sensible error will be raised if any attempt is
+        made to access any attributes on the replacement rpc.
 
         The motivating use case is to catch attempted uses of stale
         objects after the current session has ended.
@@ -66,8 +72,9 @@ class SycProxy(SycProxyInterface):
         if category == "setup":
             cmd_metadata = get_extended_cmd_metadata(self.__rpc)
             root_type = "SystemCoupling"
-            dm_metadata = get_dm_metadata(self.__rpc, root_type)
-            metadata = make_combined_metadata(dm_metadata, cmd_metadata, category)
+            metadata = make_combined_metadata(
+                self._get_datamodel_metadata(root_type), cmd_metadata, category
+            )
         elif category in ("case", "solution"):
             cmd_metadata = get_extended_cmd_metadata(self.__rpc)
             metadata, root_type = make_cmdonly_metadata(cmd_metadata, category)
@@ -81,6 +88,9 @@ class SycProxy(SycProxyInterface):
         return self.__version
 
     def set_state(self, path, state):
+        state = adapt_client_named_object_keys(
+            state, self._get_named_object_level_map(), path.count("/") - 1
+        )
         self.__rpc.SetState(ObjectPath=path, State=state)
 
     def get_state(self, path):
@@ -116,3 +126,23 @@ class SycProxy(SycProxyInterface):
         cmd_name = args[1]
         cmd = self.__injected_cmds.get(cmd_name, None)
         return cmd(**kwargs)
+
+    def _get_datamodel_metadata(self, root_type):
+        if self.__datamodel_metadata is None:
+            self.__datamodel_metadata = get_dm_metadata(self.__rpc, root_type)
+        return self.__datamodel_metadata
+
+    def _get_named_object_level_map(self):
+        if not self.__named_obj_level_map:
+            self._make_named_object_level_map(root_type="SystemCoupling")
+        return self.__named_obj_level_map
+
+    def _make_named_object_level_map(self, root_type):
+        def visit_children(metadata, level):
+            for k, v in metadata["__children"].items():
+                if v["isNamed"]:
+                    self.__named_obj_level_map.setdefault(level, set()).add(k)
+                visit_children(v, level + 1)
+
+        dm_metadata = self._get_datamodel_metadata(root_type)
+        visit_children(dm_metadata[root_type], 0)

ansys/systemcoupling/core/charts/csv_chartdata.py

@@ -32,6 +32,7 @@ from ansys.systemcoupling.core.charts.chart_datatypes import (
     TimestepData,
     TransferSeriesInfo,
 )
+from ansys.systemcoupling.core.util.assertion import assert_
 
 HeaderList = list[str]
 ChartData = list[list[float]]
@@ -231,8 +232,8 @@ def _parse_suffix(header: str, part_disp_name: str) -> str:
 
 def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo:
     intf_info = InterfaceInfo(name=interface_name)
-    assert headers[0] == "Iteration"
-    assert headers[1] == "Step"
+    assert_(headers[0] == "Iteration", 'Header expected to be "Iteration"')
+    assert_(headers[1] == "Step", 'Header expected to be "Step"')
     intf_info.is_transient = headers[2] == "Time"
 
     start_index = 3 if intf_info.is_transient else 2
@@ -263,7 +264,7 @@ def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo
 
             intf_disp_name = intf_or_part_disp_name
             if data_index == 0:
-                assert intf_info.display_name == ""
+                assert_(intf_info.display_name == "", "display_name should be empty")
                 intf_info.display_name = intf_disp_name
             series_info = TransferSeriesInfo(
                 data_index,

ansys/systemcoupling/core/charts/plot_functions.py

@@ -34,8 +34,12 @@ from ansys.systemcoupling.core.charts.plotter import Plotter
 
 
 def create_and_show_plot(spec: PlotSpec, csv_list: list[str]) -> Plotter:
-    assert len(spec.interfaces) == 1, "Plots currently only support one interface"
-    assert len(spec.interfaces) == len(csv_list)
+    if len(spec.interfaces) != 1:
+        raise ValueError("Plots currently only support one interface")
+    if len(spec.interfaces) != len(csv_list):
+        raise ValueError(
+            "'csv_list' should have length equal to the number of interfaces"
+        )
 
     manager = PlotDefinitionManager(spec)
     reader = CsvChartDataReader(spec.interfaces[0].name, csv_list[0])
@@ -61,8 +65,12 @@ def solve_with_live_plot(
     csv_list: list[str],
     solve_func: Callable[[], None],
 ):
-    assert len(spec.interfaces) == 1, "Plots currently only support one interface"
-    assert len(spec.interfaces) == len(csv_list)
+    if len(spec.interfaces) != 1:
+        raise ValueError("Plots currently only support one interface")
+    if len(spec.interfaces) != len(csv_list):
+        raise ValueError(
+            "'csv_list' should have length equal to the number of interfaces"
+        )
 
     manager = PlotDefinitionManager(spec)
     dispatcher = MessageDispatcher()

ansys/systemcoupling/core/charts/plotter.py

@@ -37,6 +37,7 @@ from ansys.systemcoupling.core.charts.chart_datatypes import (
 from ansys.systemcoupling.core.charts.plotdefinition_manager import (
     PlotDefinitionManager,
 )
+from ansys.systemcoupling.core.util.assertion import assert_
 
 
 def _process_timestep_data(
@@ -282,13 +283,13 @@ class Plotter:
         # this (assume the wait function is stored as an
         # attribute):
         #
-        # assert self._wait_for_metadata is not None
+        # assert_(self._wait_for_metadata is not None)
         # metadata = self._wait_for_metadata()
         # if metadata is not None:
         #     self.set_metadata(metadata)
         # else:
         #     return
-        assert self._request_update is not None
+        assert_(self._request_update is not None)
 
         self.ani = FuncAnimation(
             self._fig,

ansys/systemcoupling/core/client/grpc_client.py

@@ -101,6 +101,7 @@ class SycGrpc(object):
         self.__output_thread = None
         self.__pim_instance = None
         self.__skip_exit = False
+        self.__container = None
 
     @classmethod
     def _cleanup(cls):
@@ -161,7 +162,9 @@ class SycGrpc(object):
         """Start the System Coupling container and establish a connection."""
         LOG.debug("Starting container...")
         port = port if port is not None else _find_port()
-        start_container(mounted_from, mounted_to, network, port, version)
+        self.__container = start_container(
+            mounted_from, mounted_to, network, port, version
+        )
         LOG.debug("...started")
         self._connect(_LOCALHOST_IP, port)
 
@@ -307,12 +310,18 @@ class SycGrpc(object):
             try:
                 self.__ostream_service.end_streaming()
             except Exception as e:
-                LOG.debug("Exception on OutputStreamService.end_straming(): " + str(e))
+                LOG.debug(f"Exception on OutputStreamService.end_straming(): {e}")
             self.__process_service.quit()
             self.__channel = None
         if self.__process:
             self.__process.end()
             self.__process = None
+        if self.__container:
+            try:
+                self.__container.stop()
+            except Exception as e:
+                LOG.debug(f"Exception from container.stop(): {e}")
+            self.__container = None
         if self.__pim_instance is not None:
             self.__pim_instance.delete()
             self.__pim_instance = None