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

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_status_messages.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -312,14 +312,21 @@ def get_extended_cmd_metadata(api) -> list:
     """
 
     def fix_up_doc(cmd_metadata):
-        if get_syc_version(api) != "24.2":
+        version = get_syc_version(api)
+        if version not in ("24.2", "25.1"):
             return cmd_metadata
 
-        # There is a bug in doc text queried from 24.2 SyC. The "*" need
-        # to be escaped to avoid issues in Sphinx. This can be a surgical
-        # fix because 24.2 is frozen now.
+        command_to_fix = None
+        if version == "24.2":
+            command_to_fix = "add_participant"
+        elif version == "25.1":
+            command_to_fix = "update_participant"
+
+        # There are bugs in doc text queried from 24.2 and 25.1 SyC.
+        # The "*" need to be escaped to avoid issues in Sphinx. This
+        # can be a surgical fix because these versions are frozen now.
         for cmd in cmd_metadata:
-            if cmd["pyname"] == "add_participant":
+            if cmd["pyname"] == command_to_fix:
                 add_part_cmd = cmd
                 for arg_name, arg_info in add_part_cmd["args"]:
                     if arg_name == "InputFile":

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/charts/chart_datatypes.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/charts/csv_chartdata.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -245,6 +245,17 @@ def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo
         series_type, intf_or_part_disp_name, trans_disp_name = _parse_header(header)
         if series_type == SeriesType.CONVERGENCE:
             prev_part_name = ""
+
+            # If there are no convergence headings, transfer_disambig will
+            # remain unpopulated. In this case, assume for now that there
+            # is no ambiguity. Although not strictly correct, this is a
+            # reasonable assumption for the majority of cases.
+            # TODO: look for alternative method to determine a
+            # disambiguation index in the case of no convergence headers.
+            # If this is not possible, look for a way to detect that
+            # data transfers are ambiguous and raise an exception or
+            # warn and skip plotting.
+
             if trans_disp_name in transfer_disambig:
                 transfer_disambig[trans_disp_name] += 1
             else:
@@ -258,7 +269,8 @@ def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo
                 data_index,
                 series_type,
                 transfer_display_name=trans_disp_name,
-                disambiguation_index=transfer_disambig[trans_disp_name],
+                # get(..., 0) for case where transfer_disambig empty (see note above)
+                disambiguation_index=transfer_disambig.get(trans_disp_name, 0),
             )
             intf_info.transfer_info.append(series_info)
         else:
@@ -276,7 +288,9 @@ def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo
                             data_index,
                             series_type,
                             transfer_display_name=trans_disp_name,
-                            disambiguation_index=transfer_disambig[trans_disp_name],
+                            disambiguation_index=transfer_disambig.get(
+                                trans_disp_name, 0
+                            ),
                             participant_display_name=part_disp_name,
                             line_suffixes=[suffix],
                         )
@@ -292,7 +306,7 @@ def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo
                         data_index,
                         series_type,
                         transfer_display_name=trans_disp_name,
-                        disambiguation_index=transfer_disambig[trans_disp_name],
+                        disambiguation_index=transfer_disambig.get(trans_disp_name, 0),
                         participant_display_name=part_disp_name,
                     )
                 )

ansys/systemcoupling/core/charts/live_csv_datasource.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/charts/message_dispatcher.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/charts/plot_functions.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/charts/plotdefinition_manager.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/charts/plotter.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/client/grpc_client.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -137,7 +137,16 @@ class SycGrpc(object):
                 _LOCALHOST_IP, port, working_dir, version, **kwargs
             )
             LOG.debug("...started")
-            self._connect(_LOCALHOST_IP, port)
+            try:
+                self._connect(_LOCALHOST_IP, port)
+            except Exception as e:
+                if "v251" in self.__process.path_to_system_coupling:
+                    e.args += (
+                        "Connection will fail if you are running an "
+                        "unpatched version of System Coupling 25 R1. ",
+                    )
+                raise
+
         if start_output:
             self.start_output()
 

ansys/systemcoupling/core/client/services/command_query.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -21,9 +21,9 @@
 # SOFTWARE.
 
 import ansys.api.systemcoupling.v0.command_pb2_grpc as command_pb2_grpc
-import ansys.api.systemcoupling.v0.error_pb2 as syc_error_pb2
 import grpc
-from grpc_status.rpc_status import from_call
+
+from ansys.systemcoupling.core.client.services.handle_rpc_error import handle_rpc_error
 
 
 class CommandQueryService:
@@ -35,14 +35,5 @@ class CommandQueryService:
             response, call = self.__stub.InvokeCommand.with_call(request)
             return response, call.trailing_metadata()
         except grpc.RpcError as rpc_error:
-            status = from_call(rpc_error)
-            msg = f"Command execution failed: {status.message} (code={status.code})"
-            for detail in status.details:
-                if detail.Is(syc_error_pb2.ErrorDetails.DESCRIPTOR):
-                    info = syc_error_pb2.ErrorDetails()
-                    detail.Unpack(info)
-                    msg += (
-                        f"\n\nServer exception details:\n"
-                        f"{info.exception_classname}\n{info.stack_trace}"
-                    )
+            msg = handle_rpc_error(rpc_error)
             raise RuntimeError(msg) from None

ansys/systemcoupling/core/client/services/handle_rpc_error.py

@@ -0,0 +1,64 @@
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+import ansys.api.systemcoupling.v0.error_pb2 as syc_error_pb2
+import grpc
+from grpc_status.rpc_status import from_call
+
+
+def _error_details_msg(error_details: syc_error_pb2) -> str:
+    return (
+        f"Command or query execution failed with error: {error_details.exception_classname}"
+        f"\n\nServer stacktrace:\n{error_details.stack_trace}"
+    )
+
+
+def _check_for_syc_exception(rpc_error):
+    # grpc_status is not available in some server versions so
+    # check for bespoke method of returning error details via
+    # trailing metadata.
+    meta = rpc_error.trailing_metadata()
+    if meta is not None:
+        for key, value in meta:
+            if key == "syc-exception-bin":
+                error_details = syc_error_pb2.ErrorDetails()
+                error_details.ParseFromString(value)
+                return _error_details_msg(error_details)
+    return None
+
+
+def handle_rpc_error(rpc_error: grpc.RpcError):
+    msg = _check_for_syc_exception(rpc_error)
+    if msg is not None:
+        return msg
+
+    status = from_call(rpc_error)
+    if status is None:
+        return "Command or query execution failed. No details available."
+
+    msg = f"Command execution failed: {status.message} (code={status.code})"
+    for detail in status.details:
+        if detail.Is(syc_error_pb2.ErrorDetails.DESCRIPTOR):
+            error_details = syc_error_pb2.ErrorDetails()
+            detail.Unpack(error_details)
+            msg += _error_details_msg(error_details)
+    return msg

ansys/systemcoupling/core/client/services/output_stream.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/systemcoupling/core/client/services/process.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #