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

ansys/systemcoupling/core/adaptor/api_25_1/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_25_1/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_25_1/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_25_1/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_25_1/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_25_1/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_25_1/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_25_1/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_25_1/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"),
+        ("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_1/mapping_control.py

@@ -0,0 +1,239 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class mapping_control(Container):
+    """
+    Configure controls for mapping.
+    """
+
+    syc_name = "MappingControl"
+
+    property_names_types = [
+        ("stop_if_poor_intersection", "StopIfPoorIntersection", "bool"),
+        ("poor_intersection_threshold", "PoorIntersectionThreshold", "RealType"),
+        ("face_alignment", "FaceAlignment", "str"),
+        ("absolute_gap_tolerance", "AbsoluteGapTolerance", "RealType"),
+        ("relative_gap_tolerance", "RelativeGapTolerance", "RealType"),
+        ("small_weight_tolerance", "SmallWeightTolerance", "RealType"),
+        ("corner_tolerance", "CornerTolerance", "RealType"),
+        ("halo_tolerance", "HaloTolerance", "RealType"),
+        (
+            "conservative_reciprocity_factor",
+            "ConservativeReciprocityFactor",
+            "RealType",
+        ),
+        (
+            "profile_preserving_reciprocity_factor",
+            "ProfilePreservingReciprocityFactor",
+            "RealType",
+        ),
+        ("conservative_intensive", "ConservativeIntensive", "str"),
+        ("preserve_normal", "PreserveNormal", "str"),
+        (
+            "conservation_fix_tolerance_volume",
+            "ConservationFixToleranceVolume",
+            "RealType",
+        ),
+        ("rbf_option", "RBFOption", "str"),
+        ("rbf_shape_parameter", "RBFShapeParameter", "RealType"),
+        ("rbf_linear_correction", "RBFLinearCorrection", "bool"),
+        ("rbf_clipping_scale", "RBFClippingScale", "RealType"),
+        ("clipping", "Clipping", "bool"),
+    ]
+
+    @property
+    def stop_if_poor_intersection(self) -> bool:
+        """Controls whether to stop if the intersection is poor"""
+        return self.get_property_state("stop_if_poor_intersection")
+
+    @stop_if_poor_intersection.setter
+    def stop_if_poor_intersection(self, value: bool):
+        self.set_property_state("stop_if_poor_intersection", value)
+
+    @property
+    def poor_intersection_threshold(self) -> RealType:
+        """System Coupling terminates with an error if the intersected fractions are below this threshold (in both directions)"""
+        return self.get_property_state("poor_intersection_threshold")
+
+    @poor_intersection_threshold.setter
+    def poor_intersection_threshold(self, value: RealType):
+        self.set_property_state("poor_intersection_threshold", value)
+
+    @property
+    def face_alignment(self) -> str:
+        """Controls how face alignment is used during mapping.
+
+        Allowed values:
+
+        - \"ProgramControlled\" (default)
+        - \"OppositeOrientation\"
+        - \"SameOrientation\"
+        - \"AnyOrientation\" """
+        return self.get_property_state("face_alignment")
+
+    @face_alignment.setter
+    def face_alignment(self, value: str):
+        self.set_property_state("face_alignment", value)
+
+    @property
+    def absolute_gap_tolerance(self) -> RealType:
+        """Absolute gap tolerance value."""
+        return self.get_property_state("absolute_gap_tolerance")
+
+    @absolute_gap_tolerance.setter
+    def absolute_gap_tolerance(self, value: RealType):
+        self.set_property_state("absolute_gap_tolerance", value)
+
+    @property
+    def relative_gap_tolerance(self) -> RealType:
+        """Maximum gap size relative to face size."""
+        return self.get_property_state("relative_gap_tolerance")
+
+    @relative_gap_tolerance.setter
+    def relative_gap_tolerance(self, value: RealType):
+        self.set_property_state("relative_gap_tolerance", value)
+
+    @property
+    def small_weight_tolerance(self) -> RealType:
+        """Relative tolerance used to control when weights are dropped."""
+        return self.get_property_state("small_weight_tolerance")
+
+    @small_weight_tolerance.setter
+    def small_weight_tolerance(self, value: RealType):
+        self.set_property_state("small_weight_tolerance", value)
+
+    @property
+    def corner_tolerance(self) -> RealType:
+        """Angle [degrees] between adjacent source mesh faces above which the
+        mapping algorithm will stop searching for mapping candidates."""
+        return self.get_property_state("corner_tolerance")
+
+    @corner_tolerance.setter
+    def corner_tolerance(self, value: RealType):
+        self.set_property_state("corner_tolerance", value)
+
+    @property
+    def halo_tolerance(self) -> RealType:
+        """If a face intersects but a target node lies outside of the source face, then
+        map the node if the projected distance to the face / sqrt(srcArea) is less
+        than this tolerance, otherwise leave as unmapped."""
+        return self.get_property_state("halo_tolerance")
+
+    @halo_tolerance.setter
+    def halo_tolerance(self, value: RealType):
+        self.set_property_state("halo_tolerance", value)
+
+    @property
+    def conservative_reciprocity_factor(self) -> RealType:
+        """Reciprocity blend factor for conservative mapping."""
+        return self.get_property_state("conservative_reciprocity_factor")
+
+    @conservative_reciprocity_factor.setter
+    def conservative_reciprocity_factor(self, value: RealType):
+        self.set_property_state("conservative_reciprocity_factor", value)
+
+    @property
+    def profile_preserving_reciprocity_factor(self) -> RealType:
+        """Reciprocity blend factor for profile-preserving mapping."""
+        return self.get_property_state("profile_preserving_reciprocity_factor")
+
+    @profile_preserving_reciprocity_factor.setter
+    def profile_preserving_reciprocity_factor(self, value: RealType):
+        self.set_property_state("profile_preserving_reciprocity_factor", value)
+
+    @property
+    def conservative_intensive(self) -> str:
+        """Determines when the Intensive option is used for conservative mapping.
+
+        Allowed values:
+
+        - \"ProgramControlled\" (default)
+        - \"Off\"
+        - \"On\" """
+        return self.get_property_state("conservative_intensive")
+
+    @conservative_intensive.setter
+    def conservative_intensive(self, value: str):
+        self.set_property_state("conservative_intensive", value)
+
+    @property
+    def preserve_normal(self) -> str:
+        """Determines if the normal component of a vector is preserved.
+
+        Allowed values:
+
+        - \"ProgramControlled\" (default)
+        - \"Off\"
+        - \"On\" """
+        return self.get_property_state("preserve_normal")
+
+    @preserve_normal.setter
+    def preserve_normal(self, value: str):
+        self.set_property_state("preserve_normal", value)
+
+    @property
+    def conservation_fix_tolerance_volume(self) -> RealType:
+        """Source element overlap fraction to trigger volume mapping conservation fix.
+
+        0.0 is default. 1.0 effectively disables it."""
+        return self.get_property_state("conservation_fix_tolerance_volume")
+
+    @conservation_fix_tolerance_volume.setter
+    def conservation_fix_tolerance_volume(self, value: RealType):
+        self.set_property_state("conservation_fix_tolerance_volume", value)
+
+    @property
+    def rbf_option(self) -> str:
+        """Controls radial basis function formulation.
+
+        Allowed values:
+
+        - \"Gaussian\" (default)
+        - \"ThinPlateSpline\" """
+        return self.get_property_state("rbf_option")
+
+    @rbf_option.setter
+    def rbf_option(self, value: str):
+        self.set_property_state("rbf_option", value)
+
+    @property
+    def rbf_shape_parameter(self) -> RealType:
+        """Sets the shape parameter beta when using Gaussian radial basis functions."""
+        return self.get_property_state("rbf_shape_parameter")
+
+    @rbf_shape_parameter.setter
+    def rbf_shape_parameter(self, value: RealType):
+        self.set_property_state("rbf_shape_parameter", value)
+
+    @property
+    def rbf_linear_correction(self) -> bool:
+        """Controls whether linear polynomial augmentation is added to the RBF stencil for
+        low order regular element types (tet, hex, pyramid, wedge)."""
+        return self.get_property_state("rbf_linear_correction")
+
+    @rbf_linear_correction.setter
+    def rbf_linear_correction(self, value: bool):
+        self.set_property_state("rbf_linear_correction", value)
+
+    @property
+    def rbf_clipping_scale(self) -> RealType:
+        """Length scale factor used to determine if source nodes are removed from RBF
+        stencil when too close."""
+        return self.get_property_state("rbf_clipping_scale")
+
+    @rbf_clipping_scale.setter
+    def rbf_clipping_scale(self, value: RealType):
+        self.set_property_state("rbf_clipping_scale", value)
+
+    @property
+    def clipping(self) -> bool:
+        """Controls whether to clip target values to the min/max of the local source values for profile-preserving transfers."""
+        return self.get_property_state("clipping")
+
+    @clipping.setter
+    def clipping(self, value: bool):
+        self.set_property_state("clipping", value)