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

ansys/systemcoupling/core/adaptor/api_23_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_23_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_23_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_23_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."""
+        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."""
+        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_23_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"

ansys/systemcoupling/core/adaptor/api_23_1/results.py

@@ -0,0 +1,89 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .type import type
+
+
+class results(Container):
+    """
+    Configures output of postprocessing results data.
+    """
+
+    syc_name = "Results"
+
+    child_names = ["type"]
+
+    type: type = type
+    """
+    type child of results.
+    """
+    property_names_types = [
+        ("option", "Option", "str"),
+        ("include_instances", "IncludeInstances", "str"),
+        ("output_frequency", "OutputFrequency", "int"),
+    ]
+
+    @property
+    def option(self) -> str:
+        """Specifies whether and when results files are generated.
+
+        Allowed values:
+
+        - \"ProgramControlled\" - Generate postprocessing results at the same
+          frequency as restart points, as defined by the output control option
+          setting. If no restart frequency is defined, then results are
+          generated at the end of the last coupling step.
+
+        -  \"Off\" - Generation of postprocessing results is disabled.
+
+        Allowed values for step-based analyses:
+
+        - \"LastStep\" - Generate results only for the last coupling step completed.
+
+        - \"EveryStep\" - Generate results at the end of every coupling step.
+
+        - \"StepInterval\" - Generate results at the end of coupling steps at
+          the interval specified by the output frequency setting.
+
+        Allowed values for iteration-based analyses:
+
+        - \"LastIteration\" - Generate results only for the last coupling
+          iteration completed.
+
+        - \"EveryIteration\" - Generate results at the end of every coupling
+          iteration.
+
+        - \"IterationInterval\" - Generate results 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 include_instances(self) -> str:
+        """Control whether instances are output.
+
+        Allowed values:
+
+        - \"ProgramControlled\"
+        - \"ReferenceOnly\"
+        - \"All\" """
+        return self.get_property_state("include_instances")
+
+    @include_instances.setter
+    def include_instances(self, value: str):
+        self.set_property_state("include_instances", 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_23_1/save.py

@@ -0,0 +1,51 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class save(Command):
+    """
+    Saves the state of the coupled analysis data model.
+
+    -  Analysis settings are written to a single Settings.h5 file which
+       can be used to reload analysis settings.
+
+    -  Restart files for all restart points in the current co-simulation will
+       be written when this command is called. Existing restart files from
+       previous System Coupling versions will be renamed to conform to the new
+       naming scheme.
+
+    -  Restart files are named according to the convention
+       ``Restart_step#.h5`` or ``Restart_iter#.h5``, where ``#`` is the index of
+       the corresponding coupling step or iteration.
+
+    Returns a Boolean value of ``True`` if the files were saved successfully;
+    otherwise, returns a value of ``False``.
+
+    Note that this command will raise an exception if another instance of
+    System Coupling is solving in the current working directory.
+
+    By default, writes to the ``SyC`` sub-directory of the current working
+    directory. This behavior may be modified by providing ``file_path``.
+
+    Parameters
+    ----------
+    file_path : str, optional
+        Writeable directory to which the SyC directory is added. (Settings and
+        results .h5 files will be written to the SyC directory.)
+
+    """
+
+    syc_name = "Save"
+
+    argument_names = ["file_path"]
+
+    class file_path(String):
+        """
+        Writeable directory to which the SyC directory is added. (Settings and
+        results .h5 files will be written to the SyC directory.)
+        """
+
+        syc_name = "FilePath"

ansys/systemcoupling/core/adaptor/api_23_1/save_snapshot.py

@@ -0,0 +1,54 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class save_snapshot(Command):
+    """
+    Saves a snapshot of the current state of the simulation. Snapshot will
+    contain all files and directories within the working directory that are
+    tracked by System Coupling: the SyC directory and the working directories
+    of all loaded participants. Before saving the snapshot, the current
+    datamodel will be saved.
+
+    Note: Snapshot cannot be saved if participants have been started.
+
+    Note: If files required for cosimulation are not stored within the working
+    directory, then they will not be included in the snapshot.
+
+    Parameters
+    ----------
+    snapshot_name : str
+        Name of the snapshot to be saved.
+    overwrite_existing : bool, optional
+        Boolean argument controlling whether an existing snapshot should be
+        overwritten. If ``True``, then an existing snapshot named ``snapshot_name`` will
+        be overwritten if it exists. If ``False`` (default), then if ``snapshot_name`` is
+        shared with an existing snapshot, a warning will be written and the
+        command will return without saving the snapshot.
+
+    """
+
+    syc_name = "SaveSnapshot"
+
+    argument_names = ["snapshot_name", "overwrite_existing"]
+
+    class snapshot_name(String):
+        """
+        Name of the snapshot to be saved.
+        """
+
+        syc_name = "SnapshotName"
+
+    class overwrite_existing(Boolean):
+        """
+        Boolean argument controlling whether an existing snapshot should be
+        overwritten. If ``True``, then an existing snapshot named ``snapshot_name`` will
+        be overwritten if it exists. If ``False`` (default), then if ``snapshot_name`` is
+        shared with an existing snapshot, a warning will be written and the
+        command will return without saving the snapshot.
+        """
+
+        syc_name = "OverwriteExisting"

ansys/systemcoupling/core/adaptor/api_23_1/setup_root.py

@@ -0,0 +1,195 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+SHASH = "faa921cc93dcfd82765876c7d8016504355fe48b9a4639cf4cef834646f944c7"
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from ._add_participant import _add_participant
+from .activate_hidden import activate_hidden
+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_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_participant import add_participant
+from .add_reference_frame import add_reference_frame
+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_execution_command import get_execution_command
+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 .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
+from .output_control import output_control
+from .reload_expression_function_modules import reload_expression_function_modules
+from .solution_control import solution_control
+from .update_participant import update_participant
+
+
+class setup_root(Container):
+    """
+    'root' object
+    """
+
+    syc_name = "SystemCoupling"
+
+    child_names = [
+        "activate_hidden",
+        "library",
+        "coupling_participant",
+        "analysis_control",
+        "coupling_interface",
+        "solution_control",
+        "output_control",
+    ]
+
+    activate_hidden: activate_hidden = activate_hidden
+    """
+    activate_hidden child of setup_root.
+    """
+    library: library = library
+    """
+    library child of setup_root.
+    """
+    coupling_participant: coupling_participant = coupling_participant
+    """
+    coupling_participant child of setup_root.
+    """
+    analysis_control: analysis_control = analysis_control
+    """
+    analysis_control child of setup_root.
+    """
+    coupling_interface: coupling_interface = coupling_interface
+    """
+    coupling_interface child of setup_root.
+    """
+    solution_control: solution_control = solution_control
+    """
+    solution_control child of setup_root.
+    """
+    output_control: output_control = output_control
+    """
+    output_control child of setup_root.
+    """
+    command_names = [
+        "_add_participant",
+        "add_data_transfer",
+        "add_data_transfer_by_display_names",
+        "add_expression_function",
+        "add_interface",
+        "add_interface_by_display_names",
+        "add_named_expression",
+        "add_participant",
+        "add_reference_frame",
+        "add_transformation",
+        "delete_transformation",
+        "generate_input_file",
+        "get_execution_command",
+        "get_region_names_for_participant",
+        "get_setup_summary",
+        "get_status_messages",
+        "has_input_file_changed",
+        "import_system_coupling_input_file",
+        "reload_expression_function_modules",
+        "update_participant",
+    ]
+
+    _add_participant: _add_participant = _add_participant
+    """
+    _add_participant command of setup_root.
+    """
+    add_data_transfer: add_data_transfer = add_data_transfer
+    """
+    add_data_transfer command of setup_root.
+    """
+    add_data_transfer_by_display_names: add_data_transfer_by_display_names = (
+        add_data_transfer_by_display_names
+    )
+    """
+    add_data_transfer_by_display_names command of setup_root.
+    """
+    add_expression_function: add_expression_function = add_expression_function
+    """
+    add_expression_function command of setup_root.
+    """
+    add_interface: add_interface = add_interface
+    """
+    add_interface command of setup_root.
+    """
+    add_interface_by_display_names: add_interface_by_display_names = (
+        add_interface_by_display_names
+    )
+    """
+    add_interface_by_display_names command of setup_root.
+    """
+    add_named_expression: add_named_expression = add_named_expression
+    """
+    add_named_expression command of setup_root.
+    """
+    add_participant: add_participant = add_participant
+    """
+    add_participant command of setup_root.
+    """
+    add_reference_frame: add_reference_frame = add_reference_frame
+    """
+    add_reference_frame command of setup_root.
+    """
+    add_transformation: add_transformation = add_transformation
+    """
+    add_transformation command of setup_root.
+    """
+    delete_transformation: delete_transformation = delete_transformation
+    """
+    delete_transformation command of setup_root.
+    """
+    generate_input_file: generate_input_file = generate_input_file
+    """
+    generate_input_file command of setup_root.
+    """
+    get_execution_command: get_execution_command = get_execution_command
+    """
+    get_execution_command command of setup_root.
+    """
+    get_region_names_for_participant: get_region_names_for_participant = (
+        get_region_names_for_participant
+    )
+    """
+    get_region_names_for_participant command of setup_root.
+    """
+    get_setup_summary: get_setup_summary = get_setup_summary
+    """
+    get_setup_summary command of setup_root.
+    """
+    get_status_messages: get_status_messages = get_status_messages
+    """
+    get_status_messages command of setup_root.
+    """
+    has_input_file_changed: has_input_file_changed = has_input_file_changed
+    """
+    has_input_file_changed command of setup_root.
+    """
+    import_system_coupling_input_file: import_system_coupling_input_file = (
+        import_system_coupling_input_file
+    )
+    """
+    import_system_coupling_input_file command of setup_root.
+    """
+    reload_expression_function_modules: reload_expression_function_modules = (
+        reload_expression_function_modules
+    )
+    """
+    reload_expression_function_modules command of setup_root.
+    """
+    update_participant: update_participant = update_participant
+    """
+    update_participant command of setup_root.
+    """

ansys/systemcoupling/core/adaptor/api_23_1/shutdown.py

@@ -0,0 +1,25 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class shutdown(Command):
+    """
+    Interactive command that shuts down a coupled analysis.
+
+    ``shutdown`` includes ending the coupling run and signaling participants
+    to end the run. This produces a clean shutdown, generating the final
+    restart point and corresponding results file before disconnecting
+    from participants.
+
+    After participants are disconnected, the coupling service writes
+    timing details to the transcript. If participants were started
+    automatically, it ends participant processes.
+
+    When System Coupling disconnects from the analysis and shuts down, the GUI
+    Server file is removed from the working directory.
+    """
+
+    syc_name = "Shutdown"

ansys/systemcoupling/core/adaptor/api_23_1/side.py

@@ -0,0 +1,20 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .side_child import side_child
+
+
+class side(NamedContainer[side_child]):
+    """
+    Configure one side of a coupling interface.
+    """
+
+    syc_name = "Side"
+
+    child_object_type: side_child = side_child
+    """
+    child_object_type of side.
+    """