ansys-systemcoupling-core 0.7.0__tar.gz → 0.11.0__tar.gz

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.11.0}/LICENSE

@@ -1,13 +1,13 @@
 MIT License
 
-Copyright (c) 2021 ANSYS, Inc. All rights reserved. 
+Copyright (c) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
 
-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:
+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.

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.11.0}/PKG-INFO

@@ -1,10 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ansys-systemcoupling-core
-Version: 0.7.0
+Version: 0.11.0
 Summary: A Python wrapper for Ansys System Coupling.
 Author-email: "ANSYS, Inc." <pyansys.support@ansys.com>
 Maintainer-email: PyAnsys developers <pyansys.maintainers@ansys.com>
-Requires-Python: >=3.10,<3.13
+Requires-Python: >=3.10,<3.14
 Description-Content-Type: text/x-rst
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Science/Research
@@ -16,10 +16,13 @@ Classifier: Operating System :: MacOS
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+License-File: LICENSE
 Requires-Dist: ansys-api-systemcoupling==0.2.0
 Requires-Dist: ansys-platform-instancemanagement~=1.0
+Requires-Dist: docker>=7.1.0
 Requires-Dist: grpcio>=1.30.0
-Requires-Dist: grpcio-status>=1.30.0,<1.66.2
+Requires-Dist: grpcio-status>=1.30.0
 Requires-Dist: googleapis-common-protos>=1.50.0
 Requires-Dist: psutil>=5.7.0
 Requires-Dist: pyyaml
@@ -27,27 +30,26 @@ Requires-Dist: appdirs>=1.4.0
 Requires-Dist: importlib-metadata>=4.0
 Requires-Dist: matplotlib>=3.8.2
 Requires-Dist: build ; extra == "build"
-Requires-Dist: black==24.8.0 ; extra == "classesgen"
-Requires-Dist: isort==5.13.2 ; extra == "classesgen"
-Requires-Dist: ansys-sphinx-theme==1.0.7 ; extra == "doc"
+Requires-Dist: black==25.11.0 ; extra == "classesgen"
+Requires-Dist: isort==7.0.0 ; extra == "classesgen"
+Requires-Dist: ansys-sphinx-theme==1.6.3 ; extra == "doc"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
 Requires-Dist: matplotlib ; extra == "doc"
-Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
-Requires-Dist: pypandoc==1.13 ; extra == "doc"
+Requires-Dist: numpydoc==1.9.0 ; extra == "doc"
+Requires-Dist: pypandoc==1.16.2 ; extra == "doc"
 Requires-Dist: pytest-sphinx==0.6.3 ; extra == "doc"
-Requires-Dist: Sphinx==8.0.2 ; extra == "doc"
-Requires-Dist: sphinx-autobuild==2024.4.16 ; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints==2.3.0 ; extra == "doc"
+Requires-Dist: sphinx>=8.1.3 ; extra == "doc"
+Requires-Dist: sphinx-autobuild==2024.10.3 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==3.1.0 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
-Requires-Dist: sphinx-gallery==0.17.1 ; extra == "doc"
-Requires-Dist: sphinx-notfound-page==1.0.4 ; extra == "doc"
+Requires-Dist: sphinx-gallery==0.19.0 ; extra == "doc"
+Requires-Dist: sphinx-notfound-page==1.1.0 ; extra == "doc"
 Requires-Dist: sphinxcontrib-websupport==2.0.0 ; extra == "doc"
 Requires-Dist: sphinxemoji==0.3.1 ; extra == "doc"
-Requires-Dist: ansys-fluent-core==0.24.2 ; extra == "doc"
-Requires-Dist: ansys-dpf-core==0.13.0 ; extra == "doc"
-Requires-Dist: ansys-mapdl-core==0.68.4 ; extra == "doc"
-Requires-Dist: codespell==2.3.0 ; extra == "style"
-Requires-Dist: flake8==7.1.1 ; extra == "style"
+Requires-Dist: ansys-fluent-core==0.35.0 ; extra == "doc"
+Requires-Dist: ansys-mapdl-core==0.71.1 ; extra == "doc"
+Requires-Dist: codespell==2.4.1 ; extra == "style"
+Requires-Dist: flake8==7.3.0 ; extra == "style"
 Requires-Dist: pytest ; extra == "tests"
 Requires-Dist: pytest-cov ; extra == "tests"
 Requires-Dist: psutil>=5.7.0 ; extra == "tests"
@@ -136,16 +138,34 @@ in this order:
 
 * ``SYSC_ROOT``
 * ``AWP_ROOT``
-* ``AWP_ROOT242``
+* ``AWP_ROOT252``
 
 If a variable is set but does not refer to a valid installation, PySystemCoupling
 fails at that point, rather than attempting to use the next variable.
 
-In a standard user installation, the expectation is that only ``AWP_ROOT242`` is set.
+In a standard user installation, the expectation is that only ``AWP_ROOT252`` is set.
 
 (It is also possible to provide a different version number as an argument to the ``launch()``
 function. This will affect which ``AWP_ROOT<version>`` environment variable is examined.)
 
+   **WARNING**
+
+   Note that the following applies only to the 25 R1 release of Ansys System Coupling.
+
+   There is an issue with the 25 R1 release of Ansys System Coupling that prevents it from
+   working in the gRPC server mode on which PySystemCoupling depends. A small patch
+   is available that may be applied to some of the Python files in the System Coupling
+   installation. This is provided in the ``patches/`` directory of this repository and will
+   allow System Coupling 25 R1 to work with PySystemCoupling releases 0.9 and later.
+
+   This issue is not present in later releases of System Coupling. If a later release
+   is available, you are recommended to use that.
+
+   Alternatively, PySystemCoupling can be used with an earlier release of System Coupling by
+   setting the environment variable ``AWP_ROOT`` or specifying the version number as an
+   argument to the ``launch()`` function.
+
+
 The System Coupling API is exposed to PySystemCoupling in two forms:
 
 * A documented interface based on concrete Python classes, following Pythonic conventions
@@ -157,7 +177,7 @@ familiar with System Coupling, adjusting to this form, which is the recommended
 However, if you are transitioning existing scripts, the native System Coupling API is made available
 as a convenience.
 
-.. note::
+   **Note**
 
    While most commands should work as expected via the native System Coupling API,
    no guarantees can be given because of the nature of how it is exposed.

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.11.0}/README.rst

@@ -73,16 +73,34 @@ in this order:
 
 * ``SYSC_ROOT``
 * ``AWP_ROOT``
-* ``AWP_ROOT242``
+* ``AWP_ROOT252``
 
 If a variable is set but does not refer to a valid installation, PySystemCoupling
 fails at that point, rather than attempting to use the next variable.
 
-In a standard user installation, the expectation is that only ``AWP_ROOT242`` is set.
+In a standard user installation, the expectation is that only ``AWP_ROOT252`` is set.
 
 (It is also possible to provide a different version number as an argument to the ``launch()``
 function. This will affect which ``AWP_ROOT<version>`` environment variable is examined.)
 
+   **WARNING**
+
+   Note that the following applies only to the 25 R1 release of Ansys System Coupling.
+
+   There is an issue with the 25 R1 release of Ansys System Coupling that prevents it from
+   working in the gRPC server mode on which PySystemCoupling depends. A small patch
+   is available that may be applied to some of the Python files in the System Coupling
+   installation. This is provided in the ``patches/`` directory of this repository and will
+   allow System Coupling 25 R1 to work with PySystemCoupling releases 0.9 and later.
+
+   This issue is not present in later releases of System Coupling. If a later release
+   is available, you are recommended to use that.
+
+   Alternatively, PySystemCoupling can be used with an earlier release of System Coupling by
+   setting the environment variable ``AWP_ROOT`` or specifying the version number as an
+   argument to the ``launch()`` function.
+
+
 The System Coupling API is exposed to PySystemCoupling in two forms:
 
 * A documented interface based on concrete Python classes, following Pythonic conventions
@@ -94,7 +112,7 @@ familiar with System Coupling, adjusting to this form, which is the recommended
 However, if you are transitioning existing scripts, the native System Coupling API is made available
 as a convenience.
 
-.. note::
+   **Note**
 
    While most commands should work as expected via the native System Coupling API,
    no guarantees can be given because of the nature of how it is exposed.

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.11.0}/pyproject.toml

@@ -5,10 +5,10 @@ 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.7.0"
+version = "0.11.0"
 description = "A Python wrapper for Ansys System Coupling."
 readme = "README.rst"
-requires-python = ">=3.10,<3.13"
+requires-python = ">=3.10,<3.14"
 license = {file = "LICENSE"}
 authors = [
     {name = "ANSYS, Inc.", email = "pyansys.support@ansys.com"},
@@ -19,8 +19,9 @@ maintainers = [
 dependencies = [
     "ansys-api-systemcoupling==0.2.0",
     "ansys-platform-instancemanagement~=1.0",
+    "docker>=7.1.0",
     "grpcio>=1.30.0",
-    "grpcio-status>=1.30.0,<1.66.2",
+    "grpcio-status>=1.30.0",
     "googleapis-common-protos>=1.50.0",
     "psutil>=5.7.0",
     "pyyaml",
@@ -39,6 +40,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
 
 [project.optional-dependencies]
@@ -52,34 +54,33 @@ classesgen = [
 	# black and isort are called programmatically to keep generated code
 	# consistent with style elsewhere. We need to keep these versions in
 	# sync with the precommit dependencies.
-	"black==24.8.0",
-	"isort==5.13.2",
+	"black==25.11.0",
+	"isort==7.0.0",
 ]
 doc = [
-	"ansys-sphinx-theme==1.0.7",
+	"ansys-sphinx-theme==1.6.3",
 	"jupyter_sphinx==0.5.3",
 	"matplotlib",
-	"numpydoc==1.8.0",
-	"pypandoc==1.13",
+	"numpydoc==1.9.0",
+	"pypandoc==1.16.2",
 	"pytest-sphinx==0.6.3",
-	"Sphinx==8.0.2",
-	"sphinx-autobuild==2024.4.16",
-	"sphinx-autodoc-typehints==2.3.0",
+	"sphinx>=8.1.3",
+	"sphinx-autobuild==2024.10.3",
+	"sphinx-autodoc-typehints==3.1.0",
 	"sphinx-copybutton==0.5.2",
-	"sphinx-gallery==0.17.1",
-	"sphinx-notfound-page==1.0.4",
+	"sphinx-gallery==0.19.0",
+	"sphinx-notfound-page==1.1.0",
 	"sphinxcontrib-websupport==2.0.0",
 	"sphinxemoji==0.3.1",
 
 	# pyansys dependencies for sphinx gallery examples
-	"ansys-fluent-core==0.24.2",
-	"ansys-dpf-core==0.13.0",
-	"ansys-mapdl-core==0.68.4",
+	"ansys-fluent-core==0.35.0",
+	"ansys-mapdl-core==0.71.1",
 ]
 style = [
 	# NB: ensure these remain synced with .pre-commit-config.yaml
-	"codespell==2.3.0",
-	"flake8==7.1.1",
+	"codespell==2.4.1",
+	"flake8==7.3.0",
 ]
 tests = [
 	"pytest",

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.11.0}/src/ansys/systemcoupling/core/__init__.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
 #
 #
@@ -25,7 +25,7 @@ from typing import List
 
 import appdirs
 
-from ansys.systemcoupling.core.client.grpc_client import SycGrpc
+from ansys.systemcoupling.core.client.grpc_client import SycGrpc, ConnectionType
 from ansys.systemcoupling.core.session import Session
 from ansys.systemcoupling.core.util.logging import LOG
 
@@ -41,6 +41,7 @@ __version__ = importlib_metadata.version(__name__.replace(".", "-"))
 
 def launch(
     *,
+    connection_type: ConnectionType = ConnectionType.SECURE_LOCAL,
     port: int = None,
     working_dir: str = None,
     nprocs: int = None,
@@ -53,6 +54,12 @@ def launch(
 
     Parameters
     ----------
+    connection_type: ConnectionType, optional
+        Specifies the type of connection to make with the launched server.
+        See :class:`ConnectionType` for available options.
+        Not all options are currently supported. The default is a secure
+        local connection. This will not work with some older versions or
+        older versions that have not been updated with service pack releases.
     port : int, optional
         Port on which to connect to System Coupling. The default is
         ``None``, in which case an available port is found and used.
@@ -72,9 +79,11 @@ def launch(
         (The forms ``"24.1"`` and ``"24_1"`` are also acceptable.)
         The version will be sought in the standard installation location. The
         default is ``None``, which is equivalent to specifying
-        ``"242"`` ("2024 R2" release), unless either of the environment
-        variables ``SYSC_ROOT`` or ``AWP_ROOT`` has been set. It is considered
-        to be an error if either these is set *and* ``version`` is provided.
+        ``"252"`` ("2025 R2" release), unless either of the environment
+        variables ``SYSC_ROOT`` or ``AWP_ROOT`` has been set. In that case,
+        the environment variable will be used to locate System Coupling.
+        If ``version`` is also provided, it will not be used to locate System
+        Coupling but it might still be used to infer some information about it.
     start_output: bool, optional
         Boolean to specify if the user wants to stream system coupling output.
         The default is ``False``, in which case the output stream is kept hidden.
@@ -102,6 +111,7 @@ def launch(
         rpc.start_pim_and_connect(version, start_output)
     else:
         rpc.start_and_connect(
+            connection_type=connection_type,
             port=port,
             working_dir=working_dir,
             nprocs=nprocs,
@@ -163,7 +173,9 @@ def launch_remote(
     return Session(rpc)
 
 
-def connect(host: str, port: int) -> Session:  # pragma: no cover
+def connect(
+    host: str, port: int, connection_type: ConnectionType = ConnectionType.SECURE_LOCAL
+) -> Session:  # pragma: no cover
     """Connect to an instance of System Coupling already running in server mode.
 
     Parameters
@@ -172,6 +184,14 @@ def connect(host: str, port: int) -> Session:  # pragma: no cover
         IP address of the system running the System Coupling instance.
     port : int
         Port on which to connect to System Coupling.
+    connection_type: ConnectionType, optional
+        Specifies the type of connection to make with System Coupling.
+        See :class:`ConnectionType` for available options.
+        This must be compatible with the mode in which the server was
+        started. The default is a secure local connection. This will
+        not work with some older versions of System Coupling or versions
+        that have not been updated with service pack releases. In these
+        cases, an insecure connection type must be specified.
 
     Returns
     -------
@@ -180,7 +200,7 @@ def connect(host: str, port: int) -> Session:  # pragma: no cover
         remote System Coupling instance.
     """
     rpc = SycGrpc()
-    rpc.connect(host, port)
+    rpc.connect(host, port, connection_type)
     syc = Session(rpc)
     return syc
 

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.11.0}/src/ansys/systemcoupling/core/_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-0.11.0/src/ansys/systemcoupling/core/adaptor/api_25_1/instancing.py

@@ -0,0 +1,25 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .instancing_child import instancing_child
+
+
+class instancing(NamedContainer[instancing_child]):
+    """
+    Define instancing for an interface side.
+
+    Available when cylindrical geometry instancing has been added to
+    the data model.
+
+    ``RotationAxis`` controls how the axis of rotation is defined.
+    """
+
+    syc_name = "Instancing"
+
+    child_object_type: instancing_child = instancing_child
+    """
+    child_object_type of instancing.
+    """

ansys_systemcoupling_core-0.11.0/src/ansys/systemcoupling/core/adaptor/api_25_1/instancing_child.py

@@ -0,0 +1,114 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class instancing_child(Container):
+    """
+    Define instancing for an interface side.
+
+    Available when cylindrical geometry instancing has been added to
+    the data model.
+
+    ``RotationAxis`` controls how the axis of rotation is defined.
+    """
+
+    syc_name = "child_object_type"
+
+    property_names_types = [
+        ("rotation_axis", "RotationAxis", "str"),
+        ("instances_in_full_circle", "InstancesInFullCircle", "int"),
+        ("instances_for_mapping", "InstancesForMapping", "int"),
+        ("reference_frame", "ReferenceFrame", "str"),
+        ("axis", "Axis", "str"),
+        ("axis_from", "AxisFrom", "RealVectorType"),
+        ("axis_to", "AxisTo", "RealVectorType"),
+        ("rotational_offset", "RotationalOffset", "RealType"),
+    ]
+
+    @property
+    def rotation_axis(self) -> str:
+        """UNDOCUMENTED"""
+        return self.get_property_state("rotation_axis")
+
+    @rotation_axis.setter
+    def rotation_axis(self, value: str):
+        self.set_property_state("rotation_axis", value)
+
+    @property
+    def instances_in_full_circle(self) -> int:
+        """Total number of instances (including the first instance) in
+        a full 360 degree rotation of the participant mesh. This value
+        includes the reference instance (with the participant mesh).
+        All instances defined for the instancing object have identical
+        angles."""
+        return self.get_property_state("instances_in_full_circle")
+
+    @instances_in_full_circle.setter
+    def instances_in_full_circle(self, value: int):
+        self.set_property_state("instances_in_full_circle", value)
+
+    @property
+    def instances_for_mapping(self) -> int:
+        """Number of instances to be included in the mapping when instancing
+        is applied.
+
+        Required when the number of instances to be used for mapping does
+        not match the number of instances in a full circle. Default
+        assumes a 360 degree rotation of the participant mesh. This value
+        includes the reference instance (with the participant mesh)."""
+        return self.get_property_state("instances_for_mapping")
+
+    @instances_for_mapping.setter
+    def instances_for_mapping(self, value: int):
+        self.set_property_state("instances_for_mapping", value)
+
+    @property
+    def reference_frame(self) -> str:
+        """Reference frame that defines the orientation of the instancing.
+
+        Rotation will be around the z-axis of the reference frame,
+        following the right-hand rule."""
+        return self.get_property_state("reference_frame")
+
+    @reference_frame.setter
+    def reference_frame(self, value: str):
+        self.set_property_state("reference_frame", value)
+
+    @property
+    def axis(self) -> str:
+        """Principal axis of rotation for instancing"""
+        return self.get_property_state("axis")
+
+    @axis.setter
+    def axis(self, value: str):
+        self.set_property_state("axis", value)
+
+    @property
+    def axis_from(self) -> RealVectorType:
+        """Define the starting point of a user-defined axis."""
+        return self.get_property_state("axis_from")
+
+    @axis_from.setter
+    def axis_from(self, value: RealVectorType):
+        self.set_property_state("axis_from", value)
+
+    @property
+    def axis_to(self) -> RealVectorType:
+        """Define the end point of a user-defined axis."""
+        return self.get_property_state("axis_to")
+
+    @axis_to.setter
+    def axis_to(self, value: RealVectorType):
+        self.set_property_state("axis_to", value)
+
+    @property
+    def rotational_offset(self) -> RealType:
+        """Offset (in radians) about the rotation axis for the first instance"""
+        return self.get_property_state("rotational_offset")
+
+    @rotational_offset.setter
+    def rotational_offset(self, value: RealType):
+        self.set_property_state("rotational_offset", value)

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.11.0}/src/ansys/systemcoupling/core/adaptor/api_25_1/mapping_control.py

@@ -42,6 +42,8 @@ class mapping_control(Container):
         ("rbf_shape_parameter", "RBFShapeParameter", "RealType"),
         ("rbf_linear_correction", "RBFLinearCorrection", "bool"),
         ("rbf_clipping_scale", "RBFClippingScale", "RealType"),
+        ("rbf_taper_init_factor", "RBFTaperInitFactor", "RealType"),
+        ("rbf_max_extrapolation_factor", "RBFMaxExtrapolationFactor", "RealType"),
         ("clipping", "Clipping", "bool"),
     ]
 
@@ -229,6 +231,24 @@ class mapping_control(Container):
     def rbf_clipping_scale(self, value: RealType):
         self.set_property_state("rbf_clipping_scale", value)
 
+    @property
+    def rbf_taper_init_factor(self) -> RealType:
+        """Length scale factor at which to start tapering the extrapolative effect for profile-preserving mapping."""
+        return self.get_property_state("rbf_taper_init_factor")
+
+    @rbf_taper_init_factor.setter
+    def rbf_taper_init_factor(self, value: RealType):
+        self.set_property_state("rbf_taper_init_factor", value)
+
+    @property
+    def rbf_max_extrapolation_factor(self) -> RealType:
+        """Maximum factor allowed to extrapolate for profile-preserving mapping."""
+        return self.get_property_state("rbf_max_extrapolation_factor")
+
+    @rbf_max_extrapolation_factor.setter
+    def rbf_max_extrapolation_factor(self, value: RealType):
+        self.set_property_state("rbf_max_extrapolation_factor", value)
+
     @property
     def clipping(self) -> bool:
         """Controls whether to clip target values to the min/max of the local source values for profile-preserving transfers."""

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.11.0}/src/ansys/systemcoupling/core/adaptor/api_25_1/setup_root.py

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

ansys_systemcoupling_core-0.11.0/src/ansys/systemcoupling/core/adaptor/api_25_1/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"