ansys-systemcoupling-core 0.9.0__tar.gz → 0.9.1__tar.gz

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ansys-systemcoupling-core
-Version: 0.9.0
+Version: 0.9.1
 Summary: A Python wrapper for Ansys System Coupling.
 Author-email: "ANSYS, Inc." <pyansys.support@ansys.com>
 Maintainer-email: PyAnsys developers <pyansys.maintainers@ansys.com>
@@ -31,7 +31,7 @@ Requires-Dist: matplotlib>=3.8.2
 Requires-Dist: build ; extra == "build"
 Requires-Dist: black==25.1.0 ; extra == "classesgen"
 Requires-Dist: isort==6.0.1 ; extra == "classesgen"
-Requires-Dist: ansys-sphinx-theme==1.3.2 ; extra == "doc"
+Requires-Dist: ansys-sphinx-theme==1.4.2 ; extra == "doc"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
 Requires-Dist: matplotlib ; extra == "doc"
 Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
@@ -48,7 +48,7 @@ Requires-Dist: sphinxemoji==0.3.1 ; extra == "doc"
 Requires-Dist: ansys-fluent-core==0.29.0 ; extra == "doc"
 Requires-Dist: ansys-mapdl-core==0.69.3 ; extra == "doc"
 Requires-Dist: codespell==2.4.1 ; extra == "style"
-Requires-Dist: flake8==7.1.2 ; extra == "style"
+Requires-Dist: flake8==7.2.0 ; extra == "style"
 Requires-Dist: pytest ; extra == "tests"
 Requires-Dist: pytest-cov ; extra == "tests"
 Requires-Dist: psutil>=5.7.0 ; extra == "tests"

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.9.1}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
 name = "ansys-systemcoupling-core"
-version = "0.9.0"
+version = "0.9.1"
 description = "A Python wrapper for Ansys System Coupling."
 readme = "README.rst"
 requires-python = ">=3.10,<3.14"
@@ -57,7 +57,7 @@ classesgen = [
 	"isort==6.0.1",
 ]
 doc = [
-	"ansys-sphinx-theme==1.3.2",
+	"ansys-sphinx-theme==1.4.2",
 	"jupyter_sphinx==0.5.3",
 	"matplotlib",
 	"numpydoc==1.8.0",
@@ -79,7 +79,7 @@ doc = [
 style = [
 	# NB: ensure these remain synced with .pre-commit-config.yaml
 	"codespell==2.4.1",
-	"flake8==7.1.2",
+	"flake8==7.2.0",
 ]
 tests = [
 	"pytest",

{ansys_systemcoupling_core-0.9.0 → ansys_systemcoupling_core-0.9.1}/src/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-0.9.0 → ansys_systemcoupling_core-0.9.1}/src/ansys/systemcoupling/core/util/state_keys.py

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 import copy
+from typing import Any, Dict, Set
 
 
 def adapt_native_named_object_keys(state):
@@ -74,7 +75,9 @@ def adapt_native_named_object_keys_in_place(state):
         del state[k]
 
 
-def adapt_client_named_object_keys(state, level_type_map):
+def adapt_client_named_object_keys(
+    state: Dict[str, Any], level_type_map: Dict[int, Set[str]], start_level: int = 0
+) -> Dict[str, Any]:
     """Transform a System Coupling client-style nested state dictionary
     to an equivalent native format.
 
@@ -89,12 +92,18 @@ def adapt_client_named_object_keys(state, level_type_map):
 
     Parameters
     ----------
+    state: dict
+        The nested state dictionary to transform to the native format.
     level_type_map: dict
         Dictionary from the integer nest level (0-based) to sets of
         named object types at this level. Note that the level is
         the data model level. This means it does not include the extra
         levels introduced by the client-side format but more closely
         aligns with the target native format.
+    start_level: int, optional
+        If state is a sub-state of a larger state, and the level_type_map
+        is for the larger state, then this parameter can be used to
+        provide a starting level for the transformation.
     """
 
     def do_adapt(s, level=0):
@@ -110,4 +119,4 @@ def adapt_client_named_object_keys(state, level_type_map):
                 state_out[id] = copy.copy(sub_state)
         return state_out
 
-    return do_adapt(state)
+    return do_adapt(state, level=start_level)

ansys_systemcoupling_core-0.9.0/src/ansys/systemcoupling/core/adaptor/api_25_2/_add_participant.py

@@ -1,80 +0,0 @@
-#
-# 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-0.9.0/src/ansys/systemcoupling/core/adaptor/api_25_2/_clear_state.py

@@ -1,13 +0,0 @@
-#
-# 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-0.9.0/src/ansys/systemcoupling/core/adaptor/api_25_2/_solve.py

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

ansys_systemcoupling_core-0.9.0/src/ansys/systemcoupling/core/adaptor/api_25_2/abort.py

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

ansys_systemcoupling_core-0.9.0/src/ansys/systemcoupling/core/adaptor/api_25_2/activate_hidden.py

@@ -1,46 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-
-class activate_hidden(Container):
-    """
-    Contains settings to control exposure of hidden features.
-    """
-
-    syc_name = "ActivateHidden"
-
-    property_names_types = [
-        ("beta_features", "BetaFeatures", "bool"),
-        ("alpha_features", "AlphaFeatures", "bool"),
-        ("lenient_validation", "LenientValidation", "bool"),
-    ]
-
-    @property
-    def beta_features(self) -> bool:
-        """Turn on exposure of Beta features."""
-        return self.get_property_state("beta_features")
-
-    @beta_features.setter
-    def beta_features(self, value: bool):
-        self.set_property_state("beta_features", value)
-
-    @property
-    def alpha_features(self) -> bool:
-        """Turn on exposure of Alpha features. (Beta features must be turned on first)"""
-        return self.get_property_state("alpha_features")
-
-    @alpha_features.setter
-    def alpha_features(self, value: bool):
-        self.set_property_state("alpha_features", value)
-
-    @property
-    def lenient_validation(self) -> bool:
-        """Allow a case with zero participants and zero coupling interfaces to be set up."""
-        return self.get_property_state("lenient_validation")
-
-    @lenient_validation.setter
-    def lenient_validation(self, value: bool):
-        self.set_property_state("lenient_validation", value)

ansys_systemcoupling_core-0.9.0/src/ansys/systemcoupling/core/adaptor/api_25_2/add_aerodamping_data_transfers.py

@@ -1,43 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-
-class add_aerodamping_data_transfers(Command):
-    """
-    Adds data transfer for each specified mode shape.
-
-    Returns the name of the Data Transfers created.
-
-    Parameters
-    ----------
-    interface : str
-        String indicating the name of the interface on which the data transfer
-        is to be created.
-    mode_shapes : List, optional
-        List of mode shapes to transfer. If not provided, a
-        data transfer is created for each available modeshape.
-
-    """
-
-    syc_name = "AddAerodampingDataTransfers"
-
-    argument_names = ["interface", "mode_shapes"]
-
-    class interface(String):
-        """
-        String indicating the name of the interface on which the data transfer
-        is to be created.
-        """
-
-        syc_name = "Interface"
-
-    class mode_shapes(StringList):
-        """
-        List of mode shapes to transfer. If not provided, a
-        data transfer is created for each available modeshape.
-        """
-
-        syc_name = "ModeShapes"

ansys_systemcoupling_core-0.9.0/src/ansys/systemcoupling/core/adaptor/api_25_2/add_data_transfer.py

@@ -1,190 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-
-class add_data_transfer(Command):
-    """
-    Adds data transfer based on arguments that specify the interface, target
-    side, and variables to be associated with each side of the interface.
-    The command requires that you specify variables using their names (see
-    parameter descriptions for details). Either a variable-based or
-    expression-based data transfer may be created with this command based on
-    the arguments provided. If a variable-based data transfer argument
-    is given, then no expression-based data transfer arguments can be used. If
-    an expression-based data transfer argument is given, then no variable-based
-    data transfer arguments can be used.
-
-    Cannot be run after participants have been started.
-
-    Returns the name of the Data Transfer created.
-
-    Parameters
-    ----------
-    interface : str
-        String indicating the name of the interface on which the data transfer
-        is to be created.
-    target_side : str
-        String indicating the side of the interface to receive the data
-        transfer variable. Possible values are \"One\" or \"Two\".
-    source_variable : str, optional
-        String specifying the name of the variable on the source side of
-        the data transfer. Used when creating a variable-based data transfer.
-        Must be combined with ``target_variable``.
-    target_variable : str, optional
-        String specifying the name of the variable on the target side of
-        the data transfer. Must be combined with either ``source_variable`` (when
-        creating a variable-based data transfer) or with ``value`` (or
-        ``value_{x|y|z}`` (when creating an expression-based data transfer).
-    value : str, optional
-        String specifying the expression to use on the source side of the data
-        transfer. Used when creating an expression-based data transfer. If the
-        ``target_variable`` is a vector, a vector-valued expression must be provided.
-        Alternatively, ``value_x``, ``value_y``, ``value_z`` may be used to specify the
-        individual components of the vector expression.
-    value_x : str, optional
-        String specifying the X component of the expression to use on the
-        source side of the data transfer. This may optionally be used when creating
-        an expression-based data transfer if the ``target_variable`` is a vector as an
-        alternative to specifying a vector-valued expression in ``value`. ``value_y`` and
-        ``value_z`` are also required if ``value_x`` is used.
-    value_y : str, optional
-        String specifying the Y component of the expression to use on the
-        source side of the data transfer. This may optionally be used when creating
-        an expression-based data transfer if the ``target_variable`` is a vector as an
-        alternative to specifying a vector-valued expression in ``value``. ``value_x`` and
-        ``value_z`` are also required if ``value_y`` is used.
-    value_z : str, optional
-        String specifying the Z component of the expression to use on the
-        source side of the data transfer. This may optionally be used when creating
-        an expression-based data transfer if the ``target_variable`` is a vector as an
-        alternative to specifying a vector-valued expression in ``value``. ``value_x`` and
-        ``value_y`` are also required if ``value_z`` is used.
-    side_one_variable : str, optional
-        String specifying the name of the variable associated with side1
-        of the interface. Must be combined with ``side_two_variable``. Used only
-        when creating variable-based data transfers. Consider using
-        ``source_variable``/``target_variable`` parameters instead.
-    side_two_variable : str, optional
-        String specifying the name of the variable associated with side2
-        of the interface. Must be combined with ``side_two_variable``. Used only
-        when creating variable-based data transfers. Consider using
-        ``source_variable``/``target_variable`` parameters instead.
-
-    """
-
-    syc_name = "AddDataTransfer"
-
-    argument_names = [
-        "interface",
-        "target_side",
-        "source_variable",
-        "target_variable",
-        "value",
-        "value_x",
-        "value_y",
-        "value_z",
-        "side_one_variable",
-        "side_two_variable",
-    ]
-
-    class interface(String):
-        """
-        String indicating the name of the interface on which the data transfer
-        is to be created.
-        """
-
-        syc_name = "Interface"
-
-    class target_side(String):
-        """
-        String indicating the side of the interface to receive the data
-        transfer variable. Possible values are \"One\" or \"Two\".
-        """
-
-        syc_name = "TargetSide"
-
-    class source_variable(String):
-        """
-        String specifying the name of the variable on the source side of
-        the data transfer. Used when creating a variable-based data transfer.
-        Must be combined with ``target_variable``.
-        """
-
-        syc_name = "SourceVariable"
-
-    class target_variable(String):
-        """
-        String specifying the name of the variable on the target side of
-        the data transfer. Must be combined with either ``source_variable`` (when
-        creating a variable-based data transfer) or with ``value`` (or
-        ``value_{x|y|z}`` (when creating an expression-based data transfer).
-        """
-
-        syc_name = "TargetVariable"
-
-    class value(String):
-        """
-        String specifying the expression to use on the source side of the data
-        transfer. Used when creating an expression-based data transfer. If the
-        ``target_variable`` is a vector, a vector-valued expression must be provided.
-        Alternatively, ``value_x``, ``value_y``, ``value_z`` may be used to specify the
-        individual components of the vector expression.
-        """
-
-        syc_name = "Value"
-
-    class value_x(String):
-        """
-        String specifying the X component of the expression to use on the
-        source side of the data transfer. This may optionally be used when creating
-        an expression-based data transfer if the ``target_variable`` is a vector as an
-        alternative to specifying a vector-valued expression in ``value`. ``value_y`` and
-        ``value_z`` are also required if ``value_x`` is used.
-        """
-
-        syc_name = "ValueX"
-
-    class value_y(String):
-        """
-        String specifying the Y component of the expression to use on the
-        source side of the data transfer. This may optionally be used when creating
-        an expression-based data transfer if the ``target_variable`` is a vector as an
-        alternative to specifying a vector-valued expression in ``value``. ``value_x`` and
-        ``value_z`` are also required if ``value_y`` is used.
-        """
-
-        syc_name = "ValueY"
-
-    class value_z(String):
-        """
-        String specifying the Z component of the expression to use on the
-        source side of the data transfer. This may optionally be used when creating
-        an expression-based data transfer if the ``target_variable`` is a vector as an
-        alternative to specifying a vector-valued expression in ``value``. ``value_x`` and
-        ``value_y`` are also required if ``value_z`` is used.
-        """
-
-        syc_name = "ValueZ"
-
-    class side_one_variable(String):
-        """
-        String specifying the name of the variable associated with side1
-        of the interface. Must be combined with ``side_two_variable``. Used only
-        when creating variable-based data transfers. Consider using
-        ``source_variable``/``target_variable`` parameters instead.
-        """
-
-        syc_name = "SideOneVariable"
-
-    class side_two_variable(String):
-        """
-        String specifying the name of the variable associated with side2
-        of the interface. Must be combined with ``side_two_variable``. Used only
-        when creating variable-based data transfers. Consider using
-        ``source_variable``/``target_variable`` parameters instead.
-        """
-
-        syc_name = "SideTwoVariable"