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

ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/fmu_parameter_child.py

@@ -24,9 +24,6 @@ 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
@@ -127,30 +124,3 @@ 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_2 → api_23_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, MECH-SRV, and SCDT-SRV participants are tracked by
+    DEFAULT-SRV, CFD-SRV, and MECH-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_2 → api_23_1}/mapping_control.py

@@ -42,7 +42,6 @@ class mapping_control(Container):
         ("rbf_shape_parameter", "RBFShapeParameter", "RealType"),
         ("rbf_linear_correction", "RBFLinearCorrection", "bool"),
         ("rbf_clipping_scale", "RBFClippingScale", "RealType"),
-        ("clipping", "Clipping", "bool"),
     ]
 
     @property
@@ -228,12 +227,3 @@ 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_2 → api_23_1}/open_results_in_ensight.py

@@ -23,34 +23,6 @@ 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_2 → api_23_1}/output_control.py

@@ -5,7 +5,6 @@
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
 from .ascii_output import ascii_output
-from .live_visualization import live_visualization
 from .results import results
 
 
@@ -16,7 +15,7 @@ class output_control(Container):
 
     syc_name = "OutputControl"
 
-    child_names = ["results", "ascii_output", "live_visualization"]
+    child_names = ["results", "ascii_output"]
 
     results: results = results
     """
@@ -26,10 +25,6 @@ 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_23_1}/region_child.py

@@ -26,6 +26,7 @@ class region_child(Container):
 
         Allowed values:
 
+        - \"Undefined\" (FMU participants only)
         - \"Surface\"
         - \"Volume\" (3D participants only)"""
         return self.get_property_state("topology")
@@ -36,7 +37,7 @@ class region_child(Container):
 
     @property
     def input_variables(self) -> StringListType:
-        """Input variables for the region or FMU."""
+        """Input variables for the region."""
         return self.get_property_state("input_variables")
 
     @input_variables.setter
@@ -45,7 +46,7 @@ class region_child(Container):
 
     @property
     def output_variables(self) -> StringListType:
-        """Output variables for the region or FMU."""
+        """Output variables for the region."""
         return self.get_property_state("output_variables")
 
     @output_variables.setter

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

@@ -2,37 +2,30 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "98b88d4e6b13c3114a995ba993ef773d805d52bb704b356b6890661a50760070"
+SHASH = "faa921cc93dcfd82765876c7d8016504355fe48b9a4639cf4cef834646f944c7"
 
 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
@@ -89,28 +82,21 @@ 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",
@@ -121,12 +107,6 @@ 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.
@@ -141,10 +121,6 @@ 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.
@@ -159,10 +135,6 @@ 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.
@@ -171,10 +143,6 @@ 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.
@@ -187,20 +155,10 @@ 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
     )
@@ -215,12 +173,6 @@ 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_2 → api_23_1}/solution_control.py

@@ -27,8 +27,6 @@ class solution_control(Container):
         ("time_step_size", "TimeStepSize", "RealType"),
         ("minimum_iterations", "MinimumIterations", "int"),
         ("maximum_iterations", "MaximumIterations", "int"),
-        ("use_ip_address_when_possible", "UseIPAddressWhenPossible", "bool"),
-        ("use_local_host_when_possible", "UseLocalHostWhenPossible", "bool"),
     ]
 
     @property
@@ -91,25 +89,3 @@ class solution_control(Container):
     @maximum_iterations.setter
     def maximum_iterations(self, value: int):
         self.set_property_state("maximum_iterations", value)
-
-    @property
-    def use_ip_address_when_possible(self) -> bool:
-        """If True (the default), prefer to use IPv4 address rather than hostname for
-        participant server connections. There is no guarantee that this request
-        can be satisfied for all participants."""
-        return self.get_property_state("use_ip_address_when_possible")
-
-    @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_2 → api_23_1}/solution_root.py

@@ -2,7 +2,7 @@
 # This is an auto-generated file.  DO NOT EDIT!
 #
 
-SHASH = "92304eda8d03ebade30fb915bf1f0ab24f3d545b0d394f9d2ab9674b4bfd27fd"
+SHASH = "54b4aa678f0aea8cebeca86bcd71b2877e846e53079c2bf52974d5e039ed3719"
 
 from ansys.systemcoupling.core.adaptor.impl.types import *
 
@@ -10,7 +10,6 @@ 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
@@ -35,7 +34,6 @@ class solution_root(Container):
         "abort",
         "create_restart_point",
         "get_machines",
-        "get_transformation",
         "initialize",
         "interrupt",
         "open_results_in_ensight",
@@ -64,10 +62,6 @@ class solution_root(Container):
     """
     get_machines command of solution_root.
     """
-    get_transformation: get_transformation = get_transformation
-    """
-    get_transformation command of solution_root.
-    """
     initialize: initialize = initialize
     """
     initialize command of solution_root.

ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/start_participants.py

@@ -7,7 +7,7 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
 
 class start_participants(Command):
     """
-    Important: This command is deprecated. Consider adopting workflows
+    Important: This command will be deprecated. Consider adopting workflows
     where participants are started by another method, such as the ``initialize``,
     ``step``, or ``solve`` commands.
 

ansys/systemcoupling/core/adaptor/{api_24_2 → api_23_1}/update_participant.py

@@ -9,8 +9,8 @@ class update_participant(Command):
     """
     Given the name of a server participant, updates the state of the participant.
 
-    Available for server participants. Currently, only DEFAULT-SRV,
-    CFD-SRV, MECH-SRV, and SCDT-SRV participants may be updated.
+    Available for server participants. Currently, only ``DEFAULT-SRV``,
+    ``CFD-SRV``, and ``MECH-SRV`` participants may be updated.
 
     As part of the update, System Coupling updates all regions and
     variables defined in the participant, including all variable
@@ -29,12 +29,12 @@ class update_participant(Command):
     ----------
     participant_name : str
         Participant name. Must be the name of an existing participant.
-        Participant type can be either DEFAULT-SRV, CFD-SRV, MECH-SRV, or SCDT-SRV.
+        Participant type can be either DEFAULT-SRV, MECH-SRV, or CFD-SRV.
     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 (Beta), and system coupling data server (\*.scdt/axdt/csv) files.
+        files, mechanical server (*.rst) files, cfd server (*.csv) files,
+        and FMU (.fmu) files (Beta).
 
     """
 
@@ -45,7 +45,7 @@ class update_participant(Command):
     class participant_name(String):
         """
         Participant name. Must be the name of an existing participant.
-        Participant type can be either DEFAULT-SRV, CFD-SRV, MECH-SRV, or SCDT-SRV.
+        Participant type can be either DEFAULT-SRV, MECH-SRV, or CFD-SRV.
         """
 
         syc_name = "ParticipantName"
@@ -54,8 +54,8 @@ class update_participant(Command):
         """
         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 (Beta), and system coupling data server (\*.scdt/axdt/csv) files.
+        files, mechanical server (*.rst) files, cfd server (*.csv) files,
+        and FMU (.fmu) files (Beta).
         """
 
         syc_name = "InputFile"

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

@@ -30,13 +30,10 @@ 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"),
     ]
@@ -104,7 +101,7 @@ class variable_child(Container):
         - Integer
         - Logical
         - String
-        - Enumeration"""
+        - None"""
         return self.get_property_state("data_type")
 
     @data_type.setter
@@ -147,15 +144,6 @@ 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."""
@@ -192,24 +180,6 @@ 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_data_transfer_by_display_names.py

@@ -7,6 +7,9 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
 
 class add_data_transfer_by_display_names(Command):
     """
+    Important: This command is deprecated. To add an interface, use the
+    ``add_data_transfer`` command instead.
+
     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 display names

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

@@ -16,15 +16,12 @@ class add_fsi_data_transfers(Command):
     interface : str
         String indicating the name of the interface on which the data transfer
         is to be created.
-    use_force_density : bool, optional
-        Boolean indicating whether to prefer force density variable over force.
-        Default value is False.
 
     """
 
     syc_name = "AddFSIDataTransfers"
 
-    argument_names = ["interface", "use_force_density"]
+    argument_names = ["interface"]
 
     class interface(String):
         """
@@ -33,11 +30,3 @@ class add_fsi_data_transfers(Command):
         """
 
         syc_name = "Interface"
-
-    class use_force_density(Boolean):
-        """
-        Boolean indicating whether to prefer force density variable over force.
-        Default value is False.
-        """
-
-        syc_name = "UseForceDensity"

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

@@ -8,9 +8,11 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
 class add_interface(Command):
     """
     Adds an interface based on the participant and region names specified
-    as arguments for each side of the interface. This command requires that you
-    specify participants and regions using their names (see parameter
-    descriptions for details).
+    as arguments for each side of the interface. This command requires that
+    you specify participants using their names as described below in
+    Essential Keyword Arguments. Non-FMU participants must provide a list
+    of regions as described below in Optional Keyword Arguments. For FMU
+    interfaces, specifying the regions are not allowed.
 
     Cannot be run after participants have been started.
 
@@ -21,15 +23,15 @@ 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]
-        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]
-        List specifying the name(s) of region(s) to be added to side \"Two\" of
-        the interface.
+        side \"Two"\ of the interface.
+    side_one_regions : typing.List[str], 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
+        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.
 
     """
 
@@ -37,8 +39,8 @@ class add_interface(Command):
 
     argument_names = [
         "side_one_participant",
-        "side_one_regions",
         "side_two_participant",
+        "side_one_regions",
         "side_two_regions",
     ]
 
@@ -50,26 +52,26 @@ class add_interface(Command):
 
         syc_name = "SideOneParticipant"
 
-    class side_one_regions(StringList):
+    class side_two_participant(String):
         """
-        List specifying the name(s) of region(s) to be added to side \"One\" of
-        the interface.
+        String indicating the name of the participant to be associated with
+        side \"Two"\ of the interface.
         """
 
-        syc_name = "SideOneRegions"
+        syc_name = "SideTwoParticipant"
 
-    class side_two_participant(String):
+    class side_one_regions(StringList):
         """
-        String indicating the name of the participant to be associated with
-        side \"Two\" of the interface.
+        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.
         """
 
-        syc_name = "SideTwoParticipant"
+        syc_name = "SideOneRegions"
 
     class side_two_regions(StringList):
         """
-        List specifying the name(s) of region(s) to be added to side \"Two\" of
-        the interface.
+        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.
         """
 
         syc_name = "SideTwoRegions"

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

@@ -7,6 +7,9 @@ from ansys.systemcoupling.core.adaptor.impl.types import *
 
 class add_interface_by_display_names(Command):
     """
+    Important: This command is deprecated. To add an interface, use the
+    ``add_interface`` command instead.
+
     Adds an interface based on the participant and region display names specified
     as arguments for each side of the interface. This command requires that you
     specify participants and regions using their *display* names (see parameter