ansys-systemcoupling-core 0.3.0__py3-none-any.whl → 0.4.dev0__py3-none-any.whl

ansys/systemcoupling/core/__init__.py

@@ -1,3 +1,25 @@
+# Copyright (C) 2023 - 2024 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 os
 from typing import List
 
@@ -47,7 +69,7 @@ def launch(
         (The forms ``"23.1"`` and ``"23_1"`` are also acceptable.)
         The version will be sought in the standard installation location. The
         default is ``None``, which is equivalent to specifying
-        ``"232"`` ("2023 R2" release), unless either of the environment
+        ``"241"`` ("2024 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.
     extra_args : List[str]

ansys/systemcoupling/core/_version.py

@@ -1,3 +1,25 @@
+# Copyright (C) 2023 - 2024 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.
+
 """Version of ansys-systemcoupling-core library.
 
 On the ``main`` branch, use 'dev0' to denote a development version.

ansys/systemcoupling/core/adaptor/api_23_1/_add_participant.py

@@ -0,0 +1,70 @@
+#
+# 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
+        ...
+
+    """
+
+    syc_name = "AddParticipant"
+
+    argument_names = [
+        "participant_type",
+        "input_file",
+        "executable",
+        "additional_arguments",
+        "working_directory",
+    ]
+
+    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"

ansys/systemcoupling/core/adaptor/api_23_1/_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_23_1/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_23_1/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_23_1/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 ``arget_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 ``arget_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"

ansys/systemcoupling/core/adaptor/api_23_1/add_data_transfer_by_display_names.py

@@ -0,0 +1,188 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_data_transfer_by_display_names(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 display 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 display 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 display 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 display 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_{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 scalar. (If the ``target_variable`` is a vector,
+        ``value_x``, ``value_y``, ``value_z`` must be used instead.)
+    value_x : str, optional
+        String specifying the X component of the expression to use on the
+        source side of the data transfer. Used when crating an expression-based
+        data transfer if the ``target_variable`` is a vector. (If the ``target_variable``
+        is scalar, ``value`` must be used instead.) ``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. Used when crating an expression-based
+        data transfer if the ``target_variable`` is a vector. (If the ``target_variable``
+        is scalar, ``value`` must be used instead.) ``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. Used when crating an expression-based
+        data transfer if the ``target_variable`` is a vector. (If the ``target_variable``
+        is scalar, ``value`` must be used instead.) ``value_x`` and ``value_y`` are also
+        required if ``value_z`` is used.
+    side_one_variable : str, optional
+        String specifying the display name of the variable associated with side one
+        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 display name of the variable associated with side two
+        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 = "AddDataTransferByDisplayNames"
+
+    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 display 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 display 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 display 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_{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 scalar. (If the ``target_variable`` is a vector,
+        ``value_x``, ``value_y``, ``value_z`` must be used instead.)
+        """
+
+        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. Used when crating an expression-based
+        data transfer if the ``target_variable`` is a vector. (If the ``target_variable``
+        is scalar, ``value`` must be used instead.) ``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. Used when crating an expression-based
+        data transfer if the ``target_variable`` is a vector. (If the ``target_variable``
+        is scalar, ``value`` must be used instead.) ``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. Used when crating an expression-based
+        data transfer if the ``target_variable`` is a vector. (If the ``target_variable``
+        is scalar, ``value`` must be used instead.) ``value_x`` and ``value_y`` are also
+        required if ``value_z`` is used.
+        """
+
+        syc_name = "ValueZ"
+
+    class side_one_variable(String):
+        """
+        String specifying the display name of the variable associated with side one
+        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 display name of the variable associated with side two
+        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"

ansys/systemcoupling/core/adaptor/api_23_1/add_expression_function.py

@@ -0,0 +1,61 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_expression_function(Command):
+    """
+    Creates an expression function object in the data model that makes
+    available an external Python function for use in expressions.
+
+    The parameters specified should correspond to a module and function
+    that exists and can successfully be loaded when the application
+    starts. Otherwise, the data model object will be created but there
+    will be validation errors and the function will not be available for
+    use.
+
+    Parameters
+    ----------
+    module : str
+        The name of the Python module (in the 'Modules' sub-directory of
+        the working directory) from which the function is to be obtained.
+    function : str
+        The name of the function in the module. If no ``function_name`` is
+        specified, this will also be the name by which the function should
+        be referenced when used in an expression.
+    function_name : str, optional
+        Optionally specify a different name from ``function`` which should be
+        the name used to reference the function in an expression.
+
+    """
+
+    syc_name = "AddExpressionFunction"
+
+    argument_names = ["module", "function", "function_name"]
+
+    class module(String):
+        """
+        The name of the Python module (in the 'Modules' sub-directory of
+        the working directory) from which the function is to be obtained.
+        """
+
+        syc_name = "Module"
+
+    class function(String):
+        """
+        The name of the function in the module. If no ``function_name`` is
+        specified, this will also be the name by which the function should
+        be referenced when used in an expression.
+        """
+
+        syc_name = "Function"
+
+    class function_name(String):
+        """
+        Optionally specify a different name from ``function`` which should be
+        the name used to reference the function in an expression.
+        """
+
+        syc_name = "FunctionName"