ansys-systemcoupling-core 0.9.1__py3-none-any.whl → 0.10.0__py3-none-any.whl

ansys/systemcoupling/core/adaptor/api_25_2/expression_child.py

@@ -0,0 +1,36 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class expression_child(Container):
+    """
+    Define a named expression that can be referenced in other expressions.
+    """
+
+    syc_name = "child_object_type"
+
+    property_names_types = [
+        ("expression_name", "ExpressionName", "str"),
+        ("expression_string", "ExpressionString", "str"),
+    ]
+
+    @property
+    def expression_name(self) -> str:
+        """Name used to reference this expression from another expression"""
+        return self.get_property_state("expression_name")
+
+    @expression_name.setter
+    def expression_name(self, value: str):
+        self.set_property_state("expression_name", value)
+
+    @property
+    def expression_string(self) -> str:
+        """String defining the expression."""
+        return self.get_property_state("expression_string")
+
+    @expression_string.setter
+    def expression_string(self, value: str):
+        self.set_property_state("expression_string", value)

ansys/systemcoupling/core/adaptor/api_25_2/expression_function.py

@@ -0,0 +1,20 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .expression_function_child import expression_function_child
+
+
+class expression_function(NamedContainer[expression_function_child]):
+    """
+    Makes an external Python function accessible from expressions.
+    """
+
+    syc_name = "ExpressionFunction"
+
+    child_object_type: expression_function_child = expression_function_child
+    """
+    child_object_type of expression_function.
+    """

ansys/systemcoupling/core/adaptor/api_25_2/expression_function_child.py

@@ -0,0 +1,46 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class expression_function_child(Container):
+    """
+    Makes an external Python function accessible from expressions.
+    """
+
+    syc_name = "child_object_type"
+
+    property_names_types = [
+        ("module", "Module", "str"),
+        ("function", "Function", "str"),
+        ("function_name", "FunctionName", "str"),
+    ]
+
+    @property
+    def module(self) -> str:
+        """Name of the Python module that exports the function."""
+        return self.get_property_state("module")
+
+    @module.setter
+    def module(self, value: str):
+        self.set_property_state("module", value)
+
+    @property
+    def function(self) -> str:
+        """Name of the function in the module."""
+        return self.get_property_state("function")
+
+    @function.setter
+    def function(self, value: str):
+        self.set_property_state("function", value)
+
+    @property
+    def function_name(self) -> str:
+        """Name to use when referencing the function in an expression."""
+        return self.get_property_state("function_name")
+
+    @function_name.setter
+    def function_name(self, value: str):
+        self.set_property_state("function_name", value)

ansys/systemcoupling/core/adaptor/api_25_2/external_data_file.py

@@ -0,0 +1,24 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class external_data_file(Container):
+    """
+    Participant external data file settings.
+    """
+
+    syc_name = "ExternalDataFile"
+
+    property_names_types = [("file_path", "FilePath", "str")]
+
+    @property
+    def file_path(self) -> str:
+        """Path to file for communication with a coupling participant."""
+        return self.get_property_state("file_path")
+
+    @file_path.setter
+    def file_path(self, value: str):
+        self.set_property_state("file_path", value)

ansys/systemcoupling/core/adaptor/api_25_2/fluent_input.py

@@ -0,0 +1,77 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class fluent_input(Container):
+    """
+    Fluent input.
+    """
+
+    syc_name = "FluentInput"
+
+    property_names_types = [
+        ("option", "Option", "str"),
+        ("case_file", "CaseFile", "str"),
+        ("data_file", "DataFile", "str"),
+        ("enable_autosave", "EnableAutosave", "bool"),
+        ("journal_file", "JournalFile", "str"),
+    ]
+
+    @property
+    def option(self) -> str:
+        """Type of solver input file(s) to be used for the Fluent run.
+
+        Allowed values:
+
+        - \"InitialCaseFile\" - (Default) A case file will be defined as a
+          solver input for the coupled analysis run.
+
+        - \"InitialCaseAndDataFile\" - A Fluent case file and data file
+          will be defined as solver inputs for the coupled analysis run.
+
+        - \"JournalFile\" - A journal file will be defined as the solver
+          input for the coupled analysis run."""
+        return self.get_property_state("option")
+
+    @option.setter
+    def option(self, value: str):
+        self.set_property_state("option", value)
+
+    @property
+    def case_file(self) -> str:
+        """Set Fluent initial case file."""
+        return self.get_property_state("case_file")
+
+    @case_file.setter
+    def case_file(self, value: str):
+        self.set_property_state("case_file", value)
+
+    @property
+    def data_file(self) -> str:
+        """Set Fluent initial data file."""
+        return self.get_property_state("data_file")
+
+    @data_file.setter
+    def data_file(self, value: str):
+        self.set_property_state("data_file", value)
+
+    @property
+    def enable_autosave(self) -> bool:
+        """Set Fluent autosave frequency to System Coupling output control frequency to generate .flprj file."""
+        return self.get_property_state("enable_autosave")
+
+    @enable_autosave.setter
+    def enable_autosave(self, value: bool):
+        self.set_property_state("enable_autosave", value)
+
+    @property
+    def journal_file(self) -> str:
+        """Set Fluent journal file."""
+        return self.get_property_state("journal_file")
+
+    @journal_file.setter
+    def journal_file(self, value: str):
+        self.set_property_state("journal_file", value)

ansys/systemcoupling/core/adaptor/api_25_2/fmu_parameter.py

@@ -0,0 +1,20 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .fmu_parameter_child import fmu_parameter_child
+
+
+class fmu_parameter(NamedContainer[fmu_parameter_child]):
+    """
+    Configure a parameter for an FMU coupling participant.
+    """
+
+    syc_name = "FMUParameter"
+
+    child_object_type: fmu_parameter_child = fmu_parameter_child
+    """
+    child_object_type of fmu_parameter.
+    """

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

@@ -0,0 +1,164 @@
+#
+# 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:
+        """FMUParameter's data type as reported by the participant.
+
+        Allowed values:
+
+        - Real
+        - Integer
+        - Logical
+        - String
+        - Enumeration"""
+        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_25_2/generate_input_file.py

@@ -0,0 +1,53 @@
+#
+# 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.
+
+    Available for Fluent participants when ``fluent_input.option`` is not
+    set to ``journal_file``.
+
+    Given the participant's name and a file name, generates a Fluent
+    journal script which may be set as the value for the ``journal_file``
+    setting.
+
+    System Coupling uses the generated scrkpt for the coupled analysis.
+
+    Scripts generated using this method may be edited before the
+    coupled analysis is started.
+
+    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_25_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_25_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_25_2/get_machines.py

@@ -0,0 +1,34 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_machines(Command):
+    """
+    Get a list of dictionaries with machine names and core counts for
+    the machines available for parallel processing.
+
+    Returns information in the following format::
+
+        [
+            {
+            'machine-name' : <machine-name-1 (str)>,
+            'core-count' : <core-count-1 (int)>
+            },
+            {
+            'machine-name' : <machine-name-2 (str)>,
+            'core-count' : <core-count-2 (int)>
+            },
+            ...
+        ]
+
+    Returns an empty list when machines and core counts are not
+    provided to System Coupling. You may specify those
+    by providing --cnf command-line option when starting System
+    Coupling. You can also specify those via the Parallel
+    Partitioning dialog box in the System Coupling GUI.
+    """
+
+    syc_name = "GetMachines"

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

@@ -0,0 +1,32 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_region_names_for_participant(Command):
+    """
+    This query is deprecated and will be deleted in future releases.
+    To get region names for a participant, you can use ``get_child_names``
+    query, for example:
+
+    ``setup.coupling_participant[name].region.get_child_names()```
+
+    Parameters
+    ----------
+    participant_name : str
+        Name of the participant.
+
+    """
+
+    syc_name = "GetRegionNamesForParticipant"
+
+    argument_names = ["participant_name"]
+
+    class participant_name(String):
+        """
+        Name of the participant.
+        """
+
+        syc_name = "ParticipantName"

ansys/systemcoupling/core/adaptor/api_25_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_25_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"