ansys-systemcoupling-core 0.4.1__py3-none-any.whl → 0.5.0__py3-none-any.whl

ansys/systemcoupling/core/adaptor/api_24_2/get_transformation.py

@@ -0,0 +1,43 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class get_transformation(Command):
+    """
+    Given an interface and side, returns the resultant transformation, in
+    the form of a Python dictionary and formatted as a DataModel
+    reference_frame object. If multiple transformations are applied to the
+    interface side, the composite transformation is returned.
+
+    This command can only be invoked after the analysis
+    is initialized.
+
+    Parameters
+    ----------
+    interface_name : str
+        Name of the interface
+    side : str
+        Interface side. Can be "One" or "Two".
+
+    """
+
+    syc_name = "GetTransformation"
+
+    argument_names = ["interface_name", "side"]
+
+    class interface_name(String):
+        """
+        Name of the interface
+        """
+
+        syc_name = "InterfaceName"
+
+    class side(String):
+        """
+        Interface side. Can be "One" or "Two".
+        """
+
+        syc_name = "Side"

ansys/systemcoupling/core/adaptor/api_24_2/global_stabilization.py

@@ -0,0 +1,143 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class global_stabilization(Container):
+    """
+    Global stabilization settings.
+    """
+
+    syc_name = "GlobalStabilization"
+
+    property_names_types = [
+        ("option", "Option", "str"),
+        ("initial_iterations", "InitialIterations", "int"),
+        ("initial_relaxation_factor", "InitialRelaxationFactor", "RealType"),
+        ("maximum_retained_time_steps", "MaximumRetainedTimeSteps", "int"),
+        ("maximum_retained_iterations", "MaximumRetainedIterations", "int"),
+        ("diagnostics_level", "DiagnosticsLevel", "int"),
+        ("weight_option", "WeightOption", "str"),
+        ("qr_tol_this_step", "QRTolThisStep", "RealType"),
+        ("qr_tol_old_steps", "QRTolOldSteps", "RealType"),
+        ("qr_solver", "QRSolver", "str"),
+    ]
+
+    @property
+    def option(self) -> str:
+        """Stabilization type.
+
+        Allowed values:
+
+        - \"None\"
+        - \"Quasi-Newton\" """
+        return self.get_property_state("option")
+
+    @option.setter
+    def option(self, value: str):
+        self.set_property_state("option", 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 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 qr_solver(self) -> str:
+        """QR solver options.
+
+        Allowed values:
+
+        - \"QR_MGS\"
+        - \"QR_augmentedMGS\" (default)
+        - \"QR_pivot\" """
+        return self.get_property_state("qr_solver")
+
+    @qr_solver.setter
+    def qr_solver(self, value: str):
+        self.set_property_state("qr_solver", value)

ansys/systemcoupling/core/adaptor/api_24_2/has_input_file_changed.py

@@ -0,0 +1,36 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class has_input_file_changed(Command):
+    """
+    Given the name of a participant, checks whether the input file has changed.
+
+    Available for server participants. Currently, only input files for
+    DEFAULT-SRV, CFD-SRV, MECH-SRV, and SCDT-SRV participants are tracked by
+    System Coupling.
+
+    If a participant's input files are not tracked by System Coupling, this
+    command will return False in all cases, even if changes have been made
+    to the participant input file.
+
+    Parameters
+    ----------
+    participant_name : str
+        Name of the participant
+
+    """
+
+    syc_name = "HasInputFileChanged"
+
+    argument_names = ["participant_name"]
+
+    class participant_name(String):
+        """
+        Name of the participant
+        """
+
+        syc_name = "ParticipantName"

ansys/systemcoupling/core/adaptor/api_24_2/import_system_coupling_input_file.py

@@ -0,0 +1,36 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class import_system_coupling_input_file(Command):
+    """
+    Reads the specified System Coupling SCI file and pushes its information
+    into the data model. The SCI file is the required System Coupling input
+    format for the initial run of a coupled analysis set up in Workbench.
+
+    After the initial run based on an imported SCI file, a reissue
+    of the ``import_system_coupling_input_file`` command is unnecessary and is
+    not recommended unless the setup has changed.
+
+    Cannot be run after participants have been started.
+
+    Parameters
+    ----------
+    file_path : str
+        Path and file name for the SCI file to be read.
+
+    """
+
+    syc_name = "ImportSystemCouplingInputFile"
+
+    argument_names = ["file_path"]
+
+    class file_path(String):
+        """
+        Path and file name for the SCI file to be read.
+        """
+
+        syc_name = "FilePath"

ansys/systemcoupling/core/adaptor/api_24_2/initialize.py

@@ -0,0 +1,27 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class initialize(Command):
+    """
+    Interactive command that initializes a coupled analysis.
+
+    Initialization includes preparing System Coupling, making connections
+    between System Coupling and all participants, starting participants (if
+    necessary), and writing participant build information to the Transcript
+    and Log.
+
+    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 = "Initialize"

ansys/systemcoupling/core/adaptor/api_24_2/instancing.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .instancing_child import instancing_child
+
+
+class instancing(NamedContainer[instancing_child]):
+    """
+    Define instancing for an interface side.
+
+    Available when cylindrical geometry instancing has been added to
+    the data model.
+    """
+
+    syc_name = "Instancing"
+
+    child_object_type: instancing_child = instancing_child
+    """
+    child_object_type of instancing.
+    """

ansys/systemcoupling/core/adaptor/api_24_2/instancing_child.py

@@ -0,0 +1,62 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class instancing_child(Container):
+    """
+    Define instancing for an interface side.
+
+    Available when cylindrical geometry instancing has been added to
+    the data model.
+    """
+
+    syc_name = "child_object_type"
+
+    property_names_types = [
+        ("reference_frame", "ReferenceFrame", "str"),
+        ("instances_in_full_circle", "InstancesInFullCircle", "int"),
+        ("instances_for_mapping", "InstancesForMapping", "int"),
+    ]
+
+    @property
+    def reference_frame(self) -> str:
+        """Reference frame that defines the orientation of the instancing.
+
+        Rotation will be around the z-axis of the reference frame,
+        following the right-hand rule."""
+        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 instances_in_full_circle(self) -> int:
+        """Total number of instances (including the first instance) in
+        a full 360 degree rotation of the participant mesh. This value
+        includes the reference instance (with the participant mesh).
+        All instances defined for the instancing object have identical
+        angles."""
+        return self.get_property_state("instances_in_full_circle")
+
+    @instances_in_full_circle.setter
+    def instances_in_full_circle(self, value: int):
+        self.set_property_state("instances_in_full_circle", value)
+
+    @property
+    def instances_for_mapping(self) -> int:
+        """Number of instances to be included in the mapping when instancing
+        is applied.
+
+        Required when the number of instances to be used for mapping does
+        not match the number of instances in a full circle. Default
+        assumes a 360 degree rotation of the participant mesh. This value
+        includes the reference instance (with the participant mesh)."""
+        return self.get_property_state("instances_for_mapping")
+
+    @instances_for_mapping.setter
+    def instances_for_mapping(self, value: int):
+        self.set_property_state("instances_for_mapping", value)

ansys/systemcoupling/core/adaptor/api_24_2/interrupt.py

@@ -0,0 +1,39 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class interrupt(InjectedCommand):
+    """
+    Interrupts a solve in progress.
+
+    See also ``abort``. The difference between an interrupted and
+    aborted solve is that an interrupted solve can be resumed.
+
+    Parameters
+    ----------
+    reason_msg : str, optional
+        Text to describe the reason for the interrupt.
+
+        This might be used for such purposes as providing
+        additional annotation in transcript output.
+
+    """
+
+    syc_name = "interrupt"
+
+    cmd_name = "interrupt"
+
+    argument_names = ["reason_msg"]
+
+    class reason_msg(String):
+        """
+        Text to describe the reason for the interrupt.
+
+        This might be used for such purposes as providing
+        additional annotation in transcript output.
+        """
+
+        syc_name = "reason_msg"

ansys/systemcoupling/core/adaptor/api_24_2/library.py

@@ -0,0 +1,37 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .expression import expression
+from .expression_function import expression_function
+from .instancing import instancing
+from .reference_frame import reference_frame
+
+
+class library(Container):
+    """
+    Contains objects that can be referenced from elsewhere in the data model.
+    """
+
+    syc_name = "Library"
+
+    child_names = ["expression", "expression_function", "reference_frame", "instancing"]
+
+    expression: expression = expression
+    """
+    expression child of library.
+    """
+    expression_function: expression_function = expression_function
+    """
+    expression_function child of library.
+    """
+    reference_frame: reference_frame = reference_frame
+    """
+    reference_frame child of library.
+    """
+    instancing: instancing = instancing
+    """
+    instancing child of library.
+    """

ansys/systemcoupling/core/adaptor/api_24_2/live_visualization.py

@@ -0,0 +1,20 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .live_visualization_child import live_visualization_child
+
+
+class live_visualization(NamedContainer[live_visualization_child]):
+    """
+    Configures live visualization via EnSight DVS.
+    """
+
+    syc_name = "LiveVisualization"
+
+    child_object_type: live_visualization_child = live_visualization_child
+    """
+    child_object_type of live_visualization.
+    """

ansys/systemcoupling/core/adaptor/api_24_2/live_visualization_child.py

@@ -0,0 +1,100 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .execution_control_1 import execution_control
+
+
+class live_visualization_child(Container):
+    """
+    Configures live visualization via EnSight DVS.
+    """
+
+    syc_name = "child_object_type"
+
+    child_names = ["execution_control"]
+
+    execution_control: execution_control = execution_control
+    """
+    execution_control child of live_visualization_child.
+    """
+    property_names_types = [
+        ("option", "Option", "str"),
+        ("write_results", "WriteResults", "bool"),
+        ("start_grpc_server", "StartGrpcServer", "bool"),
+        ("hide_ensight_gui", "HideEnsightGUI", "bool"),
+        ("output_frequency", "OutputFrequency", "int"),
+    ]
+
+    @property
+    def option(self) -> str:
+        """Specifies live visualization working process
+
+        Allowed values:
+
+        - \"ProgramControlled\" - Generation of postprocessing results is disabled for now.
+
+        -  \"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 write_results(self) -> bool:
+        """Write results to files when conducting live visualization."""
+        return self.get_property_state("write_results")
+
+    @write_results.setter
+    def write_results(self, value: bool):
+        self.set_property_state("write_results", value)
+
+    @property
+    def start_grpc_server(self) -> bool:
+        """Request that the EnSight client is started with a gRPC server running."""
+        return self.get_property_state("start_grpc_server")
+
+    @start_grpc_server.setter
+    def start_grpc_server(self, value: bool):
+        self.set_property_state("start_grpc_server", value)
+
+    @property
+    def hide_ensight_gui(self) -> bool:
+        """Request that the EnSight client is started hidden (in batch mode)."""
+        return self.get_property_state("hide_ensight_gui")
+
+    @hide_ensight_gui.setter
+    def hide_ensight_gui(self, value: bool):
+        self.set_property_state("hide_ensight_gui", 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)