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

ansys/systemcoupling/core/adaptor/api_24_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_24_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_24_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_24_1/setup_root.py

@@ -0,0 +1,195 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+SHASH = "add18659c90558849a12bc4820dc48069961268d3b1790256ae8a6fe59db8067"
+
+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_24_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_24_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.
+    """

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

@@ -0,0 +1,56 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class side_child(Container):
+    """
+    Configure one side of a coupling interface.
+    """
+
+    syc_name = "child_object_type"
+
+    property_names_types = [
+        ("coupling_participant", "CouplingParticipant", "str"),
+        ("region_list", "RegionList", "StringListType"),
+        ("reference_frame", "ReferenceFrame", "str"),
+        ("instancing", "Instancing", "str"),
+    ]
+
+    @property
+    def coupling_participant(self) -> str:
+        """Name of the participant on this interface side."""
+        return self.get_property_state("coupling_participant")
+
+    @coupling_participant.setter
+    def coupling_participant(self, value: str):
+        self.set_property_state("coupling_participant", value)
+
+    @property
+    def region_list(self) -> StringListType:
+        """List of participant regions involved in this interface side."""
+        return self.get_property_state("region_list")
+
+    @region_list.setter
+    def region_list(self, value: StringListType):
+        self.set_property_state("region_list", value)
+
+    @property
+    def reference_frame(self) -> str:
+        """Reference frame of this side."""
+        return self.get_property_state("reference_frame")
+
+    @reference_frame.setter
+    def reference_frame(self, value: str):
+        self.set_property_state("reference_frame", value)
+
+    @property
+    def instancing(self) -> str:
+        """Instancing name for this side (leave unset if not required)."""
+        return self.get_property_state("instancing")
+
+    @instancing.setter
+    def instancing(self, value: str):
+        self.set_property_state("instancing", value)

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

@@ -0,0 +1,103 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .available_ports import available_ports
+
+
+class solution_control(Container):
+    """
+    Configure solution controls.
+    """
+
+    syc_name = "SolutionControl"
+
+    child_names = ["available_ports"]
+
+    available_ports: available_ports = available_ports
+    """
+    available_ports child of solution_control.
+    """
+    property_names_types = [
+        ("duration_option", "DurationOption", "str"),
+        ("end_time", "EndTime", "RealType"),
+        ("number_of_steps", "NumberOfSteps", "int"),
+        ("time_step_size", "TimeStepSize", "RealType"),
+        ("minimum_iterations", "MinimumIterations", "int"),
+        ("maximum_iterations", "MaximumIterations", "int"),
+        ("use_ip_address_when_possible", "UseIPAddressWhenPossible", "bool"),
+    ]
+
+    @property
+    def duration_option(self) -> str:
+        """Determine how the analysis duration is specified.
+
+        Allowed values:
+
+        - \"EndTime\" - Available for transient analyses. Execute coupling
+          steps until the analysis reaches the specified end time.
+        - \"NumberOfSteps\" - Perform coupling steps until the specified
+          number of steps is reached."""
+        return self.get_property_state("duration_option")
+
+    @duration_option.setter
+    def duration_option(self, value: str):
+        self.set_property_state("duration_option", value)
+
+    @property
+    def end_time(self) -> RealType:
+        """Set co-simulation end time."""
+        return self.get_property_state("end_time")
+
+    @end_time.setter
+    def end_time(self, value: RealType):
+        self.set_property_state("end_time", value)
+
+    @property
+    def number_of_steps(self) -> int:
+        """Set number of coupling steps."""
+        return self.get_property_state("number_of_steps")
+
+    @number_of_steps.setter
+    def number_of_steps(self, value: int):
+        self.set_property_state("number_of_steps", value)
+
+    @property
+    def time_step_size(self) -> RealType:
+        """Set coupling time step size."""
+        return self.get_property_state("time_step_size")
+
+    @time_step_size.setter
+    def time_step_size(self, value: RealType):
+        self.set_property_state("time_step_size", value)
+
+    @property
+    def minimum_iterations(self) -> int:
+        """Set minimum iterations within coupling step."""
+        return self.get_property_state("minimum_iterations")
+
+    @minimum_iterations.setter
+    def minimum_iterations(self, value: int):
+        self.set_property_state("minimum_iterations", value)
+
+    @property
+    def maximum_iterations(self) -> int:
+        """Set maximum iterations within coupling step."""
+        return self.get_property_state("maximum_iterations")
+
+    @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)