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

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

@@ -44,40 +44,31 @@ class add_participant(InjectedCommand):
     participant executable.
 
     Option 1: Using an input file
-        Given an input file containing participant coupling information, reads the
-        specified file, pushes the participant's information to the data model.
+
+    Given an input file containing participant coupling information, reads the
+    specified file, pushes the participant's information to the data model.
 
     Option 2: Using a participant executable
-        Given the path to the executable for this participant (and optionally,
-        additional arguments and/or working directory), start the participant
-        executable, connect to the participant using the socket connection,
-        and get the participant's information and add it to the data model.
+
+    Given the path to the executable for this participant (and optionally,
+    additional arguments and/or working directory), start the participant
+    executable, connect to the participant using the socket connection,
+    and get the participant's information and add it to the data model.
 
     Parameters
     ----------
     participant_session : ParticipantProtocol, optional
         Participant session object conforming to the ``ParticipantProtocol`` protocol class.
     participant_type : str, optional
-        Participant type. Currently supported types are:
-
-        - \"DEFAULT\"
-        - \"CFX\"
-        - \"FLUENT\"
-        - \"MAPDL\"
-        - \"AEDT\"
-        - \"FMU\"
-        - \"FORTE\"
-        - \"DEFAULT-SRV\"
-        - \"MECH-SRV\"
-        - \"CFD-SRV\"
-
-        If unspecified, ``add_participant`` will attempt to deduce
-        the type from ``input_file``.
+        Participant type. Currently supported types are DEFAULT, CFX,
+        FLUENT, MAPDL, AEDT, FMU, FORTE, DEFAULT-SRV, CFD-SRV, MECH-SRV, and SCDT-SRV.
+        If unspecified, AddParticipant will attempt to deduce the type from
+        Input_file.
     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,
-        and FMU (.fmu) files (Beta).
+        files, mechanical server (\*.rst) files, cfd server (\*.csv) files,
+        FMU (.fmu) files (Beta), 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
@@ -109,21 +100,10 @@ class add_participant(InjectedCommand):
 
     class participant_type(String):
         """
-        Participant type. Currently supported types are:
-
-        - \"DEFAULT\"
-        - \"CFX\"
-        - \"FLUENT\"
-        - \"MAPDL\"
-        - \"AEDT\"
-        - \"FMU\"
-        - \"FORTE\"
-        - \"DEFAULT-SRV\"
-        - \"MECH-SRV\"
-        - \"CFD-SRV\"
-
-        If unspecified, ``add_participant`` will attempt to deduce
-        the type from ``input_file``.
+        Participant type. Currently supported types are DEFAULT, CFX,
+        FLUENT, MAPDL, AEDT, FMU, FORTE, DEFAULT-SRV, CFD-SRV, MECH-SRV, and SCDT-SRV.
+        If unspecified, AddParticipant will attempt to deduce the type from
+        Input_file.
         """
 
         syc_name = "ParticipantType"
@@ -132,8 +112,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,
-        and FMU (.fmu) files (Beta).
+        files, mechanical server (\*.rst) files, cfd server (\*.csv) files,
+        FMU (.fmu) files (Beta), and system coupling data server (\*.scdt/axdt/csv) files.
         """
 
         syc_name = "InputFile"

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

@@ -5,6 +5,7 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 from .apip import apip
+from .automatic_alignment_options import automatic_alignment_options
 from .avoid_data_reconstruction import avoid_data_reconstruction
 from .global_stabilization import global_stabilization
 from .unmapped_value_options import unmapped_value_options
@@ -22,6 +23,7 @@ class analysis_control(Container):
         "apip",
         "avoid_data_reconstruction",
         "unmapped_value_options",
+        "automatic_alignment_options",
     ]
 
     global_stabilization: global_stabilization = global_stabilization
@@ -40,13 +42,26 @@ class analysis_control(Container):
     """
     unmapped_value_options child of analysis_control.
     """
+    automatic_alignment_options: automatic_alignment_options = (
+        automatic_alignment_options
+    )
+    """
+    automatic_alignment_options child of analysis_control.
+    """
     property_names_types = [
         ("analysis_type", "AnalysisType", "str"),
         ("optimize_if_one_way", "OptimizeIfOneWay", "bool"),
         ("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"),
@@ -114,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.
@@ -135,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/avoid_data_reconstruction.py

@@ -15,6 +15,7 @@ class avoid_data_reconstruction(Container):
     property_names_types = [
         ("volume_mapping", "VolumeMapping", "bool"),
         ("surface_mapping", "SurfaceMapping", "bool"),
+        ("surface_volume_mapping", "SurfaceVolumeMapping", "bool"),
     ]
 
     @property
@@ -34,3 +35,12 @@ class avoid_data_reconstruction(Container):
     @surface_mapping.setter
     def surface_mapping(self, value: bool):
         self.set_property_state("surface_mapping", value)
+
+    @property
+    def surface_volume_mapping(self) -> bool:
+        """UNDOCUMENTED"""
+        return self.get_property_state("surface_volume_mapping")
+
+    @surface_volume_mapping.setter
+    def surface_volume_mapping(self, value: bool):
+        self.set_property_state("surface_volume_mapping", value)

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

@@ -7,6 +7,8 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
 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
@@ -24,17 +26,23 @@ class coupling_participant_child(Container):
 
     child_names = [
         "variable",
+        "parameter",
         "region",
         "update_control",
         "fmu_parameter",
         "execution_control",
         "external_data_file",
+        "record_interactions",
     ]
 
     variable: variable = variable
     """
     variable child of coupling_participant_child.
     """
+    parameter: parameter = parameter
+    """
+    parameter child of coupling_participant_child.
+    """
     region: region = region
     """
     region child of coupling_participant_child.
@@ -55,16 +63,27 @@ 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"),
         ("display_name", "DisplayName", "str"),
         ("dimension", "Dimension", "str"),
+        ("input_variables", "InputVariables", "StringListType"),
+        ("output_variables", "OutputVariables", "StringListType"),
+        ("input_parameters", "InputParameters", "StringListType"),
+        ("output_parameters", "OutputParameters", "StringListType"),
         ("participant_file_loaded", "ParticipantFileLoaded", "str"),
         ("logging_on", "LoggingOn", "bool"),
         ("participant_analysis_type", "ParticipantAnalysisType", "str"),
         ("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"),
     ]
 
@@ -83,7 +102,8 @@ class coupling_participant_child(Container):
         - \"FORTE\"
         - \"DEFAULT-SRV\"
         - \"MECH-SRV\"
-        - \"CFD-SRV\" """
+        - \"CFD-SRV\"
+        - \"SCDT-SRV\" """
         return self.get_property_state("participant_type")
 
     @participant_type.setter
@@ -118,6 +138,42 @@ class coupling_participant_child(Container):
     def dimension(self, value: str):
         self.set_property_state("dimension", value)
 
+    @property
+    def input_variables(self) -> StringListType:
+        """Input variables for the region or FMU."""
+        return self.get_property_state("input_variables")
+
+    @input_variables.setter
+    def input_variables(self, value: StringListType):
+        self.set_property_state("input_variables", value)
+
+    @property
+    def output_variables(self) -> StringListType:
+        """Output variables for the region or FMU."""
+        return self.get_property_state("output_variables")
+
+    @output_variables.setter
+    def output_variables(self, value: StringListType):
+        self.set_property_state("output_variables", value)
+
+    @property
+    def input_parameters(self) -> StringListType:
+        """Input parameters for the solver."""
+        return self.get_property_state("input_parameters")
+
+    @input_parameters.setter
+    def input_parameters(self, value: StringListType):
+        self.set_property_state("input_parameters", value)
+
+    @property
+    def output_parameters(self) -> StringListType:
+        """Output parameters for the solver."""
+        return self.get_property_state("output_parameters")
+
+    @output_parameters.setter
+    def output_parameters(self, value: StringListType):
+        self.set_property_state("output_parameters", value)
+
     @property
     def participant_file_loaded(self) -> str:
         """File used to generate the participant."""
@@ -147,7 +203,7 @@ class coupling_participant_child(Container):
 
     @property
     def use_new_apis(self) -> bool:
-        """Controls whether a Fluent or MAPDL participant should communicate using new APIs."""
+        """Controls whether Fluent/MAPDL/AEDT/CFX participant should communicate using new APIs."""
         return self.get_property_state("use_new_apis")
 
     @use_new_apis.setter
@@ -163,6 +219,33 @@ class coupling_participant_child(Container):
     def restarts_supported(self, value: bool):
         self.set_property_state("restarts_supported", value)
 
+    @property
+    def can_serialize_fmu_state(self) -> bool:
+        """Indicates whether the FMU can state can be serialized."""
+        return self.get_property_state("can_serialize_fmu_state")
+
+    @can_serialize_fmu_state.setter
+    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/fmu_parameter_child.py

@@ -24,6 +24,9 @@ class fmu_parameter_child(Container):
         ("integer_max", "IntegerMax", "int"),
         ("logical_value", "LogicalValue", "bool"),
         ("string_value", "StringValue", "str"),
+        ("enumeration_value", "EnumerationValue", "int"),
+        ("enumeration_min", "EnumerationMin", "int"),
+        ("enumeration_max", "EnumerationMax", "int"),
     ]
 
     @property
@@ -124,3 +127,30 @@ class fmu_parameter_child(Container):
     @string_value.setter
     def string_value(self, value: str):
         self.set_property_state("string_value", value)
+
+    @property
+    def enumeration_value(self) -> int:
+        """Enumeration data start value."""
+        return self.get_property_state("enumeration_value")
+
+    @enumeration_value.setter
+    def enumeration_value(self, value: int):
+        self.set_property_state("enumeration_value", 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)

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

@@ -10,11 +10,11 @@ class has_input_file_changed(Command):
     Given the name of a participant, checks whether the input file has changed.
 
     Available for server participants. Currently, only input files for
-    DEFAULT-SRV, CFD-SRV, and MECH-SRV participants are tracked by
+    DEFAULT-SRV, CFD-SRV, MECH-SRV, and SCDT-SRV participants are tracked by
     System Coupling.
 
     If a participant's input files are not tracked by System Coupling, this
-    command will return ``False`` in all cases, even if changes have been made
+    command will return False in all cases, even if changes have been made
     to the participant input file.
 
     Parameters

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/output_control.py

@@ -5,6 +5,7 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 from .ascii_output import ascii_output
+from .live_visualization import live_visualization
 from .results import results
 
 
@@ -15,7 +16,7 @@ class output_control(Container):
 
     syc_name = "OutputControl"
 
-    child_names = ["results", "ascii_output"]
+    child_names = ["results", "ascii_output", "live_visualization"]
 
     results: results = results
     """
@@ -25,6 +26,10 @@ class output_control(Container):
     """
     ascii_output child of output_control.
     """
+    live_visualization: live_visualization = live_visualization
+    """
+    live_visualization child of output_control.
+    """
     property_names_types = [
         ("option", "Option", "str"),
         ("generate_csv_chart_output", "GenerateCSVChartOutput", "bool"),

ansys/systemcoupling/core/adaptor/{api_24_2 → api_24_1}/record_interactions.py

@@ -15,7 +15,6 @@ class record_interactions(Container):
     property_names_types = [
         ("record_setup", "RecordSetup", "bool"),
         ("record_solution", "RecordSolution", "bool"),
-        ("record_precision", "RecordPrecision", "int"),
     ]
 
     @property
@@ -35,12 +34,3 @@ class record_interactions(Container):
     @record_solution.setter
     def record_solution(self, value: bool):
         self.set_property_state("record_solution", value)
-
-    @property
-    def record_precision(self) -> int:
-        """Set the digital precision of solution variable,1 <= N <= 16.."""
-        return self.get_property_state("record_precision")
-
-    @record_precision.setter
-    def record_precision(self, value: int):
-        self.set_property_state("record_precision", value)

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

@@ -37,7 +37,7 @@ class region_child(Container):
 
     @property
     def input_variables(self) -> StringListType:
-        """Input variables for the region."""
+        """Input variables for the region or FMU."""
         return self.get_property_state("input_variables")
 
     @input_variables.setter
@@ -46,7 +46,7 @@ class region_child(Container):
 
     @property
     def output_variables(self) -> StringListType:
-        """Output variables for the region."""
+        """Output variables for the region or FMU."""
         return self.get_property_state("output_variables")
 
     @output_variables.setter