ansys-systemcoupling-core 0.9.1__py3-none-any.whl → 0.10.1__py3-none-any.whl

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

@@ -0,0 +1,43 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class update_control(Container):
+    """
+    Configure update controls.
+    """
+
+    syc_name = "UpdateControl"
+
+    property_names_types = [
+        ("option", "Option", "str"),
+        ("update_frequency", "UpdateFrequency", "int"),
+    ]
+
+    @property
+    def option(self) -> str:
+        """Specifies how often the participant will perform updates.
+
+        Possible values:
+
+        - \"ProgramControlled\"
+        - \"EveryIteration\"
+        - \"StepInterval\"
+        - \"Suspended\" """
+        return self.get_property_state("option")
+
+    @option.setter
+    def option(self, value: str):
+        self.set_property_state("option", value)
+
+    @property
+    def update_frequency(self) -> int:
+        """Specify update frequency."""
+        return self.get_property_state("update_frequency")
+
+    @update_frequency.setter
+    def update_frequency(self, value: int):
+        self.set_property_state("update_frequency", value)

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

@@ -0,0 +1,19 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class update_interfaces(Command):
+    """
+    Command to apply transformation and instance defined in the interfaces.
+    And display mapping mesh with the transformation and instance applied in the
+    System Coupling viewer.
+
+    The purpose of this command is to visually confirm the correctness of coupling
+    interfaces definition, alignment and instancing settings, and to allow modifying
+    those settings to fix any issues ("nudge" the alignment, etc.)
+    """
+
+    syc_name = "UpdateInterfaces"

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

@@ -0,0 +1,61 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class update_participant(Command):
+    """
+    Given the name of a participant, updates the state of the participant.
+
+    Available for DEFAULT-SRV, CFD-SRV, MECH-SRV, and SCDT-SRV and
+    AEDT participants.
+
+    As part of the update, System Coupling updates all regions, variables,
+    and parameters defined in the participant, including all variable
+    attributes. Regions, variables, and parameters may be added to the
+    participant but may not be removed.
+
+    You may specify an input file using an optional argument. If an input
+    file is not provided, then the original input file will be reimported.
+
+    Note: AEDT participants must be updated using an scp file.
+
+    If the update process fails, System Coupling displays an error. In this
+    case, you can either update the setup in the participant application to
+    remove any issues with the update process or delete the participant
+    from the analysis and then re-add it using the updated input file.
+
+    Parameters
+    ----------
+    participant_name : str
+        Participant name. Must be the name of an existing participant.
+    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.
+
+    """
+
+    syc_name = "UpdateParticipant"
+
+    argument_names = ["participant_name", "input_file"]
+
+    class participant_name(String):
+        """
+        Participant name. Must be the name of an existing participant.
+        """
+
+        syc_name = "ParticipantName"
+
+    class input_file(String):
+        """
+        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.
+        """
+
+        syc_name = "InputFile"

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

@@ -0,0 +1,20 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .variable_child import variable_child
+
+
+class variable(NamedContainer[variable_child]):
+    """
+    Configure a variable for the coupling participant.
+    """
+
+    syc_name = "Variable"
+
+    child_object_type: variable_child = variable_child
+    """
+    child_object_type of variable.
+    """

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

@@ -0,0 +1,231 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .attribute import attribute
+
+
+class variable_child(Container):
+    """
+    Configure a variable for the coupling participant.
+    """
+
+    syc_name = "child_object_type"
+
+    child_names = ["attribute"]
+
+    attribute: attribute = attribute
+    """
+    attribute child of variable_child.
+    """
+    property_names_types = [
+        ("quantity_type", "QuantityType", "str"),
+        ("location", "Location", "str"),
+        ("participant_display_name", "ParticipantDisplayName", "str"),
+        ("display_name", "DisplayName", "str"),
+        ("data_type", "DataType", "str"),
+        ("real_initial_value", "RealInitialValue", "RealType"),
+        ("integer_initial_value", "IntegerInitialValue", "int"),
+        ("logical_initial_value", "LogicalInitialValue", "bool"),
+        ("string_initial_value", "StringInitialValue", "str"),
+        ("enumeration_initial_value", "EnumerationInitialValue", "int"),
+        ("real_min", "RealMin", "RealType"),
+        ("real_max", "RealMax", "RealType"),
+        ("integer_min", "IntegerMin", "int"),
+        ("integer_max", "IntegerMax", "int"),
+        ("enumeration_min", "EnumerationMin", "int"),
+        ("enumeration_max", "EnumerationMax", "int"),
+        ("tensor_type", "TensorType", "str"),
+        ("is_extensive", "IsExtensive", "bool"),
+    ]
+
+    @property
+    def quantity_type(self) -> str:
+        """Quantity type of the variable.
+
+        Allowed values:
+
+        - \"Unspecified\"
+        - \"Force\"
+        - \"Incremental Displacement\"
+        - \"Temperature\"
+        - \"Heat Rate\"
+        - \"Heat Transfer Coefficient\"
+        - \"Convection Reference Temperature\"
+        - \"Mode Shape\"
+        - \"Electrical Conductivity\" """
+        return self.get_property_state("quantity_type")
+
+    @quantity_type.setter
+    def quantity_type(self, value: str):
+        self.set_property_state("quantity_type", value)
+
+    @property
+    def location(self) -> str:
+        """Data location of the variable (\"Node\" or \"Element\")."""
+        return self.get_property_state("location")
+
+    @location.setter
+    def location(self, value: str):
+        self.set_property_state("location", value)
+
+    @property
+    def participant_display_name(self) -> str:
+        """Variable's display name as defined by the participant solver."""
+        return self.get_property_state("participant_display_name")
+
+    @participant_display_name.setter
+    def participant_display_name(self, value: str):
+        self.set_property_state("participant_display_name", value)
+
+    @property
+    def display_name(self) -> str:
+        """Variable's display name as defined in System Coupling."""
+        return self.get_property_state("display_name")
+
+    @display_name.setter
+    def display_name(self, value: str):
+        self.set_property_state("display_name", value)
+
+    @property
+    def data_type(self) -> str:
+        """Variable's data type as reported by the participant.
+
+        Allowed values (non-FMU case):
+
+        - Real
+        - Complex
+
+        Allowed values (FMU):
+
+        - Real
+        - Integer
+        - Logical
+        - String
+        - Enumeration"""
+        return self.get_property_state("data_type")
+
+    @data_type.setter
+    def data_type(self, value: str):
+        self.set_property_state("data_type", value)
+
+    @property
+    def real_initial_value(self) -> RealType:
+        """Real data start value."""
+        return self.get_property_state("real_initial_value")
+
+    @real_initial_value.setter
+    def real_initial_value(self, value: RealType):
+        self.set_property_state("real_initial_value", value)
+
+    @property
+    def integer_initial_value(self) -> int:
+        """Integer data start value."""
+        return self.get_property_state("integer_initial_value")
+
+    @integer_initial_value.setter
+    def integer_initial_value(self, value: int):
+        self.set_property_state("integer_initial_value", value)
+
+    @property
+    def logical_initial_value(self) -> bool:
+        """Logical data start value."""
+        return self.get_property_state("logical_initial_value")
+
+    @logical_initial_value.setter
+    def logical_initial_value(self, value: bool):
+        self.set_property_state("logical_initial_value", value)
+
+    @property
+    def string_initial_value(self) -> str:
+        """String data start value."""
+        return self.get_property_state("string_initial_value")
+
+    @string_initial_value.setter
+    def string_initial_value(self, value: str):
+        self.set_property_state("string_initial_value", value)
+
+    @property
+    def enumeration_initial_value(self) -> int:
+        """Enumeration data start value."""
+        return self.get_property_state("enumeration_initial_value")
+
+    @enumeration_initial_value.setter
+    def enumeration_initial_value(self, value: int):
+        self.set_property_state("enumeration_initial_value", value)
+
+    @property
+    def real_min(self) -> RealType:
+        """Real data minimum value."""
+        return self.get_property_state("real_min")
+
+    @real_min.setter
+    def real_min(self, value: RealType):
+        self.set_property_state("real_min", value)
+
+    @property
+    def real_max(self) -> RealType:
+        """Real data maximum value."""
+        return self.get_property_state("real_max")
+
+    @real_max.setter
+    def real_max(self, value: RealType):
+        self.set_property_state("real_max", value)
+
+    @property
+    def integer_min(self) -> int:
+        """Integer data minimum value."""
+        return self.get_property_state("integer_min")
+
+    @integer_min.setter
+    def integer_min(self, value: int):
+        self.set_property_state("integer_min", value)
+
+    @property
+    def integer_max(self) -> int:
+        """Integer data maximum value."""
+        return self.get_property_state("integer_max")
+
+    @integer_max.setter
+    def integer_max(self, value: int):
+        self.set_property_state("integer_max", value)
+
+    @property
+    def enumeration_min(self) -> int:
+        """Enumeration data minimum value."""
+        return self.get_property_state("enumeration_min")
+
+    @enumeration_min.setter
+    def enumeration_min(self, value: int):
+        self.set_property_state("enumeration_min", value)
+
+    @property
+    def enumeration_max(self) -> int:
+        """Enumeration data maximum value."""
+        return self.get_property_state("enumeration_max")
+
+    @enumeration_max.setter
+    def enumeration_max(self, value: int):
+        self.set_property_state("enumeration_max", value)
+
+    @property
+    def tensor_type(self) -> str:
+        """Indicates the variable tensor type (\"Scalar\" or \"Vector\").
+
+        \"Vector\" is not supported for the FMU case."""
+        return self.get_property_state("tensor_type")
+
+    @tensor_type.setter
+    def tensor_type(self, value: str):
+        self.set_property_state("tensor_type", value)
+
+    @property
+    def is_extensive(self) -> bool:
+        """Indicates whether this is an extensive property."""
+        return self.get_property_state("is_extensive")
+
+    @is_extensive.setter
+    def is_extensive(self, value: bool):
+        self.set_property_state("is_extensive", value)

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

@@ -0,0 +1,21 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class write_csv_chart_files(Command):
+    """
+    For each coupling interface, exports a CSV file containing chart data
+    (convergence and source/target quantity transfer values) for
+    that interface.
+
+    Each file is named according to the convention ``<interface>.csv``, where
+    ``<interface>`` is the object name of the corresponding coupling interface.
+
+    This command will overwrite any CSV charting files that already exist,
+    including any that were written during the solution.
+    """
+
+    syc_name = "WriteCsvChartFiles"

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

@@ -0,0 +1,46 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class write_ensight(Command):
+    """
+    Write a file with mesh and results which can be loaded into EnSight for
+    post processing.
+
+    Parameters
+    ----------
+    file_name : str
+        Base name for EnSight files. It will generate <base>.encas file which
+        should be loaded into EnSight. Other files are generated for geometry
+        and variables.
+    binary : bool, optional
+        To control if file is to be written in binary format or ASCII. ASCII
+        slows down performance, but may be useful for debugging and seeing
+        raw data.
+
+    """
+
+    syc_name = "WriteEnSight"
+
+    argument_names = ["file_name", "binary"]
+
+    class file_name(String):
+        """
+        Base name for EnSight files. It will generate <base>.encas file which
+        should be loaded into EnSight. Other files are generated for geometry
+        and variables.
+        """
+
+        syc_name = "FileName"
+
+    class binary(Boolean):
+        """
+        To control if file is to be written in binary format or ASCII. ASCII
+        slows down performance, but may be useful for debugging and seeing
+        raw data.
+        """
+
+        syc_name = "Binary"

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

@@ -0,0 +1,32 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class write_target_data(Command):
+    """
+    Command to write target data for target participant after mapping operation.
+
+    The purpose of this command is to write target mesh and target mapped data in
+    the target participant working directory and thus mapping results from SystemCoupling can
+    be check in the target participant.
+
+    Parameters
+    ----------
+    overwrite : bool, optional
+        Flag indicating whether to overwrite the existing target data file. Default value is False.
+
+    """
+
+    syc_name = "WriteTargetData"
+
+    argument_names = ["overwrite"]
+
+    class overwrite(Boolean):
+        """
+        Flag indicating whether to overwrite the existing target data file. Default value is False.
+        """
+
+        syc_name = "Overwrite"

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/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