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

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
 #
 #
@@ -72,7 +72,7 @@ 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
+        ``"251"`` ("2025 R1" 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.
     start_output: bool, optional

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/adaptor/api_25_1/instancing.py

@@ -13,6 +13,8 @@ class instancing(NamedContainer[instancing_child]):
 
     Available when cylindrical geometry instancing has been added to
     the data model.
+
+    ``RotationAxis`` controls how the axis of rotation is defined.
     """
 
     syc_name = "Instancing"

ansys/systemcoupling/core/adaptor/api_25_1/instancing_child.py

@@ -11,27 +11,31 @@ class instancing_child(Container):
 
     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 = [
-        ("reference_frame", "ReferenceFrame", "str"),
+        ("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 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")
+    def rotation_axis(self) -> str:
+        """UNDOCUMENTED"""
+        return self.get_property_state("rotation_axis")
 
-    @reference_frame.setter
-    def reference_frame(self, value: str):
-        self.set_property_state("reference_frame", value)
+    @rotation_axis.setter
+    def rotation_axis(self, value: str):
+        self.set_property_state("rotation_axis", value)
 
     @property
     def instances_in_full_circle(self) -> int:
@@ -60,3 +64,51 @@ class instancing_child(Container):
     @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/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/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/adaptor/api_25_1/update_participant.py

@@ -7,19 +7,21 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
 
 class update_participant(Command):
     """
-    Given the name of a server participant, updates the state of the participant.
+    Given the name of a participant, updates the state of the participant.
 
-    Available for server participants. Currently, only DEFAULT-SRV,
-    CFD-SRV, MECH-SRV, and SCDT-SRV participants may be updated.
+    Available for DEFAULT-SRV, CFD-SRV, MECH-SRV, and SCDT-SRV and
+    AEDT participants.
 
-    As part of the update, System Coupling updates all regions and
-    variables defined in the participant, including all variable
-    attributes. Variables and regions may be added to the participant but
-    may not be removed.
+    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
@@ -29,12 +31,11 @@ class update_participant(Command):
     ----------
     participant_name : str
         Participant name. Must be the name of an existing participant.
-        Participant type can be either DEFAULT-SRV, CFD-SRV, MECH-SRV, or SCDT-SRV.
     input_file : str, optional
         Name of the input file for the participant to be added.
-        Currently supported formats are SCP files, Forte input (FTSIM)
-        files, mechanical server (\*.rst) files, cfd server (\*.csv) files,
-        FMU (\*.fmu) files (Beta), and system coupling data server (\*.scdt/axdt/csv) files.
+        Currently supported formats are SCP files, mechanical server
+        (\*.rst) files, cfd server (\*.csv) files, and system coupling
+        data server (\*.scdt/axdt/csv) files.
 
     """
 
@@ -45,7 +46,6 @@ class update_participant(Command):
     class participant_name(String):
         """
         Participant name. Must be the name of an existing participant.
-        Participant type can be either DEFAULT-SRV, CFD-SRV, MECH-SRV, or SCDT-SRV.
         """
 
         syc_name = "ParticipantName"
@@ -53,9 +53,9 @@ class update_participant(Command):
     class input_file(String):
         """
         Name of the input file for the participant to be added.
-        Currently supported formats are SCP files, Forte input (FTSIM)
-        files, mechanical server (\*.rst) files, cfd server (\*.csv) files,
-        FMU (\*.fmu) files (Beta), and system coupling data server (\*.scdt/axdt/csv) files.
+        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/_add_participant.py

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

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

@@ -0,0 +1,13 @@
+#
+# 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/adaptor/api_25_2/abort.py

@@ -0,0 +1,39 @@
+#
+# 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/adaptor/api_25_2/activate_hidden.py

@@ -0,0 +1,46 @@
+#
+# 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/adaptor/api_25_2/add_aerodamping_data_transfers.py

@@ -0,0 +1,43 @@
+#
+# 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/adaptor/api_25_2/add_data_transfer.py

@@ -0,0 +1,190 @@
+#
+# 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"