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

ansys/systemcoupling/core/adaptor/api_25_1/show_plot.py

@@ -0,0 +1,75 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class show_plot(InjectedCommand):
+    """
+    Shows plots of transfer values and convergence for data transfers
+    of a coupling interface.
+
+    Parameters
+    ----------
+    interface_name : str
+        Specification of which interface to plot.
+    transfer_names : List, optional
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+    working_dir : str, optional
+        Working directory (defaults = ".").
+    show_convergence : bool, optional
+        Whether to show convergence plots (defaults to ``True``).
+    show_transfer_values : bool, optional
+        Whether to show transfer value plots (defaults to ``True``).
+
+    """
+
+    syc_name = "show_plot"
+
+    cmd_name = "show_plot"
+
+    argument_names = [
+        "interface_name",
+        "transfer_names",
+        "working_dir",
+        "show_convergence",
+        "show_transfer_values",
+    ]
+
+    class interface_name(String):
+        """
+        Specification of which interface to plot.
+        """
+
+        syc_name = "interface_name"
+
+    class transfer_names(StringList):
+        """
+        Specification of which data transfers to plot. Defaults
+        to ``None``, which means plot all data transfers.
+        """
+
+        syc_name = "transfer_names"
+
+    class working_dir(String):
+        """
+        Working directory (defaults = ".").
+        """
+
+        syc_name = "working_dir"
+
+    class show_convergence(Boolean):
+        """
+        Whether to show convergence plots (defaults to ``True``).
+        """
+
+        syc_name = "show_convergence"
+
+    class show_transfer_values(Boolean):
+        """
+        Whether to show transfer value plots (defaults to ``True``).
+        """
+
+        syc_name = "show_transfer_values"

ansys/systemcoupling/core/adaptor/api_25_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_25_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_25_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_25_1/solution_control.py

@@ -0,0 +1,115 @@
+#
+# 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"),
+        ("use_local_host_when_possible", "UseLocalHostWhenPossible", "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)
+
+    @property
+    def use_local_host_when_possible(self) -> bool:
+        """If True, prefer to use local host address rather than network address for
+        participant server connections. There is no guarantee that this request
+        can be satisfied for all participants."""
+        return self.get_property_state("use_local_host_when_possible")
+
+    @use_local_host_when_possible.setter
+    def use_local_host_when_possible(self, value: bool):
+        self.set_property_state("use_local_host_when_possible", value)

ansys/systemcoupling/core/adaptor/api_25_1/solution_root.py

@@ -0,0 +1,122 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+SHASH = "0987c9ed416b22e5d86458a81cba5c65a60eb6e6a32fb2f856bf7464f995ed36"
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from ._solve import _solve
+from .abort import abort
+from .connect_ensight_dvs import connect_ensight_dvs
+from .create_restart_point import create_restart_point
+from .get_machines import get_machines
+from .get_transformation import get_transformation
+from .initialize import initialize
+from .interrupt import interrupt
+from .open_results_in_ensight import open_results_in_ensight
+from .partition_participants import partition_participants
+from .show_plot import show_plot
+from .shutdown import shutdown
+from .solve import solve
+from .start_participants import start_participants
+from .step import step
+from .write_csv_chart_files import write_csv_chart_files
+from .write_ensight import write_ensight
+
+
+class solution_root(Container):
+    """
+    'root' object
+    """
+
+    syc_name = "SolutionCommands"
+
+    command_names = [
+        "_solve",
+        "abort",
+        "connect_ensight_dvs",
+        "create_restart_point",
+        "get_machines",
+        "get_transformation",
+        "initialize",
+        "interrupt",
+        "open_results_in_ensight",
+        "partition_participants",
+        "show_plot",
+        "shutdown",
+        "solve",
+        "start_participants",
+        "step",
+        "write_csv_chart_files",
+        "write_ensight",
+    ]
+
+    _solve: _solve = _solve
+    """
+    _solve command of solution_root.
+    """
+    abort: abort = abort
+    """
+    abort command of solution_root.
+    """
+    connect_ensight_dvs: connect_ensight_dvs = connect_ensight_dvs
+    """
+    connect_ensight_dvs command of solution_root.
+    """
+    create_restart_point: create_restart_point = create_restart_point
+    """
+    create_restart_point command of solution_root.
+    """
+    get_machines: get_machines = get_machines
+    """
+    get_machines command of solution_root.
+    """
+    get_transformation: get_transformation = get_transformation
+    """
+    get_transformation command of solution_root.
+    """
+    initialize: initialize = initialize
+    """
+    initialize command of solution_root.
+    """
+    interrupt: interrupt = interrupt
+    """
+    interrupt command of solution_root.
+    """
+    open_results_in_ensight: open_results_in_ensight = open_results_in_ensight
+    """
+    open_results_in_ensight command of solution_root.
+    """
+    partition_participants: partition_participants = partition_participants
+    """
+    partition_participants command of solution_root.
+    """
+    show_plot: show_plot = show_plot
+    """
+    show_plot command of solution_root.
+    """
+    shutdown: shutdown = shutdown
+    """
+    shutdown command of solution_root.
+    """
+    solve: solve = solve
+    """
+    solve command of solution_root.
+    """
+    start_participants: start_participants = start_participants
+    """
+    start_participants command of solution_root.
+    """
+    step: step = step
+    """
+    step command of solution_root.
+    """
+    write_csv_chart_files: write_csv_chart_files = write_csv_chart_files
+    """
+    write_csv_chart_files command of solution_root.
+    """
+    write_ensight: write_ensight = write_ensight
+    """
+    write_ensight command of solution_root.
+    """

ansys/systemcoupling/core/adaptor/api_25_1/solve.py

@@ -0,0 +1,30 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class solve(InjectedCommand):
+    """
+    Starts the participants (if necessary) and solves the coupled analysis. By
+    default, the solution runs straight through without pause unless stopped by
+    an scStop file.
+
+    Disabled when a solution is already in progress.
+
+    For restarts, the ``open`` command must be run before the ``solve`` command.
+
+    Note that if the ``execution_control`` option for a participant is set to
+    \"ExternallyManaged\", then System Coupling will not start the participant
+    using either this command or any of the other commands that automatically
+    start participants. The user is expected to manually start the participant.
+    This function will not return until all participants have been connected.
+
+    Note that this command will raise an exception if another instance of
+    System Coupling is solving in the current working directory.
+    """
+
+    syc_name = "solve"
+
+    cmd_name = "solve"

ansys/systemcoupling/core/adaptor/api_25_1/stabilization.py

@@ -0,0 +1,157 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class stabilization(Container):
+    """
+    Stabilization and Acceleration method.
+    """
+
+    syc_name = "Stabilization"
+
+    property_names_types = [
+        ("option", "Option", "str"),
+        ("couple_with_global_stabilization", "CoupleWithGlobalStabilization", "bool"),
+        ("initial_iterations", "InitialIterations", "int"),
+        ("initial_relaxation_factor", "InitialRelaxationFactor", "RealType"),
+        ("maximum_retained_time_steps", "MaximumRetainedTimeSteps", "int"),
+        ("maximum_retained_iterations", "MaximumRetainedIterations", "int"),
+        ("weight_factor", "WeightFactor", "RealType"),
+        ("diagnostics_level", "DiagnosticsLevel", "int"),
+        ("weight_option", "WeightOption", "str"),
+        ("qr_tol_this_step", "QRTolThisStep", "RealType"),
+        ("qr_tol_old_steps", "QRTolOldSteps", "RealType"),
+        ("time_step_initialization_option", "TimeStepInitializationOption", "str"),
+    ]
+
+    @property
+    def option(self) -> str:
+        """Allowed values:
+
+        - \"ProgramControlled\"
+        - \"None\"
+        - \"Quasi-Newton\"
+        - \"Aitken\" (Alpha only)"""
+        return self.get_property_state("option")
+
+    @option.setter
+    def option(self, value: str):
+        self.set_property_state("option", value)
+
+    @property
+    def couple_with_global_stabilization(self) -> bool:
+        """Controls whether the stabilization for this data transfer is coupled with the global stabilization."""
+        return self.get_property_state("couple_with_global_stabilization")
+
+    @couple_with_global_stabilization.setter
+    def couple_with_global_stabilization(self, value: bool):
+        self.set_property_state("couple_with_global_stabilization", 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 weight_factor(self) -> RealType:
+        """Weighting factor to use for this data transfer in IQN-ILS."""
+        return self.get_property_state("weight_factor")
+
+    @weight_factor.setter
+    def weight_factor(self, value: RealType):
+        self.set_property_state("weight_factor", 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 time_step_initialization_option(self) -> str:
+        """Controls how Aitken relaxation factor is initialized at start of new timestep."""
+        return self.get_property_state("time_step_initialization_option")
+
+    @time_step_initialization_option.setter
+    def time_step_initialization_option(self, value: str):
+        self.set_property_state("time_step_initialization_option", value)

ansys/systemcoupling/core/adaptor/api_25_1/start_participants.py

@@ -0,0 +1,47 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class start_participants(Command):
+    """
+    Important: This command is deprecated. Consider adopting workflows
+    where participants are started by another method, such as the ``initialize``,
+    ``step``, or ``solve`` commands.
+
+    Interactive command that reads the participants' System Coupling
+    Participant setup files (SCP) and starts participants on separate
+    sub-processes. By default, automatically starts all participants and blocks
+    solution progress until all participants are connected.
+
+    If omitted and the ``solve``, ``initialize``, or ``step`` command is issued, then
+    participants are started automatically during the execution of the command.
+
+    Note that if the ``execution_control`` option for a participant is set to
+    ExternallyManaged, then System Coupling will not start the participant
+    using either this command or any of the other commands that automatically
+    start participants. The user is expected to manually start the participant.
+    This function will not return until all participants have been connected.
+
+    Note that this command will raise an exception if another instance of
+    System Coupling is solving in the current working directory.
+
+    Parameters
+    ----------
+    participant_names : List, optional
+        This argument has been deprecated and will be removed in future releases.
+
+    """
+
+    syc_name = "StartParticipants"
+
+    argument_names = ["participant_names"]
+
+    class participant_names(StringList):
+        """
+        This argument has been deprecated and will be removed in future releases.
+        """
+
+        syc_name = "ParticipantNames"