ansys-systemcoupling-core 0.1.3__py3-none-any.whl → 0.3.0__py3-none-any.whl

ansys/systemcoupling/core/adaptor/{api_23_1 → api_23_2}/setup_root.py

@@ -2,10 +2,11 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "e31caa885d130e78b88ec2e8887d2f24196dd0c65cc56a2868f7cc08799f5c0f"
+SHASH = "d452d4fc3cb91437bd3661ce0cb39dad813458b231800e10af3246b0c6a508f2"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
+from ._add_participant import _add_participant
 from .activate_hidden import activate_hidden
 from .add_data_transfer import add_data_transfer
 from .add_data_transfer_by_display_names import add_data_transfer_by_display_names
@@ -80,36 +81,31 @@ class setup_root(Container):
     output_control child of setup_root.
     """
     command_names = [
-        "add_interface",
-        "add_interface_by_display_names",
+        "_add_participant",
         "add_data_transfer",
         "add_data_transfer_by_display_names",
-        "get_region_names_for_participant",
+        "add_expression_function",
+        "add_interface",
+        "add_interface_by_display_names",
+        "add_named_expression",
+        "add_participant",
         "add_reference_frame",
         "add_transformation",
         "delete_transformation",
-        "add_participant",
-        "update_participant",
-        "get_execution_command",
         "generate_input_file",
-        "import_system_coupling_input_file",
-        "add_named_expression",
-        "add_expression_function",
-        "reload_expression_function_modules",
-        "has_input_file_changed",
+        "get_execution_command",
+        "get_region_names_for_participant",
         "get_setup_summary",
         "get_status_messages",
+        "has_input_file_changed",
+        "import_system_coupling_input_file",
+        "reload_expression_function_modules",
+        "update_participant",
     ]
 
-    add_interface: add_interface = add_interface
+    _add_participant: _add_participant = _add_participant
     """
-    add_interface command of setup_root.
-    """
-    add_interface_by_display_names: add_interface_by_display_names = (
-        add_interface_by_display_names
-    )
-    """
-    add_interface_by_display_names command of setup_root.
+    _add_participant command of setup_root.
     """
     add_data_transfer: add_data_transfer = add_data_transfer
     """
@@ -121,11 +117,27 @@ class setup_root(Container):
     """
     add_data_transfer_by_display_names command of setup_root.
     """
-    get_region_names_for_participant: get_region_names_for_participant = (
-        get_region_names_for_participant
+    add_expression_function: add_expression_function = add_expression_function
+    """
+    add_expression_function command of setup_root.
+    """
+    add_interface: add_interface = add_interface
+    """
+    add_interface command of setup_root.
+    """
+    add_interface_by_display_names: add_interface_by_display_names = (
+        add_interface_by_display_names
     )
     """
-    get_region_names_for_participant command of setup_root.
+    add_interface_by_display_names command of setup_root.
+    """
+    add_named_expression: add_named_expression = add_named_expression
+    """
+    add_named_expression command of setup_root.
+    """
+    add_participant: add_participant = add_participant
+    """
+    add_participant command of setup_root.
     """
     add_reference_frame: add_reference_frame = add_reference_frame
     """
@@ -139,35 +151,37 @@ class setup_root(Container):
     """
     delete_transformation command of setup_root.
     """
-    add_participant: add_participant = add_participant
-    """
-    add_participant command of setup_root.
-    """
-    update_participant: update_participant = update_participant
+    generate_input_file: generate_input_file = generate_input_file
     """
-    update_participant command of setup_root.
+    generate_input_file command of setup_root.
     """
     get_execution_command: get_execution_command = get_execution_command
     """
     get_execution_command command of setup_root.
     """
-    generate_input_file: generate_input_file = generate_input_file
+    get_region_names_for_participant: get_region_names_for_participant = (
+        get_region_names_for_participant
+    )
     """
-    generate_input_file command of setup_root.
+    get_region_names_for_participant command of setup_root.
     """
-    import_system_coupling_input_file: import_system_coupling_input_file = (
-        import_system_coupling_input_file
-    )
+    get_setup_summary: get_setup_summary = get_setup_summary
     """
-    import_system_coupling_input_file command of setup_root.
+    get_setup_summary command of setup_root.
     """
-    add_named_expression: add_named_expression = add_named_expression
+    get_status_messages: get_status_messages = get_status_messages
     """
-    add_named_expression command of setup_root.
+    get_status_messages command of setup_root.
     """
-    add_expression_function: add_expression_function = add_expression_function
+    has_input_file_changed: has_input_file_changed = has_input_file_changed
     """
-    add_expression_function command of setup_root.
+    has_input_file_changed command of setup_root.
+    """
+    import_system_coupling_input_file: import_system_coupling_input_file = (
+        import_system_coupling_input_file
+    )
+    """
+    import_system_coupling_input_file command of setup_root.
     """
     reload_expression_function_modules: reload_expression_function_modules = (
         reload_expression_function_modules
@@ -175,15 +189,7 @@ class setup_root(Container):
     """
     reload_expression_function_modules command of setup_root.
     """
-    has_input_file_changed: has_input_file_changed = has_input_file_changed
-    """
-    has_input_file_changed command of setup_root.
-    """
-    get_setup_summary: get_setup_summary = get_setup_summary
-    """
-    get_setup_summary command of setup_root.
-    """
-    get_status_messages: get_status_messages = get_status_messages
+    update_participant: update_participant = update_participant
     """
-    get_status_messages command of setup_root.
+    update_participant command of setup_root.
     """

ansys/systemcoupling/core/adaptor/{api_23_1 → api_23_2}/solution_root.py

@@ -2,16 +2,18 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "e7829f64a4064be60caa10ab0c964633e99d1ffb276762c0ac858a2631050c69"
+SHASH = "9d14945e18aa7dc6f7ad86397c62f0ceb910440e6ac3753ce8a1d0d2f91b84f5"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
+from ._solve import _solve
 from .abort import abort
 from .create_restart_point import create_restart_point
 from .get_machines import get_machines
+from .get_transformation import get_transformation
 from .initialize import initialize
 from .interrupt import interrupt
-from .open_results_in_ensight import open_results_in_ensight
+from .open_results_in_en_sight import open_results_in_en_sight
 from .partition_participants import partition_participants
 from .shutdown import shutdown
 from .solve import solve
@@ -29,70 +31,80 @@ class solution_root(Container):
     syc_name = "SolutionCommands"
 
     command_names = [
-        "start_participants",
+        "_solve",
+        "abort",
+        "create_restart_point",
+        "get_machines",
+        "get_transformation",
         "initialize",
+        "interrupt",
+        "open_results_in_en_sight",
+        "partition_participants",
         "shutdown",
         "solve",
+        "start_participants",
         "step",
-        "partition_participants",
-        "open_results_in_ensight",
-        "write_ensight",
-        "create_restart_point",
         "write_csv_chart_files",
-        "get_machines",
-        "interrupt",
-        "abort",
+        "write_ensight",
     ]
 
-    start_participants: start_participants = start_participants
+    _solve: _solve = _solve
     """
-    start_participants command of solution_root.
+    _solve command of solution_root.
     """
-    initialize: initialize = initialize
+    abort: abort = abort
     """
-    initialize command of solution_root.
+    abort command of solution_root.
     """
-    shutdown: shutdown = shutdown
+    create_restart_point: create_restart_point = create_restart_point
     """
-    shutdown command of solution_root.
+    create_restart_point command of solution_root.
     """
-    solve: solve = solve
+    get_machines: get_machines = get_machines
     """
-    solve command of solution_root.
+    get_machines command of solution_root.
     """
-    step: step = step
+    get_transformation: get_transformation = get_transformation
     """
-    step command of solution_root.
+    get_transformation command of solution_root.
     """
-    partition_participants: partition_participants = partition_participants
+    initialize: initialize = initialize
     """
-    partition_participants command of solution_root.
+    initialize command of solution_root.
     """
-    open_results_in_ensight: open_results_in_ensight = open_results_in_ensight
+    interrupt: interrupt = interrupt
     """
-    open_results_in_ensight command of solution_root.
+    interrupt command of solution_root.
     """
-    write_ensight: write_ensight = write_ensight
+    open_results_in_en_sight: open_results_in_en_sight = open_results_in_en_sight
     """
-    write_ensight command of solution_root.
+    open_results_in_en_sight command of solution_root.
     """
-    create_restart_point: create_restart_point = create_restart_point
+    partition_participants: partition_participants = partition_participants
     """
-    create_restart_point command of solution_root.
+    partition_participants command of solution_root.
     """
-    write_csv_chart_files: write_csv_chart_files = write_csv_chart_files
+    shutdown: shutdown = shutdown
     """
-    write_csv_chart_files command of solution_root.
+    shutdown command of solution_root.
     """
-    get_machines: get_machines = get_machines
+    solve: solve = solve
     """
-    get_machines command of solution_root.
+    solve command of solution_root.
     """
-    interrupt: interrupt = interrupt
+    start_participants: start_participants = start_participants
     """
-    interrupt command of solution_root.
+    start_participants command of solution_root.
     """
-    abort: abort = abort
+    step: step = step
     """
-    abort command of solution_root.
+    step command of solution_root.
+    """
+    write_csv_chart_files: write_csv_chart_files = write_csv_chart_files
+    """
+    write_csv_chart_files command of solution_root.
+    """
+    write_ensight: write_ensight = write_ensight
+    """
+    write_ensight command of solution_root.
     """

ansys/systemcoupling/core/adaptor/{api_23_1 → api_23_2}/solve.py

@@ -25,6 +25,6 @@ class solve(InjectedCommand):
     System Coupling is solving in the current working directory.
     """
 
-    syc_name = "Solve"
+    syc_name = "solve"
 
     cmd_name = "solve"

ansys/systemcoupling/core/adaptor/{api_23_1 → api_23_2}/variable_child.py

@@ -30,10 +30,13 @@ class variable_child(Container):
         ("integer_initial_value", "IntegerInitialValue", "int"),
         ("logical_initial_value", "LogicalInitialValue", "bool"),
         ("string_initial_value", "StringInitialValue", "str"),
+        ("enumeration_initial_value", "EnumerationInitialValue", "int"),
         ("real_min", "RealMin", "RealType"),
         ("real_max", "RealMax", "RealType"),
         ("integer_min", "IntegerMin", "int"),
         ("integer_max", "IntegerMax", "int"),
+        ("enumeration_min", "EnumerationMin", "int"),
+        ("enumeration_max", "EnumerationMax", "int"),
         ("tensor_type", "TensorType", "str"),
         ("is_extensive", "IsExtensive", "bool"),
     ]
@@ -101,6 +104,7 @@ class variable_child(Container):
         - Integer
         - Logical
         - String
+        - Enumeration
         - None"""
         return self.get_property_state("data_type")
 
@@ -144,6 +148,15 @@ class variable_child(Container):
     def string_initial_value(self, value: str):
         self.set_property_state("string_initial_value", value)
 
+    @property
+    def enumeration_initial_value(self) -> int:
+        """Enumeration data start value."""
+        return self.get_property_state("enumeration_initial_value")
+
+    @enumeration_initial_value.setter
+    def enumeration_initial_value(self, value: int):
+        self.set_property_state("enumeration_initial_value", value)
+
     @property
     def real_min(self) -> RealType:
         """Real data minimum value."""
@@ -180,6 +193,24 @@ class variable_child(Container):
     def integer_max(self, value: int):
         self.set_property_state("integer_max", value)
 
+    @property
+    def enumeration_min(self) -> int:
+        """Enumeration data minimum value."""
+        return self.get_property_state("enumeration_min")
+
+    @enumeration_min.setter
+    def enumeration_min(self, value: int):
+        self.set_property_state("enumeration_min", value)
+
+    @property
+    def enumeration_max(self) -> int:
+        """Enumeration data maximum value."""
+        return self.get_property_state("enumeration_max")
+
+    @enumeration_max.setter
+    def enumeration_max(self, value: int):
+        self.set_property_state("enumeration_max", value)
+
     @property
     def tensor_type(self) -> str:
         """Indicates the variable tensor type (\"Scalar\" or \"Vector\").

ansys/systemcoupling/core/adaptor/api_24_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_24_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_24_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_24_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)