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

ansys/systemcoupling/core/adaptor/api_25_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 ``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"

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

@@ -0,0 +1,191 @@
+#
+# 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):
+    """
+    Important: This command is deprecated. To add an interface, use the
+    ``add_data_transfer`` command instead.
+
+    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_25_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"

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

@@ -0,0 +1,32 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_flow_boundary_data_transfers(Command):
+    """
+    Adds group of data transfers for flow boundary coupling.
+
+    Returns the list of the data transfers created.
+
+    Parameters
+    ----------
+    interface : str
+        String indicating the name of the interface on which the data transfer
+        is to be created.
+
+    """
+
+    syc_name = "AddFlowBoundaryDataTransfers"
+
+    argument_names = ["interface"]
+
+    class interface(String):
+        """
+        String indicating the name of the interface on which the data transfer
+        is to be created.
+        """
+
+        syc_name = "Interface"

ansys/systemcoupling/core/adaptor/api_25_1/add_fsi_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_fsi_data_transfers(Command):
+    """
+    Adds group of data transfers for FSI physics.
+
+    Returns the list of the data transfers created.
+
+    Parameters
+    ----------
+    interface : str
+        String indicating the name of the interface on which the data transfer
+        is to be created.
+    use_force_density : bool, optional
+        Boolean indicating whether to prefer force density variable over force.
+        Default value is False.
+
+    """
+
+    syc_name = "AddFSIDataTransfers"
+
+    argument_names = ["interface", "use_force_density"]
+
+    class interface(String):
+        """
+        String indicating the name of the interface on which the data transfer
+        is to be created.
+        """
+
+        syc_name = "Interface"
+
+    class use_force_density(Boolean):
+        """
+        Boolean indicating whether to prefer force density variable over force.
+        Default value is False.
+        """
+
+        syc_name = "UseForceDensity"

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

@@ -0,0 +1,77 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_interface(Command):
+    """
+    Adds an interface based on the participant and region names specified
+    as arguments for each side of the interface. This command requires that
+    you specify participants using their names as described below in
+    Essential Keyword Arguments. Non-FMU participants must provide a list
+    of regions as described below in Optional Keyword Arguments. For FMU
+    interfaces, specifying the regions are not allowed.
+
+    Cannot be run after participants have been started.
+
+    Returns the name of the Interface created.
+
+    Parameters
+    ----------
+    side_one_participant : str
+        String indicating the name of the participant to be associated with
+        side \"One\" of the interface.
+    side_two_participant : str
+        String indicating the name of the participant to be associated with
+        side \"Two"\ of the interface.
+    side_one_regions : List, optional
+        List specifying the name(s) of region(s) to be added to side One of
+        the interface. Must be provided if ``side_one_participant`` is not an FMU.
+    side_two_regions : List, optional
+        List specifying the name(s) of region(s) to be added to side Two of
+        the interface. Must be provided if ``side_one_participant`` is not an FMU.
+
+    """
+
+    syc_name = "AddInterface"
+
+    argument_names = [
+        "side_one_participant",
+        "side_two_participant",
+        "side_one_regions",
+        "side_two_regions",
+    ]
+
+    class side_one_participant(String):
+        """
+        String indicating the name of the participant to be associated with
+        side \"One\" of the interface.
+        """
+
+        syc_name = "SideOneParticipant"
+
+    class side_two_participant(String):
+        """
+        String indicating the name of the participant to be associated with
+        side \"Two"\ of the interface.
+        """
+
+        syc_name = "SideTwoParticipant"
+
+    class side_one_regions(StringList):
+        """
+        List specifying the name(s) of region(s) to be added to side One of
+        the interface. Must be provided if ``side_one_participant`` is not an FMU.
+        """
+
+        syc_name = "SideOneRegions"
+
+    class side_two_regions(StringList):
+        """
+        List specifying the name(s) of region(s) to be added to side Two of
+        the interface. Must be provided if ``side_one_participant`` is not an FMU.
+        """
+
+        syc_name = "SideTwoRegions"

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

@@ -0,0 +1,78 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class add_interface_by_display_names(Command):
+    """
+    Important: This command is deprecated. To add an interface, use the
+    ``add_interface`` command instead.
+
+    Adds an interface based on the participant and region display names specified
+    as arguments for each side of the interface. This command requires that you
+    specify participants and regions using their *display* names (see parameter
+    descriptions for details).
+
+    Cannot be run after participants have been started.
+
+    Returns the name of the Interface created.
+
+    Parameters
+    ----------
+    side_one_participant : str
+        String indicating the name of the participant to be associated with
+        side \"One\" of the interface.
+    side_one_regions : List
+        List specifying the name(s) of region(s) to be added to side \"One\" of
+        the interface.
+    side_two_participant : str
+        String indicating the name of the participant to be associated with
+        side \"Two\" of the interface.
+    side_two_regions : List
+        List specifying the name(s) of region(s) to be added to side \"Two\"
+        of the interface.
+
+    """
+
+    syc_name = "AddInterfaceByDisplayNames"
+
+    argument_names = [
+        "side_one_participant",
+        "side_one_regions",
+        "side_two_participant",
+        "side_two_regions",
+    ]
+
+    class side_one_participant(String):
+        """
+        String indicating the name of the participant to be associated with
+        side \"One\" of the interface.
+        """
+
+        syc_name = "SideOneParticipant"
+
+    class side_one_regions(StringList):
+        """
+        List specifying the name(s) of region(s) to be added to side \"One\" of
+        the interface.
+        """
+
+        syc_name = "SideOneRegions"
+
+    class side_two_participant(String):
+        """
+        String indicating the name of the participant to be associated with
+        side \"Two\" of the interface.
+        """
+
+        syc_name = "SideTwoParticipant"
+
+    class side_two_regions(StringList):
+        """
+        List specifying the name(s) of region(s) to be added to side \"Two\"
+        of the interface.
+        """
+
+        syc_name = "SideTwoRegions"