ansys-systemcoupling-core 0.9.0__py3-none-any.whl → 0.9.1__py3-none-any.whl

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

@@ -1,36 +0,0 @@
-#
-# 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_25_2/import_system_coupling_input_file.py

@@ -1,36 +0,0 @@
-#
-# 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_25_2/initialize.py

@@ -1,27 +0,0 @@
-#
-# 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_25_2/instancing.py

@@ -1,25 +0,0 @@
-#
-# 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.
-
-    ``RotationAxis`` controls how the axis of rotation is defined.
-    """
-
-    syc_name = "Instancing"
-
-    child_object_type: instancing_child = instancing_child
-    """
-    child_object_type of instancing.
-    """

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

@@ -1,114 +0,0 @@
-#
-# 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.
-
-    ``RotationAxis`` controls how the axis of rotation is defined.
-    """
-
-    syc_name = "child_object_type"
-
-    property_names_types = [
-        ("rotation_axis", "RotationAxis", "str"),
-        ("instances_in_full_circle", "InstancesInFullCircle", "int"),
-        ("instances_for_mapping", "InstancesForMapping", "int"),
-        ("reference_frame", "ReferenceFrame", "str"),
-        ("axis", "Axis", "str"),
-        ("axis_from", "AxisFrom", "RealVectorType"),
-        ("axis_to", "AxisTo", "RealVectorType"),
-        ("rotational_offset", "RotationalOffset", "RealType"),
-    ]
-
-    @property
-    def rotation_axis(self) -> str:
-        """UNDOCUMENTED"""
-        return self.get_property_state("rotation_axis")
-
-    @rotation_axis.setter
-    def rotation_axis(self, value: str):
-        self.set_property_state("rotation_axis", 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)
-
-    @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 axis(self) -> str:
-        """Principal axis of rotation for instancing"""
-        return self.get_property_state("axis")
-
-    @axis.setter
-    def axis(self, value: str):
-        self.set_property_state("axis", value)
-
-    @property
-    def axis_from(self) -> RealVectorType:
-        """Define the starting point of a user-defined axis."""
-        return self.get_property_state("axis_from")
-
-    @axis_from.setter
-    def axis_from(self, value: RealVectorType):
-        self.set_property_state("axis_from", value)
-
-    @property
-    def axis_to(self) -> RealVectorType:
-        """Define the end point of a user-defined axis."""
-        return self.get_property_state("axis_to")
-
-    @axis_to.setter
-    def axis_to(self, value: RealVectorType):
-        self.set_property_state("axis_to", value)
-
-    @property
-    def rotational_offset(self) -> RealType:
-        """Offset (in radians) about the rotation axis for the first instance"""
-        return self.get_property_state("rotational_offset")
-
-    @rotational_offset.setter
-    def rotational_offset(self, value: RealType):
-        self.set_property_state("rotational_offset", value)

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

@@ -1,39 +0,0 @@
-#
-# 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_25_2/library.py

@@ -1,37 +0,0 @@
-#
-# 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_25_2/live_visualization.py

@@ -1,20 +0,0 @@
-#
-# 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_25_2/live_visualization_child.py

@@ -1,100 +0,0 @@
-#
-# 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"),
-        ("show_viewer", "ShowViewer", "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 show_viewer(self) -> bool:
-        """Request that the EnSight client is started with a gRPC server running."""
-        return self.get_property_state("show_viewer")
-
-    @show_viewer.setter
-    def show_viewer(self, value: bool):
-        self.set_property_state("show_viewer", 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)

ansys/systemcoupling/core/adaptor/api_25_2/map.py

@@ -1,19 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-
-class map(Command):
-    """
-    Command to perform map operation.
-
-    When user friendly mapping workflow is enabled, this command will perform
-    the map operation between the interfaces as part of the user friendly mapping
-    workflow.
-    Otherwise, this operation would clears all existing state, except for datamodel,
-    before beginning the operation.
-    """
-
-    syc_name = "Map"