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

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

@@ -21,13 +21,13 @@ class add_interface(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_23_1/add_interface_by_display_names.py

@@ -21,13 +21,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_23_1/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_23_1/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_23_1/show_plot.py

@@ -14,7 +14,7 @@ class show_plot(InjectedCommand):
     ----------
     interface_name : str
         Specification of which interface to plot.
-    transfer_names : typing.List[str], optional
+    transfer_names : List, optional
         Specification of which data transfers to plot. Defaults
         to ``None``, which means plot all data transfers.
     working_dir : str, optional

ansys/systemcoupling/core/adaptor/api_23_1/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_23_2/add_interface.py

@@ -21,13 +21,13 @@ class add_interface(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_23_2/add_interface_by_display_names.py

@@ -21,13 +21,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_23_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_23_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_23_2/show_plot.py

@@ -14,7 +14,7 @@ class show_plot(InjectedCommand):
     ----------
     interface_name : str
         Specification of which interface to plot.
-    transfer_names : typing.List[str], optional
+    transfer_names : List, optional
         Specification of which data transfers to plot. Defaults
         to ``None``, which means plot all data transfers.
     working_dir : str, optional

ansys/systemcoupling/core/adaptor/api_23_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_24_1/add_aerodamping_data_transfers.py

@@ -16,7 +16,7 @@ class add_aerodamping_data_transfers(Command):
     interface : str
         String indicating the name of the interface on which the data transfer
         is to be created.
-    mode_shapes : typing.List[str], optional
+    mode_shapes : List, optional
         List of mode shapes to transfer. If not provided, a
         data transfer is created for each available modeshape.
 

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

@@ -26,10 +26,10 @@ class add_interface(Command):
     side_two_participant : str
         String indicating the name of the participant to be associated with
         side \"Two"\ of the interface.
-    side_one_regions : typing.List[str], optional
+    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 : typing.List[str], optional
+    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.
 

ansys/systemcoupling/core/adaptor/api_24_1/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_1/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_1/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_1/show_plot.py

@@ -14,7 +14,7 @@ class show_plot(InjectedCommand):
     ----------
     interface_name : str
         Specification of which interface to plot.
-    transfer_names : typing.List[str], optional
+    transfer_names : List, optional
         Specification of which data transfers to plot. Defaults
         to ``None``, which means plot all data transfers.
     working_dir : str, optional

ansys/systemcoupling/core/adaptor/api_24_1/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_24_2/add_aerodamping_data_transfers.py

@@ -16,7 +16,7 @@ class add_aerodamping_data_transfers(Command):
     interface : str
         String indicating the name of the interface on which the data transfer
         is to be created.
-    mode_shapes : typing.List[str], optional
+    mode_shapes : List, optional
         List of mode shapes to transfer. If not provided, a
         data transfer is created for each available modeshape.
 

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

@@ -26,10 +26,10 @@ class add_interface(Command):
     side_two_participant : str
         String indicating the name of the participant to be associated with
         side \"Two"\ of the interface.
-    side_one_regions : typing.List[str], optional
+    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 : typing.List[str], optional
+    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.
 

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_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/show_plot.py

@@ -14,7 +14,7 @@ class show_plot(InjectedCommand):
     ----------
     interface_name : str
         Specification of which interface to plot.
-    transfer_names : typing.List[str], optional
+    transfer_names : List, optional
         Specification of which data transfers to plot. Defaults
         to ``None``, which means plot all data transfers.
     working_dir : str, optional

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"