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

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

@@ -0,0 +1,44 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class ascii_output(Container):
+    """
+    Output interface data as ASCII.
+    """
+
+    syc_name = "AsciiOutput"
+
+    property_names_types = [("option", "Option", "str"), ("format", "Format", "str")]
+
+    @property
+    def option(self) -> str:
+        """Control ASCII interface data output.
+
+        Allowed values:
+
+        - \"Off\"
+        - \"EveryStep\" (for step-based analyses)
+        - \"EveryIteration\" (for iteration-based analyses)"""
+        return self.get_property_state("option")
+
+    @option.setter
+    def option(self, value: str):
+        self.set_property_state("option", value)
+
+    @property
+    def format(self) -> str:
+        """ASCII output format type.
+
+        Allowed values:
+
+        - \"Axdt\"
+        - \"Csv\" """
+        return self.get_property_state("format")
+
+    @format.setter
+    def format(self, value: str):
+        self.set_property_state("format", value)

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

@@ -0,0 +1,20 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .attribute_child import attribute_child
+
+
+class attribute(NamedContainer[attribute_child]):
+    """
+    Configure a variable's attributes.
+    """
+
+    syc_name = "Attribute"
+
+    child_object_type: attribute_child = attribute_child
+    """
+    child_object_type of attribute.
+    """

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

@@ -0,0 +1,64 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .dimensionality import dimensionality
+
+
+class attribute_child(Container):
+    """
+    Configure a variable's attributes.
+    """
+
+    syc_name = "child_object_type"
+
+    child_names = ["dimensionality"]
+
+    dimensionality: dimensionality = dimensionality
+    """
+    dimensionality child of attribute_child.
+    """
+    property_names_types = [
+        ("attribute_type", "AttributeType", "str"),
+        ("modifiable", "Modifiable", "bool"),
+        ("real_value", "RealValue", "RealType"),
+        ("integer_value", "IntegerValue", "int"),
+    ]
+
+    @property
+    def attribute_type(self) -> str:
+        """The type of the attribute (\"Real\" or \"Integer\")."""
+        return self.get_property_state("attribute_type")
+
+    @attribute_type.setter
+    def attribute_type(self, value: str):
+        self.set_property_state("attribute_type", value)
+
+    @property
+    def modifiable(self) -> bool:
+        """Controls whether the attribute is Modifiable"""
+        return self.get_property_state("modifiable")
+
+    @modifiable.setter
+    def modifiable(self, value: bool):
+        self.set_property_state("modifiable", value)
+
+    @property
+    def real_value(self) -> RealType:
+        """Real attribute value."""
+        return self.get_property_state("real_value")
+
+    @real_value.setter
+    def real_value(self, value: RealType):
+        self.set_property_state("real_value", value)
+
+    @property
+    def integer_value(self) -> int:
+        """Integer attribute value."""
+        return self.get_property_state("integer_value")
+
+    @integer_value.setter
+    def integer_value(self, value: int):
+        self.set_property_state("integer_value", value)

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

@@ -0,0 +1,46 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class automatic_alignment_options(Container):
+    """
+    Automatic alignment settings.
+    """
+
+    syc_name = "AutomaticAlignmentOptions"
+
+    property_names_types = [
+        ("alignment_type", "AlignmentType", "str"),
+        ("singular_value_tolerance", "SingularValueTolerance", "RealType"),
+        ("verbosity", "Verbosity", "int"),
+    ]
+
+    @property
+    def alignment_type(self) -> str:
+        """Alignment type (\"Covariance\" or \"Moment Covariance\" or \"Inertial Axes\")."""
+        return self.get_property_state("alignment_type")
+
+    @alignment_type.setter
+    def alignment_type(self, value: str):
+        self.set_property_state("alignment_type", value)
+
+    @property
+    def singular_value_tolerance(self) -> RealType:
+        """Tolerance used to compare singular values"""
+        return self.get_property_state("singular_value_tolerance")
+
+    @singular_value_tolerance.setter
+    def singular_value_tolerance(self, value: RealType):
+        self.set_property_state("singular_value_tolerance", value)
+
+    @property
+    def verbosity(self) -> int:
+        """Set to 1 to print additional information about the alignment"""
+        return self.get_property_state("verbosity")
+
+    @verbosity.setter
+    def verbosity(self, value: int):
+        self.set_property_state("verbosity", value)

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

@@ -0,0 +1,40 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class available_ports(Container):
+    """
+    Specify ports available for co-simulation.
+    """
+
+    syc_name = "AvailablePorts"
+
+    property_names_types = [("option", "Option", "str"), ("range", "Range", "str")]
+
+    @property
+    def option(self) -> str:
+        """Specify how available ports are determined.
+
+        - \"ProgramControlled\" - System Coupling will find an
+          available port.
+        - \"UserDefined\" - An available port will be chosen,
+          if possible, from a specified range."""
+        return self.get_property_state("option")
+
+    @option.setter
+    def option(self, value: str):
+        self.set_property_state("option", value)
+
+    @property
+    def range(self) -> str:
+        """Port range expressed as a comma-separated list of integers and/or
+        integer ranges. An integer range is a pair of integers separated
+        with a "-" character, specify an inclusive range of port numbers."""
+        return self.get_property_state("range")
+
+    @range.setter
+    def range(self, value: str):
+        self.set_property_state("range", value)

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

@@ -0,0 +1,56 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class avoid_data_reconstruction(Container):
+    """
+    Control whether data reconstruction should be done for elemental intensive data.
+    """
+
+    syc_name = "AvoidDataReconstruction"
+
+    property_names_types = [
+        ("volume_mapping", "VolumeMapping", "bool"),
+        ("surface_mapping", "SurfaceMapping", "bool"),
+        ("surface_volume_mapping", "SurfaceVolumeMapping", "bool"),
+        ("nep", "NEP", "str"),
+    ]
+
+    @property
+    def volume_mapping(self) -> bool:
+        """UNDOCUMENTED"""
+        return self.get_property_state("volume_mapping")
+
+    @volume_mapping.setter
+    def volume_mapping(self, value: bool):
+        self.set_property_state("volume_mapping", value)
+
+    @property
+    def surface_mapping(self) -> bool:
+        """UNDOCUMENTED"""
+        return self.get_property_state("surface_mapping")
+
+    @surface_mapping.setter
+    def surface_mapping(self, value: bool):
+        self.set_property_state("surface_mapping", value)
+
+    @property
+    def surface_volume_mapping(self) -> bool:
+        """UNDOCUMENTED"""
+        return self.get_property_state("surface_volume_mapping")
+
+    @surface_volume_mapping.setter
+    def surface_volume_mapping(self, value: bool):
+        self.set_property_state("surface_volume_mapping", value)
+
+    @property
+    def nep(self) -> str:
+        """UNDOCUMENTED"""
+        return self.get_property_state("nep")
+
+    @nep.setter
+    def nep(self, value: str):
+        self.set_property_state("nep", value)

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

@@ -0,0 +1,62 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+SHASH = "34d232b251e1d4a5a6b88e3deb9591863eac6afb1446228951276f9b1700da9f"
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from ._clear_state import _clear_state
+from .clear_state import clear_state
+from .delete_snapshot import delete_snapshot
+from .open import open
+from .open_snapshot import open_snapshot
+from .save import save
+from .save_snapshot import save_snapshot
+
+
+class case_root(Container):
+    """
+    'root' object
+    """
+
+    syc_name = "CaseCommands"
+
+    command_names = [
+        "_clear_state",
+        "clear_state",
+        "delete_snapshot",
+        "open",
+        "open_snapshot",
+        "save",
+        "save_snapshot",
+    ]
+
+    _clear_state: _clear_state = _clear_state
+    """
+    _clear_state command of case_root.
+    """
+    clear_state: clear_state = clear_state
+    """
+    clear_state command of case_root.
+    """
+    delete_snapshot: delete_snapshot = delete_snapshot
+    """
+    delete_snapshot command of case_root.
+    """
+    open: open = open
+    """
+    open command of case_root.
+    """
+    open_snapshot: open_snapshot = open_snapshot
+    """
+    open_snapshot command of case_root.
+    """
+    save: save = save
+    """
+    save command of case_root.
+    """
+    save_snapshot: save_snapshot = save_snapshot
+    """
+    save_snapshot command of case_root.
+    """

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

@@ -0,0 +1,18 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class clear_state(InjectedCommand):
+    """
+    Clears the state of the entire System Coupling service, removing all
+    data model items, parameter values, and calculated values.
+
+    Cannot be run after participants have been started.
+    """
+
+    syc_name = "clear_state"
+
+    cmd_name = "clear_state"

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

@@ -0,0 +1,41 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+
+class connect_ensight_dvs(Command):
+    """
+    Allow System Coupling to create DVS clients and connect these clients to
+    the DVS server that is already launched in another process/thread remotely.
+
+    When this command is issued, System Coupling is connected to remote EnSight
+    and the in-situ data streaming from system coupling to EnSight is ready.
+
+    Parameters
+    ----------
+    port : int, optional
+        DVS Server port that System Coupling would connect to. Default value is 50055.
+    host_name : str, optional
+        DVS Server host name that System Coupling would connect to. Default value is "127.0.0.1".
+
+    """
+
+    syc_name = "ConnectEnSightDVS"
+
+    argument_names = ["port", "host_name"]
+
+    class port(Integer):
+        """
+        DVS Server port that System Coupling would connect to. Default value is 50055.
+        """
+
+        syc_name = "Port"
+
+    class host_name(String):
+        """
+        DVS Server host name that System Coupling would connect to. Default value is "127.0.0.1".
+        """
+
+        syc_name = "HostName"

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

@@ -0,0 +1,20 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .coupling_interface_child import coupling_interface_child
+
+
+class coupling_interface(NamedContainer[coupling_interface_child]):
+    """
+    Configure a coupling interface.
+    """
+
+    syc_name = "CouplingInterface"
+
+    child_object_type: coupling_interface_child = coupling_interface_child
+    """
+    child_object_type of coupling_interface.
+    """

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

@@ -0,0 +1,42 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .data_transfer import data_transfer
+from .mapping_control import mapping_control
+from .side import side
+
+
+class coupling_interface_child(Container):
+    """
+    Configure a coupling interface.
+    """
+
+    syc_name = "child_object_type"
+
+    child_names = ["side", "data_transfer", "mapping_control"]
+
+    side: side = side
+    """
+    side child of coupling_interface_child.
+    """
+    data_transfer: data_transfer = data_transfer
+    """
+    data_transfer child of coupling_interface_child.
+    """
+    mapping_control: mapping_control = mapping_control
+    """
+    mapping_control child of coupling_interface_child.
+    """
+    property_names_types = [("display_name", "DisplayName", "str")]
+
+    @property
+    def display_name(self) -> str:
+        """Set the display name of an object."""
+        return self.get_property_state("display_name")
+
+    @display_name.setter
+    def display_name(self, value: str):
+        self.set_property_state("display_name", value)

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

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.systemcoupling.core.adaptor.impl.types import *
+
+from .coupling_participant_child import coupling_participant_child
+
+
+class coupling_participant(NamedContainer[coupling_participant_child]):
+    """
+    Configure a coupling participant.
+
+    These settings are typically populated by using the ``add_participant``
+    command.
+    """
+
+    syc_name = "CouplingParticipant"
+
+    child_object_type: coupling_participant_child = coupling_participant_child
+    """
+    child_object_type of coupling_participant.
+    """