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

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

@@ -0,0 +1,156 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class fmu_parameter_child(Container):
+    """
+    Configure a parameter for an FMU coupling participant.
+    """
+
+    syc_name = "child_object_type"
+
+    property_names_types = [
+        ("data_type", "DataType", "str"),
+        ("participant_display_name", "ParticipantDisplayName", "str"),
+        ("display_name", "DisplayName", "str"),
+        ("real_value", "RealValue", "RealType"),
+        ("real_min", "RealMin", "RealType"),
+        ("real_max", "RealMax", "RealType"),
+        ("integer_value", "IntegerValue", "int"),
+        ("integer_min", "IntegerMin", "int"),
+        ("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
+    def data_type(self) -> str:
+        """UNDOCUMENTED"""
+        return self.get_property_state("data_type")
+
+    @data_type.setter
+    def data_type(self, value: str):
+        self.set_property_state("data_type", value)
+
+    @property
+    def participant_display_name(self) -> str:
+        """Parameter's display name as defined by the participant solver."""
+        return self.get_property_state("participant_display_name")
+
+    @participant_display_name.setter
+    def participant_display_name(self, value: str):
+        self.set_property_state("participant_display_name", value)
+
+    @property
+    def display_name(self) -> str:
+        """Parameter's display name as defined in System Coupling."""
+        return self.get_property_state("display_name")
+
+    @display_name.setter
+    def display_name(self, value: str):
+        self.set_property_state("display_name", value)
+
+    @property
+    def real_value(self) -> RealType:
+        """Real data start value."""
+        return self.get_property_state("real_value")
+
+    @real_value.setter
+    def real_value(self, value: RealType):
+        self.set_property_state("real_value", value)
+
+    @property
+    def real_min(self) -> RealType:
+        """Real data minimum value."""
+        return self.get_property_state("real_min")
+
+    @real_min.setter
+    def real_min(self, value: RealType):
+        self.set_property_state("real_min", value)
+
+    @property
+    def real_max(self) -> RealType:
+        """Real data maximum value."""
+        return self.get_property_state("real_max")
+
+    @real_max.setter
+    def real_max(self, value: RealType):
+        self.set_property_state("real_max", value)
+
+    @property
+    def integer_value(self) -> int:
+        """Integer data start value."""
+        return self.get_property_state("integer_value")
+
+    @integer_value.setter
+    def integer_value(self, value: int):
+        self.set_property_state("integer_value", value)
+
+    @property
+    def integer_min(self) -> int:
+        """Integer data minimum value."""
+        return self.get_property_state("integer_min")
+
+    @integer_min.setter
+    def integer_min(self, value: int):
+        self.set_property_state("integer_min", value)
+
+    @property
+    def integer_max(self) -> int:
+        """Integer data maximum value."""
+        return self.get_property_state("integer_max")
+
+    @integer_max.setter
+    def integer_max(self, value: int):
+        self.set_property_state("integer_max", value)
+
+    @property
+    def logical_value(self) -> bool:
+        """Logical data start value."""
+        return self.get_property_state("logical_value")
+
+    @logical_value.setter
+    def logical_value(self, value: bool):
+        self.set_property_state("logical_value", value)
+
+    @property
+    def string_value(self) -> str:
+        """String data start value."""
+        return self.get_property_state("string_value")
+
+    @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/generate_input_file.py

@@ -0,0 +1,41 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class generate_input_file(Command):
+    """
+    Generates the input journal file for a given Fluent participant.
+
+    Parameters
+    ----------
+    participant_name : str
+        Name of the participant for which the execution command will
+        be returned.
+    file_name : str
+        Name of the journal script to be written. Note that this name is relative
+        to the participant's working directory.
+
+    """
+
+    syc_name = "GenerateInputFile"
+
+    argument_names = ["participant_name", "file_name"]
+
+    class participant_name(String):
+        """
+        Name of the participant for which the execution command will
+        be returned.
+        """
+
+        syc_name = "ParticipantName"
+
+    class file_name(String):
+        """
+        Name of the journal script to be written. Note that this name is relative
+        to the participant's working directory.
+        """
+
+        syc_name = "FileName"

ansys/systemcoupling/core/adaptor/api_24_2/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_2/get_execution_command.py

@@ -0,0 +1,30 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_execution_command(Command):
+    """
+    Gets the execution command needed to start the specified participant
+
+    Parameters
+    ----------
+    participant_name : str
+        Name of the participant for which the execution command will
+        be returned.
+
+    """
+
+    syc_name = "GetExecutionCommand"
+
+    argument_names = ["participant_name"]
+
+    class participant_name(String):
+        """
+        Name of the participant for which the execution command will
+        be returned.
+        """
+
+        syc_name = "ParticipantName"

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

@@ -0,0 +1,13 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_machines(Command):
+    """
+    Get currently available machines.
+    """
+
+    syc_name = "GetMachines"

ansys/systemcoupling/core/adaptor/api_24_2/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_2/get_region_names_for_participant.py

@@ -0,0 +1,31 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_region_names_for_participant(Command):
+    """
+    Gets all of the specified participant's regions.
+
+    Returns a dictionary with the regions as keys and the corresponding
+    display names as values.
+
+    Parameters
+    ----------
+    participant_name : str
+        String indicating the participant for which regions are returned.
+
+    """
+
+    syc_name = "GetRegionNamesForParticipant"
+
+    argument_names = ["participant_name"]
+
+    class participant_name(String):
+        """
+        String indicating the participant for which regions are returned.
+        """
+
+        syc_name = "ParticipantName"

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

@@ -0,0 +1,25 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_setup_summary(InjectedCommand):
+    """
+    Returns a string containing a formatted summary of the
+    coupled analysis setup.
+
+    This summary is printed in the System Coupling transcript
+    output at the beginning of a solve. However, it is sometimes
+    useful to see the summary before starting the solve.
+
+    The summary output is generated by System Coupling and is not
+    modified for PySystemCoupling purposes. Any ``datamodel`` type names
+    that are referenced in the summary therefore might not
+    be fully consistent with PySystemCoupling conventions.
+    """
+
+    syc_name = "GetSetupSummary"
+
+    cmd_name = "get_setup_summary"

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

@@ -0,0 +1,52 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_status_messages(InjectedCommand):
+    """
+    Provides information relating to the current state of the analysis setup.
+
+    The return value is a list of dictionaries. Each dictionary holds a
+    single message about the setup status, along with some associated information.
+    The dictionary has string-valued fields: ``"message"``, ``"level"``,
+    and ``"path"``.
+
+    The ``"message"`` field is the actual text of the message.
+
+    .. note::
+       In the current release, generated messages have not been adapted to
+       the PySystemCoupling environment and may use naming and terminology that
+       is native to the System Coupling application and its own command line
+       interface.
+
+       Because there is generally a straightforward mapping to the PySystemCoupling
+       exposure of settings and so on, the messages should not be difficult
+       to interpret. Nevertheless, the ``get_status_messages`` method should
+       be regarded as *beta* functionality in the current release.
+
+    The ``"level"`` field provides information about the severity or nature of the
+    message. Possible values are ``"Error"``, ``"Warning"``, ``"Information"``,
+    ``"Alpha"``, and ``"Beta"``. ``"Alpha"`` and ``"Beta"`` indicate settings related
+    to activated alpha or beta features.
+
+    It is not possible to solve an analysis that has any issues at the ``"Error"``
+    severity level. An attempt to invoke the ``solve`` command while there are
+    any errors results in an immediate failure.
+
+    If the ``"path"`` field is set, it contains a string representation of the path
+    to the setting to which the message pertains. This is given in the form of
+    chained Python attribute accesses starting from the ``setup`` attribute.
+
+    Thus, if an issue were detected that is specific to the ``absolute_gap_tolerance``
+    setting in a particular coupling interface, a ``"path"`` such as the following would
+    be provided:
+
+    ``'coupling_interface["Interface-1"].mapping_control.absolute_gap_tolerance'``
+    """
+
+    syc_name = "GetErrors"
+
+    cmd_name = "get_status_messages"

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

@@ -0,0 +1,13 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_supported_participant_types(Command):
+    """
+    Returns a list of participant types that are supported by System Coupling.
+    """
+
+    syc_name = "GetSupportedParticipantTypes"

ansys/systemcoupling/core/adaptor/api_24_2/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_2/get_transformation.py

@@ -0,0 +1,43 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_transformation(Command):
+    """
+    Given an interface and side, returns the resultant transformation, in
+    the form of a Python dictionary and formatted as a DataModel
+    reference_frame object. If multiple transformations are applied to the
+    interface side, the composite transformation is returned.
+
+    This command can only be invoked after the analysis
+    is initialized.
+
+    Parameters
+    ----------
+    interface_name : str
+        Name of the interface
+    side : str
+        Interface side. Can be "One" or "Two".
+
+    """
+
+    syc_name = "GetTransformation"
+
+    argument_names = ["interface_name", "side"]
+
+    class interface_name(String):
+        """
+        Name of the interface
+        """
+
+        syc_name = "InterfaceName"
+
+    class side(String):
+        """
+        Interface side. Can be "One" or "Two".
+        """
+
+        syc_name = "Side"

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

@@ -0,0 +1,143 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class global_stabilization(Container):
+    """
+    Global stabilization settings.
+    """
+
+    syc_name = "GlobalStabilization"
+
+    property_names_types = [
+        ("option", "Option", "str"),
+        ("initial_iterations", "InitialIterations", "int"),
+        ("initial_relaxation_factor", "InitialRelaxationFactor", "RealType"),
+        ("maximum_retained_time_steps", "MaximumRetainedTimeSteps", "int"),
+        ("maximum_retained_iterations", "MaximumRetainedIterations", "int"),
+        ("diagnostics_level", "DiagnosticsLevel", "int"),
+        ("weight_option", "WeightOption", "str"),
+        ("qr_tol_this_step", "QRTolThisStep", "RealType"),
+        ("qr_tol_old_steps", "QRTolOldSteps", "RealType"),
+        ("qr_solver", "QRSolver", "str"),
+    ]
+
+    @property
+    def option(self) -> str:
+        """Stabilization type.
+
+        Allowed values:
+
+        - \"None\"
+        - \"Quasi-Newton\" """
+        return self.get_property_state("option")
+
+    @option.setter
+    def option(self, value: str):
+        self.set_property_state("option", value)
+
+    @property
+    def initial_iterations(self) -> int:
+        """Number of pre-stabilization iterations to perform."""
+        return self.get_property_state("initial_iterations")
+
+    @initial_iterations.setter
+    def initial_iterations(self, value: int):
+        self.set_property_state("initial_iterations", value)
+
+    @property
+    def initial_relaxation_factor(self) -> RealType:
+        """Relaxation factor applied for pre-stabilization iterations."""
+        return self.get_property_state("initial_relaxation_factor")
+
+    @initial_relaxation_factor.setter
+    def initial_relaxation_factor(self, value: RealType):
+        self.set_property_state("initial_relaxation_factor", value)
+
+    @property
+    def maximum_retained_time_steps(self) -> int:
+        """Controls the maximum number of timesteps to retain."""
+        return self.get_property_state("maximum_retained_time_steps")
+
+    @maximum_retained_time_steps.setter
+    def maximum_retained_time_steps(self, value: int):
+        self.set_property_state("maximum_retained_time_steps", value)
+
+    @property
+    def maximum_retained_iterations(self) -> int:
+        """Controls the maximum number of iterations to retain."""
+        return self.get_property_state("maximum_retained_iterations")
+
+    @maximum_retained_iterations.setter
+    def maximum_retained_iterations(self, value: int):
+        self.set_property_state("maximum_retained_iterations", value)
+
+    @property
+    def diagnostics_level(self) -> int:
+        """Controls the maximum number of timesteps to retain.
+
+        Values are interpreted as:
+
+        - 0 : none
+        - 1 : basic
+        - 2 : advanced
+        - 3 : write matrix files"""
+        return self.get_property_state("diagnostics_level")
+
+    @diagnostics_level.setter
+    def diagnostics_level(self, value: int):
+        self.set_property_state("diagnostics_level", value)
+
+    @property
+    def weight_option(self) -> str:
+        """Weight factor when multiple transfers are stabilized.
+
+        Allowed values:
+
+        - \"Constant\"
+        - \"Value\"
+        - \"Residual\"
+        - \"ResidualSum\"
+        - \"InverseResidual\"
+        - \"InverseResidualSum\" """
+        return self.get_property_state("weight_option")
+
+    @weight_option.setter
+    def weight_option(self, value: str):
+        self.set_property_state("weight_option", value)
+
+    @property
+    def qr_tol_this_step(self) -> RealType:
+        """QR filter tolerance for current step."""
+        return self.get_property_state("qr_tol_this_step")
+
+    @qr_tol_this_step.setter
+    def qr_tol_this_step(self, value: RealType):
+        self.set_property_state("qr_tol_this_step", value)
+
+    @property
+    def qr_tol_old_steps(self) -> RealType:
+        """QR filter tolerance for old steps."""
+        return self.get_property_state("qr_tol_old_steps")
+
+    @qr_tol_old_steps.setter
+    def qr_tol_old_steps(self, value: RealType):
+        self.set_property_state("qr_tol_old_steps", value)
+
+    @property
+    def qr_solver(self) -> str:
+        """QR solver options.
+
+        Allowed values:
+
+        - \"QR_MGS\"
+        - \"QR_augmentedMGS\" (default)
+        - \"QR_pivot\" """
+        return self.get_property_state("qr_solver")
+
+    @qr_solver.setter
+    def qr_solver(self, value: str):
+        self.set_property_state("qr_solver", value)

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

@@ -0,0 +1,36 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+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
+    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
+    to the participant input file.
+
+    Parameters
+    ----------
+    participant_name : str
+        Name of the participant
+
+    """
+
+    syc_name = "HasInputFileChanged"
+
+    argument_names = ["participant_name"]
+
+    class participant_name(String):
+        """
+        Name of the participant
+        """
+
+        syc_name = "ParticipantName"