ansys-systemcoupling-core 0.5.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

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

@@ -24,13 +24,13 @@ class add_interface_by_display_names(Command):
     side_one_participant : str
         String indicating the name of the participant to be associated with
         side \"One\" of the interface.
-    side_one_regions : typing.List[str]
+    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 : typing.List[str]
+    side_two_regions : List
         List specifying the name(s) of region(s) to be added to side \"Two\"
         of the interface.
 

ansys/systemcoupling/core/adaptor/api_24_2/add_participant.py

@@ -76,8 +76,8 @@ class add_participant(InjectedCommand):
     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, and System Coupling data server (*.scdt/axdt/csv) files.
+        files, mechanical server (\*.rst) files, cfd server (\*.csv) files,
+        FMU (.fmu) files, and System Coupling data server (\*.scdt/axdt/csv) files.
     executable : str, optional
         Path to the executable file for the participant to be added.
     additional_arguments : str, optional
@@ -125,8 +125,8 @@ class add_participant(InjectedCommand):
         """
         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, and System Coupling data server (*.scdt/axdt/csv) files.
+        files, mechanical server (\*.rst) files, cfd server (\*.csv) files,
+        FMU (.fmu) files, and System Coupling data server (\*.scdt/axdt/csv) files.
         """
 
         syc_name = "InputFile"

ansys/systemcoupling/core/adaptor/api_24_2/add_transformation.py

@@ -41,7 +41,7 @@ class add_transformation(Command):
         Axis about which a rotation is applied. Used with
         Rotation ``transformation_type``. Available options are: \"XAxis\", \"YAxis\",
         \"ZAxis\", and \"UserDefined\".
-    vector : typing.Tuple[real, real, real], optional
+    vector : Tuple, optional
         A vector for use with \"Translation\" ``transformation_type`` or \"Rotation\"
         ``transformation_type`` if the ``axis`` is \"UserDefined\".
 

ansys/systemcoupling/core/adaptor/api_24_2/partition_participants.py

@@ -33,7 +33,7 @@ class partition_participants(Command):
 
         See the System Coupling documentation for more details of the
         partitioning algorithms.
-    names_and_fractions : typing.List[typing.Tuple[str, float]], optional
+    names_and_fractions : List, optional
         List of tuples specifying the fractions of core count applied for
         each participant
 
@@ -41,14 +41,14 @@ class partition_participants(Command):
         associated fraction as its second item. If this parameter is omitted,
         then cores will be allocated for all participants set in the
         data model.
-    machine_list : typing.List[typing.Dict[str, typing.Union[str, int]]], optional
+    machine_list : List, optional
         List of dictionaries specifying machines available for distributed run.
         Each dictionary must have a key \"machine-name\" with machine name as its
         value, and key \"core-count\" with number of cores for that machine as
         its value. Providing this argument will override any machine list
         information detected from the scheduler environment and any information
         provided by the ``--cnf`` command-line argument.
-    partitioning_info : typing.Dict[str, typing.List[typing.Dict[str, typing.Union[str, int]]]], optional
+    partitioning_info : Dict, optional
         Dictionary specifying machines resources assigned to each participant by user.
         Dictionary must have participant names as keys and machine lists containing
         machine resources as values. The value of a ``partitioning_info`` machine list is

ansys/systemcoupling/core/adaptor/api_24_2/setup_root.py

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

ansys/systemcoupling/core/adaptor/api_24_2/show_plot.py

@@ -0,0 +1,75 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class show_plot(InjectedCommand):
+    """
+    Shows plots of transfer values and convergence for data transfers
+    of a coupling interface.
+
+    Parameters
+    ----------
+    interface_name : str
+        Specification of which interface to plot.
+    transfer_names : List, optional
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+    working_dir : str, optional
+        Working directory (defaults = ".").
+    show_convergence : bool, optional
+        Whether to show convergence plots (defaults to ``True``).
+    show_transfer_values : bool, optional
+        Whether to show transfer value plots (defaults to ``True``).
+
+    """
+
+    syc_name = "show_plot"
+
+    cmd_name = "show_plot"
+
+    argument_names = [
+        "interface_name",
+        "transfer_names",
+        "working_dir",
+        "show_convergence",
+        "show_transfer_values",
+    ]
+
+    class interface_name(String):
+        """
+        Specification of which interface to plot.
+        """
+
+        syc_name = "interface_name"
+
+    class transfer_names(StringList):
+        """
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+        """
+
+        syc_name = "transfer_names"
+
+    class working_dir(String):
+        """
+        Working directory (defaults = ".").
+        """
+
+        syc_name = "working_dir"
+
+    class show_convergence(Boolean):
+        """
+        Whether to show convergence plots (defaults to ``True``).
+        """
+
+        syc_name = "show_convergence"
+
+    class show_transfer_values(Boolean):
+        """
+        Whether to show transfer value plots (defaults to ``True``).
+        """
+
+        syc_name = "show_transfer_values"

ansys/systemcoupling/core/adaptor/api_24_2/solution_root.py

@@ -2,7 +2,7 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "b8e209ea9aecf13d907bdc4c075b64063c908fff4ef44ebaac826714ccff8547"
+SHASH = "0987c9ed416b22e5d86458a81cba5c65a60eb6e6a32fb2f856bf7464f995ed36"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
@@ -16,6 +16,7 @@ from .initialize import initialize
 from .interrupt import interrupt
 from .open_results_in_ensight import open_results_in_ensight
 from .partition_participants import partition_participants
+from .show_plot import show_plot
 from .shutdown import shutdown
 from .solve import solve
 from .start_participants import start_participants
@@ -42,6 +43,7 @@ class solution_root(Container):
         "interrupt",
         "open_results_in_ensight",
         "partition_participants",
+        "show_plot",
         "shutdown",
         "solve",
         "start_participants",
@@ -90,6 +92,10 @@ class solution_root(Container):
     """
     partition_participants command of solution_root.
     """
+    show_plot: show_plot = show_plot
+    """
+    show_plot command of solution_root.
+    """
     shutdown: shutdown = shutdown
     """
     shutdown command of solution_root.

ansys/systemcoupling/core/adaptor/api_24_2/start_participants.py

@@ -30,7 +30,7 @@ class start_participants(Command):
 
     Parameters
     ----------
-    participant_names : typing.List[str], optional
+    participant_names : List, optional
         This argument has been deprecated and will be removed in future releases.
 
     """

ansys/systemcoupling/core/adaptor/api_25_1/_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_1/_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_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_25_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_25_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_25_1/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_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"