ansys-systemcoupling-core 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

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

@@ -0,0 +1,56 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class open_results_in_en_sight(Command):
+    """
+    Allows for System Coupling results to be postprocessed in EnSight.
+
+    When this command is issued, System Coupling looks for the ``results.enc``
+    file in the ``SyC/results`` subdirectory of the current working directory.
+
+    When System Coupling finds the file, it loads the file into EnSight and
+    generates a confirmation message indicating that results are being opened.
+
+    If System Coupling is unable to find the ``results.enc`` file and/or the
+    EnSight executable, then it raises an error.
+
+    The ``open_results_in_ensight`` command may be issued multiple times from the same
+    instance of System Coupling. Each time the command is issued, a new
+    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/open_snapshot.py

@@ -0,0 +1,37 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class open_snapshot(Command):
+    """
+    Opens a snapshot containing a previously saved state of the simulation.
+    All state (files and directories) stored in the snapshot will be restored.
+    If other state exists in the working directory, then it will not be
+    modified by this command.
+
+    Note: Snapshot cannot be opened if participants have been started.
+
+    Parameters
+    ----------
+    snapshot_name : str, optional
+        The name of the snapshot to be opened. This is optional if and only if
+        there is only one snapshot available to be loaded. If multiple
+        snapshots exist, then the snapshot name must be specified.
+
+    """
+
+    syc_name = "OpenSnapshot"
+
+    argument_names = ["snapshot_name"]
+
+    class snapshot_name(String):
+        """
+        The name of the snapshot to be opened. This is optional if and only if
+        there is only one snapshot available to be loaded. If multiple
+        snapshots exist, then the snapshot name must be specified.
+        """
+
+        syc_name = "SnapshotName"

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

@@ -0,0 +1,134 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .ascii_output import ascii_output
+from .live_visualization import live_visualization
+from .results import results
+
+
+class output_control(Container):
+    """
+    Configure output controls.
+    """
+
+    syc_name = "OutputControl"
+
+    child_names = ["results", "ascii_output", "live_visualization"]
+
+    results: results = results
+    """
+    results child of output_control.
+    """
+    ascii_output: ascii_output = ascii_output
+    """
+    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"),
+        ("write_initial_snapshot", "WriteInitialSnapshot", "bool"),
+        ("transcript_precision", "TranscriptPrecision", "int"),
+        ("write_diagnostics", "WriteDiagnostics", "bool"),
+        ("write_weights_matrix", "WriteWeightsMatrix", "bool"),
+        ("write_residuals", "WriteResiduals", "bool"),
+        ("output_frequency", "OutputFrequency", "int"),
+    ]
+
+    @property
+    def option(self) -> str:
+        """Specifies when restart points are generated.
+
+        Allowed values (step-based analyses only):
+
+        - \"LastStep\" - Generates a restart point only for the last
+          coupling step completed.
+        - \"EveryStep\" -
+          Generate a restart point at the end of every coupling step.
+        - \"StepInterval\" - Generates a restart point at the end of
+          coupling steps at the interval specified by the output
+          frequency setting.
+
+        Allowed values (iteration-based analyses only):
+
+        - \"LastIteration\" - Generates a restart point only for the
+          last coupling iteration completed.
+        - \"EveryIteration\" - Generate a restart point at the end
+          of every coupling iteration.
+        - \"IterationInterval\" - Generates a restart point at the
+          end of coupling iterations at the interval specified by
+          the output frequency setting."""
+        return self.get_property_state("option")
+
+    @option.setter
+    def option(self, value: str):
+        self.set_property_state("option", value)
+
+    @property
+    def generate_csv_chart_output(self) -> bool:
+        """Write chart data in CSV format during solve."""
+        return self.get_property_state("generate_csv_chart_output")
+
+    @generate_csv_chart_output.setter
+    def generate_csv_chart_output(self, value: bool):
+        self.set_property_state("generate_csv_chart_output", value)
+
+    @property
+    def write_initial_snapshot(self) -> bool:
+        """Write initial snapshot."""
+        return self.get_property_state("write_initial_snapshot")
+
+    @write_initial_snapshot.setter
+    def write_initial_snapshot(self, value: bool):
+        self.set_property_state("write_initial_snapshot", value)
+
+    @property
+    def transcript_precision(self) -> int:
+        """Number of digits after decimal point in transcript."""
+        return self.get_property_state("transcript_precision")
+
+    @transcript_precision.setter
+    def transcript_precision(self, value: int):
+        self.set_property_state("transcript_precision", value)
+
+    @property
+    def write_diagnostics(self) -> bool:
+        """Write transfer diagnostics dictionary to file."""
+        return self.get_property_state("write_diagnostics")
+
+    @write_diagnostics.setter
+    def write_diagnostics(self, value: bool):
+        self.set_property_state("write_diagnostics", value)
+
+    @property
+    def write_weights_matrix(self) -> bool:
+        """Write mapping weights to file after calculation."""
+        return self.get_property_state("write_weights_matrix")
+
+    @write_weights_matrix.setter
+    def write_weights_matrix(self, value: bool):
+        self.set_property_state("write_weights_matrix", value)
+
+    @property
+    def write_residuals(self) -> bool:
+        """Write residuals to results files."""
+        return self.get_property_state("write_residuals")
+
+    @write_residuals.setter
+    def write_residuals(self, value: bool):
+        self.set_property_state("write_residuals", value)
+
+    @property
+    def output_frequency(self) -> int:
+        """Specify output frequency."""
+        return self.get_property_state("output_frequency")
+
+    @output_frequency.setter
+    def output_frequency(self, value: int):
+        self.set_property_state("output_frequency", value)

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

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

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

@@ -0,0 +1,64 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .dimensionality import dimensionality
+
+
+class parameter_child(Container):
+    """
+    Configure a parameter for the coupling participant.
+    """
+
+    syc_name = "child_object_type"
+
+    child_names = ["dimensionality"]
+
+    dimensionality: dimensionality = dimensionality
+    """
+    dimensionality child of parameter_child.
+    """
+    property_names_types = [
+        ("participant_display_name", "ParticipantDisplayName", "str"),
+        ("display_name", "DisplayName", "str"),
+        ("data_type", "DataType", "str"),
+        ("tensor_type", "TensorType", "str"),
+    ]
+
+    @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 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 tensor_type(self) -> str:
+        """Indicates the parameter tensor type (\"Scalar\" only)."""
+        return self.get_property_state("tensor_type")
+
+    @tensor_type.setter
+    def tensor_type(self, value: str):
+        self.set_property_state("tensor_type", value)

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

@@ -0,0 +1,138 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class partition_participants(Command):
+    """
+    Provide a utility for setting the parallel algorithm, parallel partitioning
+    fractions for each participant, and machine list information.
+
+    At least one participant must be defined for this command to be used. Use
+    of this command is not recommended if participants are already running.
+
+    Parameters
+    ----------
+    algorithm_name : str, optional
+        Name of the partitioning algorithm. Available algorithms are:
+
+        - \"SharedAllocateMachines\" (default)
+        - \"SharedAllocateCores\"
+        - \"DistributedAllocateMachines\"
+        - \"DistributedAllocateCores\"
+        - \"Custom\" (see ``partitioning_info`` for more details)
+
+        The algorithms allow for both shared and distributed execution and for
+        the allocation of machines or cores. The default value is generally the
+        best choice, as it allows for each participant to take advantage of all
+        the allocated resources. The other partitioning methods are provided to
+        handle situations where not enough resources are available to run the
+        same machines.
+
+        See the System Coupling documentation for more details of the
+        partitioning algorithms.
+    names_and_fractions : typing.List[typing.Tuple[str, float]], optional
+        List of tuples specifying the fractions of core count applied for
+        each participant
+
+        Each tuple must have the participant name as its first item and the
+        associated fraction as its second item. If this parameter is omitted,
+        then cores will be allocated for all participants set in the
+        data model.
+    machine_list : typing.List[typing.Dict[str, typing.Union[str, int]]], optional
+        List of dictionaries specifying machines available for distributed run.
+        Each dictionary must have a key \"machine-name\" with machine name as its
+        value, and key \"core-count\" with number of cores for that machine as
+        its value. Providing this argument will override any machine list
+        information detected from the scheduler environment and any information
+        provided by the ``--cnf`` command-line argument.
+    partitioning_info : typing.Dict[str, typing.List[typing.Dict[str, typing.Union[str, int]]]], optional
+        Dictionary specifying machines resources assigned to each participant by user.
+        Dictionary must have participant names as keys and machine lists containing
+        machine resources as values. The value of a ``partitioning_info`` machine list is
+        a list of dictionaries specifying machines assigned to corresponding participants.
+        Each dictionary of the machine list must have a key \"machine-name\" with the
+        machine name as its value, and key \"core-count\" with number of cores for that
+        machine as its value.
+
+        Providing this argument will disallow other arguments except ``algorithm_name``,
+        which must set as \"Custom\" if provided. Otherwise, ``algorithm_name`` will be
+        set as \"Custom\" internally if ``partitioning_info`` is provided.
+
+    """
+
+    syc_name = "PartitionParticipants"
+
+    argument_names = [
+        "algorithm_name",
+        "names_and_fractions",
+        "machine_list",
+        "partitioning_info",
+    ]
+
+    class algorithm_name(String):
+        """
+        Name of the partitioning algorithm. Available algorithms are:
+
+        - \"SharedAllocateMachines\" (default)
+        - \"SharedAllocateCores\"
+        - \"DistributedAllocateMachines\"
+        - \"DistributedAllocateCores\"
+        - \"Custom\" (see ``partitioning_info`` for more details)
+
+        The algorithms allow for both shared and distributed execution and for
+        the allocation of machines or cores. The default value is generally the
+        best choice, as it allows for each participant to take advantage of all
+        the allocated resources. The other partitioning methods are provided to
+        handle situations where not enough resources are available to run the
+        same machines.
+
+        See the System Coupling documentation for more details of the
+        partitioning algorithms.
+        """
+
+        syc_name = "AlgorithmName"
+
+    class names_and_fractions(StrFloatPairList):
+        """
+        List of tuples specifying the fractions of core count applied for
+        each participant
+
+        Each tuple must have the participant name as its first item and the
+        associated fraction as its second item. If this parameter is omitted,
+        then cores will be allocated for all participants set in the
+        data model.
+        """
+
+        syc_name = "NamesAndFractions"
+
+    class machine_list(StrOrIntDictList):
+        """
+        List of dictionaries specifying machines available for distributed run.
+        Each dictionary must have a key \"machine-name\" with machine name as its
+        value, and key \"core-count\" with number of cores for that machine as
+        its value. Providing this argument will override any machine list
+        information detected from the scheduler environment and any information
+        provided by the ``--cnf`` command-line argument.
+        """
+
+        syc_name = "MachineList"
+
+    class partitioning_info(StrOrIntDictListDict):
+        """
+        Dictionary specifying machines resources assigned to each participant by user.
+        Dictionary must have participant names as keys and machine lists containing
+        machine resources as values. The value of a ``partitioning_info`` machine list is
+        a list of dictionaries specifying machines assigned to corresponding participants.
+        Each dictionary of the machine list must have a key \"machine-name\" with the
+        machine name as its value, and key \"core-count\" with number of cores for that
+        machine as its value.
+
+        Providing this argument will disallow other arguments except ``algorithm_name``,
+        which must set as \"Custom\" if provided. Otherwise, ``algorithm_name`` will be
+        set as \"Custom\" internally if ``partitioning_info`` is provided.
+        """
+
+        syc_name = "PartitioningInfo"

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

@@ -0,0 +1,20 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .reference_frame_child import reference_frame_child
+
+
+class reference_frame(NamedContainer[reference_frame_child]):
+    """
+    Provide a transformation relative to a ParentReferenceFrame.
+    """
+
+    syc_name = "ReferenceFrame"
+
+    child_object_type: reference_frame_child = reference_frame_child
+    """
+    child_object_type of reference_frame.
+    """

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

@@ -0,0 +1,71 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .transformation import transformation
+
+
+class reference_frame_child(Container):
+    """
+    Provide a transformation relative to a ParentReferenceFrame.
+    """
+
+    syc_name = "child_object_type"
+
+    child_names = ["transformation"]
+
+    transformation: transformation = transformation
+    """
+    transformation child of reference_frame_child.
+    """
+    property_names_types = [
+        ("option", "Option", "str"),
+        ("parent_reference_frame", "ParentReferenceFrame", "str"),
+        ("transformation_order", "TransformationOrder", "StringListType"),
+        ("transformation_matrix", "TransformationMatrix", "RealListType"),
+    ]
+
+    @property
+    def option(self) -> str:
+        """Method used to define the transformation from the parent reference frame.
+
+        - \"ByTransformation\" - Define the reference frame by one or more
+          transformation operations.
+        - \"Automatic\" - Align source and target automatically.
+        - \"ByMatrix\" - Only available if Alpha features are activated."""
+        return self.get_property_state("option")
+
+    @option.setter
+    def option(self, value: str):
+        self.set_property_state("option", value)
+
+    @property
+    def parent_reference_frame(self) -> str:
+        """Set the parent reference frame."""
+        return self.get_property_state("parent_reference_frame")
+
+    @parent_reference_frame.setter
+    def parent_reference_frame(self, value: str):
+        self.set_property_state("parent_reference_frame", value)
+
+    @property
+    def transformation_order(self) -> StringListType:
+        """List names of transformations in the order in which they apply.
+
+        Available for the ``ByTransformation`` option."""
+        return self.get_property_state("transformation_order")
+
+    @transformation_order.setter
+    def transformation_order(self, value: StringListType):
+        self.set_property_state("transformation_order", value)
+
+    @property
+    def transformation_matrix(self) -> RealListType:
+        """Define the transformation matrix when ``ByTransformation`` option is active."""
+        return self.get_property_state("transformation_matrix")
+
+    @transformation_matrix.setter
+    def transformation_matrix(self, value: RealListType):
+        self.set_property_state("transformation_matrix", value)

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

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

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

@@ -0,0 +1,72 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class region_child(Container):
+    """
+    Configure a region for the coupling participant.
+    """
+
+    syc_name = "child_object_type"
+
+    property_names_types = [
+        ("topology", "Topology", "str"),
+        ("input_variables", "InputVariables", "StringListType"),
+        ("output_variables", "OutputVariables", "StringListType"),
+        ("display_name", "DisplayName", "str"),
+        ("region_discretization_type", "RegionDiscretizationType", "str"),
+    ]
+
+    @property
+    def topology(self) -> str:
+        """Region topology type.
+
+        Allowed values:
+
+        - \"Undefined\" (FMU participants only)
+        - \"Surface\"
+        - \"Volume\" (3D participants only)"""
+        return self.get_property_state("topology")
+
+    @topology.setter
+    def topology(self, value: str):
+        self.set_property_state("topology", 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 display_name(self) -> str:
+        """Display name of the region."""
+        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 region_discretization_type(self) -> str:
+        """Region discretization type (\"Mesh Region\" or \"Point Cloud Region\")."""
+        return self.get_property_state("region_discretization_type")
+
+    @region_discretization_type.setter
+    def region_discretization_type(self, value: str):
+        self.set_property_state("region_discretization_type", value)

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

@@ -0,0 +1,14 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class reload_expression_function_modules(Command):
+    """
+    This may be called to force a reload of expression function modules
+    if they have changed since they were last loaded.
+    """
+
+    syc_name = "ReloadExpressionFunctionModules"