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

ansys/systemcoupling/core/adaptor/api_24_1/add_thermal_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_thermal_data_transfers(Command):
+    """
+    Adds group of data transfers for thermal 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.
+    option : str, optional
+        Thermal data transfer option: 'Heat Rate' (default) or
+        'Heat Transfer Coefficient' (possible for surface-surface transfers).
+
+    """
+
+    syc_name = "AddThermalDataTransfers"
+
+    argument_names = ["interface", "option"]
+
+    class interface(String):
+        """
+        String indicating the name of the interface on which the data transfer
+        is to be created.
+        """
+
+        syc_name = "Interface"
+
+    class option(String):
+        """
+        Thermal data transfer option: 'Heat Rate' (default) or
+        'Heat Transfer Coefficient' (possible for surface-surface transfers).
+        """
+
+        syc_name = "Option"

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

@@ -54,7 +54,14 @@ class analysis_control(Container):
         ("warped_face_tolerance", "WarpedFaceTolerance", "RealType"),
         ("allow_simultaneous_update", "AllowSimultaneousUpdate", "bool"),
         ("simultaneous_participants", "SimultaneousParticipants", "str"),
+        (
+            "allow_simultaneous_initialization",
+            "AllowSimultaneousInitialization",
+            "bool",
+        ),
+        ("mpi_pause_timeout", "MpiPauseTimeout", "RealType"),
         ("partitioning_algorithm", "PartitioningAlgorithm", "str"),
+        ("cleanup_inflated_fm_us", "CleanupInflatedFMUs", "bool"),
         ("allow_iterations_only_mode", "AllowIterationsOnlyMode", "bool"),
         ("target_initialization_option", "TargetInitializationOption", "str"),
         ("fluent_region_update_at_step", "FluentRegionUpdateAtStep", "bool"),
@@ -122,6 +129,24 @@ class analysis_control(Container):
     def simultaneous_participants(self, value: str):
         self.set_property_state("simultaneous_participants", value)
 
+    @property
+    def allow_simultaneous_initialization(self) -> bool:
+        """Allow simultaneous initialization of participants."""
+        return self.get_property_state("allow_simultaneous_initialization")
+
+    @allow_simultaneous_initialization.setter
+    def allow_simultaneous_initialization(self, value: bool):
+        self.set_property_state("allow_simultaneous_initialization", value)
+
+    @property
+    def mpi_pause_timeout(self) -> RealType:
+        """Specify MPI pause time (in seconds) to wait for other participants to finish solving"""
+        return self.get_property_state("mpi_pause_timeout")
+
+    @mpi_pause_timeout.setter
+    def mpi_pause_timeout(self, value: RealType):
+        self.set_property_state("mpi_pause_timeout", value)
+
     @property
     def partitioning_algorithm(self) -> str:
         """Partitioning algorithm used when participants are running in parallel.
@@ -143,6 +168,15 @@ class analysis_control(Container):
     def partitioning_algorithm(self, value: str):
         self.set_property_state("partitioning_algorithm", value)
 
+    @property
+    def cleanup_inflated_fm_us(self) -> bool:
+        """Controls whether System Coupling will cleanup inflated FMUs at end of analysis."""
+        return self.get_property_state("cleanup_inflated_fm_us")
+
+    @cleanup_inflated_fm_us.setter
+    def cleanup_inflated_fm_us(self, value: bool):
+        self.set_property_state("cleanup_inflated_fm_us", value)
+
     @property
     def allow_iterations_only_mode(self) -> bool:
         """Explicitly set whether iterations-only mode is allowed."""

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

@@ -2,13 +2,12 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "0fbfd3e7593591d8e52193a6e92828c6174e531b26437aee17285b3d0d114664"
+SHASH = "430648f7df949b91819d62a5c2d5a5c49d1d67217fb3474ee31e0c78e5ffbd43"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 from .clear_state import clear_state
 from .delete_snapshot import delete_snapshot
-from .get_snapshots import get_snapshots
 from .open import open
 from .open_snapshot import open_snapshot
 from .save import save
@@ -25,7 +24,6 @@ class case_root(Container):
     command_names = [
         "clear_state",
         "delete_snapshot",
-        "get_snapshots",
         "open",
         "open_snapshot",
         "save",
@@ -40,10 +38,6 @@ class case_root(Container):
     """
     delete_snapshot command of case_root.
     """
-    get_snapshots: get_snapshots = get_snapshots
-    """
-    get_snapshots command of case_root.
-    """
     open: open = open
     """
     open command of case_root.

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

@@ -8,6 +8,7 @@ from .execution_control import execution_control
 from .external_data_file import external_data_file
 from .fmu_parameter import fmu_parameter
 from .parameter import parameter
+from .record_interactions import record_interactions
 from .region import region
 from .update_control import update_control
 from .variable import variable
@@ -31,6 +32,7 @@ class coupling_participant_child(Container):
         "fmu_parameter",
         "execution_control",
         "external_data_file",
+        "record_interactions",
     ]
 
     variable: variable = variable
@@ -61,6 +63,10 @@ class coupling_participant_child(Container):
     """
     external_data_file child of coupling_participant_child.
     """
+    record_interactions: record_interactions = record_interactions
+    """
+    record_interactions child of coupling_participant_child.
+    """
     property_names_types = [
         ("participant_type", "ParticipantType", "str"),
         ("participant_display_name", "ParticipantDisplayName", "str"),
@@ -76,6 +82,8 @@ class coupling_participant_child(Container):
         ("use_new_apis", "UseNewAPIs", "bool"),
         ("restarts_supported", "RestartsSupported", "bool"),
         ("can_serialize_fmu_state", "CanSerializeFmuState", "bool"),
+        ("can_get_and_set_fmu_state", "CanGetAndSetFmuState", "bool"),
+        ("free_fmu_state", "FreeFmuState", "bool"),
         ("instancing", "Instancing", "str"),
     ]
 
@@ -220,6 +228,24 @@ class coupling_participant_child(Container):
     def can_serialize_fmu_state(self, value: bool):
         self.set_property_state("can_serialize_fmu_state", value)
 
+    @property
+    def can_get_and_set_fmu_state(self) -> bool:
+        """Indicates whether the FMU can get and set its state."""
+        return self.get_property_state("can_get_and_set_fmu_state")
+
+    @can_get_and_set_fmu_state.setter
+    def can_get_and_set_fmu_state(self, value: bool):
+        self.set_property_state("can_get_and_set_fmu_state", value)
+
+    @property
+    def free_fmu_state(self) -> bool:
+        """Optionally Frees the FMU state prior to calling CanGetAndSetFmuState"""
+        return self.get_property_state("free_fmu_state")
+
+    @free_fmu_state.setter
+    def free_fmu_state(self, value: bool):
+        self.set_property_state("free_fmu_state", value)
+
     @property
     def instancing(self) -> str:
         """Set instancing on the participant."""

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

@@ -40,6 +40,7 @@ class execution_control(Container):
         ("base_output_file_name", "BaseOutputFileName", "str"),
         ("overwrite_existing_files", "OverwriteExistingFiles", "bool"),
         ("mass_normalized", "MassNormalized", "bool"),
+        ("write_output", "WriteOutput", "bool"),
     ]
 
     @property
@@ -160,7 +161,7 @@ class execution_control(Container):
 
     @property
     def base_output_file_name(self) -> str:
-        """Base output file name for the CFD Server."""
+        """Base output file name for the CFD Server or SCDT Server."""
         return self.get_property_state("base_output_file_name")
 
     @base_output_file_name.setter
@@ -184,3 +185,12 @@ class execution_control(Container):
     @mass_normalized.setter
     def mass_normalized(self, value: bool):
         self.set_property_state("mass_normalized", value)
+
+    @property
+    def write_output(self) -> bool:
+        """Controls whether export scdt files for the SCDT Server"""
+        return self.get_property_state("write_output")
+
+    @write_output.setter
+    def write_output(self, value: bool):
+        self.set_property_state("write_output", value)

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

@@ -0,0 +1,29 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_add_data_transfer_group_commands(Command):
+    """
+    Given an interface name, returns a list with possible commands
+    for adding data transfer groups.
+
+    Parameters
+    ----------
+    interface : str
+        String indicating the name of the interface.
+
+    """
+
+    syc_name = "GetAddDataTransferGroupCommands"
+
+    argument_names = ["interface"]
+
+    class interface(String):
+        """
+        String indicating the name of the interface.
+        """
+
+        syc_name = "Interface"

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

@@ -0,0 +1,29 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_mode_shape_variables(Command):
+    """
+    Given an interface name, returns a list of mode shape variables available
+    from the MECH-SRV participant.
+
+    Parameters
+    ----------
+    interface : str
+        String indicating the name of the interface.
+
+    """
+
+    syc_name = "GetModeShapeVariables"
+
+    argument_names = ["interface"]
+
+    class interface(String):
+        """
+        String indicating the name of the interface.
+        """
+
+        syc_name = "Interface"

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

@@ -0,0 +1,32 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_thermal_data_transfer_options(Command):
+    """
+    Given an interface name, returns a list of available possible options for
+    ``add_thermal_data_transfers`` given the context, and whether those
+    data transfers are actually available. When only one option is conceptually
+    possible (e.g., not a surface-surface transfer), the returned dictionary is
+    empty.
+
+    Parameters
+    ----------
+    interface : str
+        String indicating the name of the interface.
+
+    """
+
+    syc_name = "GetThermalDataTransferOptions"
+
+    argument_names = ["interface"]
+
+    class interface(String):
+        """
+        String indicating the name of the interface.
+        """
+
+        syc_name = "Interface"

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

@@ -42,6 +42,7 @@ class mapping_control(Container):
         ("rbf_shape_parameter", "RBFShapeParameter", "RealType"),
         ("rbf_linear_correction", "RBFLinearCorrection", "bool"),
         ("rbf_clipping_scale", "RBFClippingScale", "RealType"),
+        ("clipping", "Clipping", "bool"),
     ]
 
     @property
@@ -227,3 +228,12 @@ class mapping_control(Container):
     @rbf_clipping_scale.setter
     def rbf_clipping_scale(self, value: RealType):
         self.set_property_state("rbf_clipping_scale", value)
+
+    @property
+    def clipping(self) -> bool:
+        """Controls whether to clip target values to the min/max of the local source values for profile-preserving transfers."""
+        return self.get_property_state("clipping")
+
+    @clipping.setter
+    def clipping(self, value: bool):
+        self.set_property_state("clipping", value)

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

@@ -23,6 +23,34 @@ class open_results_in_ensight(Command):
     instance of the EnSight application is opened. Any existing instances of
     EnSight remain open, both when additional instances are created and when
     System Coupling exits.
+
+    Parameters
+    ----------
+    file_name : str, optional
+        The basename of the EnSight case file if using a non-standard file
+        name. Overrides the default file name ``results.enc``.
+    file_path : str, optional
+        The path to the EnSight case if using a non-standard location.
+        Overrides the default path of ``SyC/results``.
+
     """
 
     syc_name = "OpenResultsInEnSight"
+
+    argument_names = ["file_name", "file_path"]
+
+    class file_name(String):
+        """
+        The basename of the EnSight case file if using a non-standard file
+        name. Overrides the default file name ``results.enc``.
+        """
+
+        syc_name = "FileName"
+
+    class file_path(String):
+        """
+        The path to the EnSight case if using a non-standard location.
+        Overrides the default path of ``SyC/results``.
+        """
+
+        syc_name = "FilePath"

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

@@ -4,8 +4,6 @@
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
-from .dimensionality import dimensionality
-
 
 class parameter_child(Container):
     """
@@ -14,12 +12,6 @@ class parameter_child(Container):
 
     syc_name = "child_object_type"
 
-    child_names = ["dimensionality"]
-
-    dimensionality: dimensionality = dimensionality
-    """
-    dimensionality child of parameter_child.
-    """
     property_names_types = [
         ("participant_display_name", "ParticipantDisplayName", "str"),
         ("display_name", "DisplayName", "str"),

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

@@ -0,0 +1,36 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class record_interactions(Container):
+    """
+    "Controls whether the System Coupling Participant library will record the setup and solution data files for testing and debugging.
+    """
+
+    syc_name = "RecordInteractions"
+
+    property_names_types = [
+        ("record_setup", "RecordSetup", "bool"),
+        ("record_solution", "RecordSolution", "bool"),
+    ]
+
+    @property
+    def record_setup(self) -> bool:
+        """Flag indicating whether participant record scp file."""
+        return self.get_property_state("record_setup")
+
+    @record_setup.setter
+    def record_setup(self, value: bool):
+        self.set_property_state("record_setup", value)
+
+    @property
+    def record_solution(self) -> bool:
+        """Flag indicating whether participant record solution files."""
+        return self.get_property_state("record_solution")
+
+    @record_solution.setter
+    def record_solution(self, value: bool):
+        self.set_property_state("record_solution", value)

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

@@ -2,30 +2,37 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "add18659c90558849a12bc4820dc48069961268d3b1790256ae8a6fe59db8067"
+SHASH = "8e81ea84cd8d53f78719455f1af3cb4574a4ca5d37da4b5269211b224fff8259"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 from ._add_participant import _add_participant
 from .activate_hidden import activate_hidden
+from .add_aerodamping_data_transfers import add_aerodamping_data_transfers
 from .add_data_transfer import add_data_transfer
 from .add_data_transfer_by_display_names import add_data_transfer_by_display_names
 from .add_expression_function import add_expression_function
+from .add_fsi_data_transfers import add_fsi_data_transfers
 from .add_interface import add_interface
 from .add_interface_by_display_names import add_interface_by_display_names
 from .add_named_expression import add_named_expression
+from .add_ordered_data_transfers import add_ordered_data_transfers
 from .add_participant import add_participant
 from .add_reference_frame import add_reference_frame
+from .add_thermal_data_transfers import add_thermal_data_transfers
 from .add_transformation import add_transformation
 from .analysis_control import analysis_control
 from .coupling_interface import coupling_interface
 from .coupling_participant import coupling_participant
 from .delete_transformation import delete_transformation
 from .generate_input_file import generate_input_file
+from .get_add_data_transfer_group_commands import get_add_data_transfer_group_commands
 from .get_execution_command import get_execution_command
+from .get_mode_shape_variables import get_mode_shape_variables
 from .get_region_names_for_participant import get_region_names_for_participant
 from .get_setup_summary import get_setup_summary
 from .get_status_messages import get_status_messages
+from .get_thermal_data_transfer_options import get_thermal_data_transfer_options
 from .has_input_file_changed import has_input_file_changed
 from .import_system_coupling_input_file import import_system_coupling_input_file
 from .library import library
@@ -82,21 +89,28 @@ class setup_root(Container):
     """
     command_names = [
         "_add_participant",
+        "add_aerodamping_data_transfers",
         "add_data_transfer",
         "add_data_transfer_by_display_names",
         "add_expression_function",
+        "add_fsi_data_transfers",
         "add_interface",
         "add_interface_by_display_names",
         "add_named_expression",
+        "add_ordered_data_transfers",
         "add_participant",
         "add_reference_frame",
+        "add_thermal_data_transfers",
         "add_transformation",
         "delete_transformation",
         "generate_input_file",
+        "get_add_data_transfer_group_commands",
         "get_execution_command",
+        "get_mode_shape_variables",
         "get_region_names_for_participant",
         "get_setup_summary",
         "get_status_messages",
+        "get_thermal_data_transfer_options",
         "has_input_file_changed",
         "import_system_coupling_input_file",
         "reload_expression_function_modules",
@@ -107,6 +121,12 @@ class setup_root(Container):
     """
     _add_participant command of setup_root.
     """
+    add_aerodamping_data_transfers: add_aerodamping_data_transfers = (
+        add_aerodamping_data_transfers
+    )
+    """
+    add_aerodamping_data_transfers command of setup_root.
+    """
     add_data_transfer: add_data_transfer = add_data_transfer
     """
     add_data_transfer command of setup_root.
@@ -121,6 +141,10 @@ class setup_root(Container):
     """
     add_expression_function command of setup_root.
     """
+    add_fsi_data_transfers: add_fsi_data_transfers = add_fsi_data_transfers
+    """
+    add_fsi_data_transfers command of setup_root.
+    """
     add_interface: add_interface = add_interface
     """
     add_interface command of setup_root.
@@ -135,6 +159,10 @@ class setup_root(Container):
     """
     add_named_expression command of setup_root.
     """
+    add_ordered_data_transfers: add_ordered_data_transfers = add_ordered_data_transfers
+    """
+    add_ordered_data_transfers command of setup_root.
+    """
     add_participant: add_participant = add_participant
     """
     add_participant command of setup_root.
@@ -143,6 +171,10 @@ class setup_root(Container):
     """
     add_reference_frame command of setup_root.
     """
+    add_thermal_data_transfers: add_thermal_data_transfers = add_thermal_data_transfers
+    """
+    add_thermal_data_transfers command of setup_root.
+    """
     add_transformation: add_transformation = add_transformation
     """
     add_transformation command of setup_root.
@@ -155,10 +187,20 @@ class setup_root(Container):
     """
     generate_input_file command of setup_root.
     """
+    get_add_data_transfer_group_commands: get_add_data_transfer_group_commands = (
+        get_add_data_transfer_group_commands
+    )
+    """
+    get_add_data_transfer_group_commands command of setup_root.
+    """
     get_execution_command: get_execution_command = get_execution_command
     """
     get_execution_command command of setup_root.
     """
+    get_mode_shape_variables: get_mode_shape_variables = get_mode_shape_variables
+    """
+    get_mode_shape_variables command of setup_root.
+    """
     get_region_names_for_participant: get_region_names_for_participant = (
         get_region_names_for_participant
     )
@@ -173,6 +215,12 @@ class setup_root(Container):
     """
     get_status_messages command of setup_root.
     """
+    get_thermal_data_transfer_options: get_thermal_data_transfer_options = (
+        get_thermal_data_transfer_options
+    )
+    """
+    get_thermal_data_transfer_options command of setup_root.
+    """
     has_input_file_changed: has_input_file_changed = has_input_file_changed
     """
     has_input_file_changed command of setup_root.

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

@@ -28,6 +28,7 @@ class solution_control(Container):
         ("minimum_iterations", "MinimumIterations", "int"),
         ("maximum_iterations", "MaximumIterations", "int"),
         ("use_ip_address_when_possible", "UseIPAddressWhenPossible", "bool"),
+        ("use_local_host_when_possible", "UseLocalHostWhenPossible", "bool"),
     ]
 
     @property
@@ -101,3 +102,14 @@ class solution_control(Container):
     @use_ip_address_when_possible.setter
     def use_ip_address_when_possible(self, value: bool):
         self.set_property_state("use_ip_address_when_possible", value)
+
+    @property
+    def use_local_host_when_possible(self) -> bool:
+        """If True, prefer to use local host address rather than network address for
+        participant server connections. There is no guarantee that this request
+        can be satisfied for all participants."""
+        return self.get_property_state("use_local_host_when_possible")
+
+    @use_local_host_when_possible.setter
+    def use_local_host_when_possible(self, value: bool):
+        self.set_property_state("use_local_host_when_possible", value)

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

@@ -2,7 +2,7 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "f7545cd9b5d857e7086be22fb7770696f0d1c5aea6299f3573c79899a6877d65"
+SHASH = "92304eda8d03ebade30fb915bf1f0ab24f3d545b0d394f9d2ab9674b4bfd27fd"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
@@ -13,7 +13,7 @@ from .get_machines import get_machines
 from .get_transformation import get_transformation
 from .initialize import initialize
 from .interrupt import interrupt
-from .open_results_in_en_sight import open_results_in_en_sight
+from .open_results_in_ensight import open_results_in_ensight
 from .partition_participants import partition_participants
 from .shutdown import shutdown
 from .solve import solve
@@ -38,7 +38,7 @@ class solution_root(Container):
         "get_transformation",
         "initialize",
         "interrupt",
-        "open_results_in_en_sight",
+        "open_results_in_ensight",
         "partition_participants",
         "shutdown",
         "solve",
@@ -76,9 +76,9 @@ class solution_root(Container):
     """
     interrupt command of solution_root.
     """
-    open_results_in_en_sight: open_results_in_en_sight = open_results_in_en_sight
+    open_results_in_ensight: open_results_in_ensight = open_results_in_ensight
     """
-    open_results_in_en_sight command of solution_root.
+    open_results_in_ensight command of solution_root.
     """
     partition_participants: partition_participants = partition_participants
     """

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

@@ -104,8 +104,7 @@ class variable_child(Container):
         - Integer
         - Logical
         - String
-        - Enumeration
-        - None"""
+        - Enumeration"""
         return self.get_property_state("data_type")
 
     @data_type.setter