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

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

@@ -1,231 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-from .attribute import attribute
-
-
-class variable_child(Container):
-    """
-    Configure a variable for the coupling participant.
-    """
-
-    syc_name = "child_object_type"
-
-    child_names = ["attribute"]
-
-    attribute: attribute = attribute
-    """
-    attribute child of variable_child.
-    """
-    property_names_types = [
-        ("quantity_type", "QuantityType", "str"),
-        ("location", "Location", "str"),
-        ("participant_display_name", "ParticipantDisplayName", "str"),
-        ("display_name", "DisplayName", "str"),
-        ("data_type", "DataType", "str"),
-        ("real_initial_value", "RealInitialValue", "RealType"),
-        ("integer_initial_value", "IntegerInitialValue", "int"),
-        ("logical_initial_value", "LogicalInitialValue", "bool"),
-        ("string_initial_value", "StringInitialValue", "str"),
-        ("enumeration_initial_value", "EnumerationInitialValue", "int"),
-        ("real_min", "RealMin", "RealType"),
-        ("real_max", "RealMax", "RealType"),
-        ("integer_min", "IntegerMin", "int"),
-        ("integer_max", "IntegerMax", "int"),
-        ("enumeration_min", "EnumerationMin", "int"),
-        ("enumeration_max", "EnumerationMax", "int"),
-        ("tensor_type", "TensorType", "str"),
-        ("is_extensive", "IsExtensive", "bool"),
-    ]
-
-    @property
-    def quantity_type(self) -> str:
-        """Quantity type of the variable.
-
-        Allowed values:
-
-        - \"Unspecified\"
-        - \"Force\"
-        - \"Incremental Displacement\"
-        - \"Temperature\"
-        - \"Heat Rate\"
-        - \"Heat Transfer Coefficient\"
-        - \"Convection Reference Temperature\"
-        - \"Mode Shape\"
-        - \"Electrical Conductivity\" """
-        return self.get_property_state("quantity_type")
-
-    @quantity_type.setter
-    def quantity_type(self, value: str):
-        self.set_property_state("quantity_type", value)
-
-    @property
-    def location(self) -> str:
-        """Data location of the variable (\"Node\" or \"Element\")."""
-        return self.get_property_state("location")
-
-    @location.setter
-    def location(self, value: str):
-        self.set_property_state("location", value)
-
-    @property
-    def participant_display_name(self) -> str:
-        """Variable's display name as defined by the participant solver."""
-        return self.get_property_state("participant_display_name")
-
-    @participant_display_name.setter
-    def participant_display_name(self, value: str):
-        self.set_property_state("participant_display_name", value)
-
-    @property
-    def display_name(self) -> str:
-        """Variable's display name as defined in System Coupling."""
-        return self.get_property_state("display_name")
-
-    @display_name.setter
-    def display_name(self, value: str):
-        self.set_property_state("display_name", value)
-
-    @property
-    def data_type(self) -> str:
-        """Variable's data type as reported by the participant.
-
-        Allowed values (non-FMU case):
-
-        - Real
-        - Complex
-
-        Allowed values (FMU):
-
-        - Real
-        - Integer
-        - Logical
-        - String
-        - Enumeration"""
-        return self.get_property_state("data_type")
-
-    @data_type.setter
-    def data_type(self, value: str):
-        self.set_property_state("data_type", value)
-
-    @property
-    def real_initial_value(self) -> RealType:
-        """Real data start value."""
-        return self.get_property_state("real_initial_value")
-
-    @real_initial_value.setter
-    def real_initial_value(self, value: RealType):
-        self.set_property_state("real_initial_value", value)
-
-    @property
-    def integer_initial_value(self) -> int:
-        """Integer data start value."""
-        return self.get_property_state("integer_initial_value")
-
-    @integer_initial_value.setter
-    def integer_initial_value(self, value: int):
-        self.set_property_state("integer_initial_value", value)
-
-    @property
-    def logical_initial_value(self) -> bool:
-        """Logical data start value."""
-        return self.get_property_state("logical_initial_value")
-
-    @logical_initial_value.setter
-    def logical_initial_value(self, value: bool):
-        self.set_property_state("logical_initial_value", value)
-
-    @property
-    def string_initial_value(self) -> str:
-        """String data start value."""
-        return self.get_property_state("string_initial_value")
-
-    @string_initial_value.setter
-    def string_initial_value(self, value: str):
-        self.set_property_state("string_initial_value", value)
-
-    @property
-    def enumeration_initial_value(self) -> int:
-        """Enumeration data start value."""
-        return self.get_property_state("enumeration_initial_value")
-
-    @enumeration_initial_value.setter
-    def enumeration_initial_value(self, value: int):
-        self.set_property_state("enumeration_initial_value", value)
-
-    @property
-    def real_min(self) -> RealType:
-        """Real data minimum value."""
-        return self.get_property_state("real_min")
-
-    @real_min.setter
-    def real_min(self, value: RealType):
-        self.set_property_state("real_min", value)
-
-    @property
-    def real_max(self) -> RealType:
-        """Real data maximum value."""
-        return self.get_property_state("real_max")
-
-    @real_max.setter
-    def real_max(self, value: RealType):
-        self.set_property_state("real_max", value)
-
-    @property
-    def integer_min(self) -> int:
-        """Integer data minimum value."""
-        return self.get_property_state("integer_min")
-
-    @integer_min.setter
-    def integer_min(self, value: int):
-        self.set_property_state("integer_min", value)
-
-    @property
-    def integer_max(self) -> int:
-        """Integer data maximum value."""
-        return self.get_property_state("integer_max")
-
-    @integer_max.setter
-    def integer_max(self, value: int):
-        self.set_property_state("integer_max", value)
-
-    @property
-    def enumeration_min(self) -> int:
-        """Enumeration data minimum value."""
-        return self.get_property_state("enumeration_min")
-
-    @enumeration_min.setter
-    def enumeration_min(self, value: int):
-        self.set_property_state("enumeration_min", value)
-
-    @property
-    def enumeration_max(self) -> int:
-        """Enumeration data maximum value."""
-        return self.get_property_state("enumeration_max")
-
-    @enumeration_max.setter
-    def enumeration_max(self, value: int):
-        self.set_property_state("enumeration_max", value)
-
-    @property
-    def tensor_type(self) -> str:
-        """Indicates the variable tensor type (\"Scalar\" or \"Vector\").
-
-        \"Vector\" is not supported for the FMU case."""
-        return self.get_property_state("tensor_type")
-
-    @tensor_type.setter
-    def tensor_type(self, value: str):
-        self.set_property_state("tensor_type", value)
-
-    @property
-    def is_extensive(self) -> bool:
-        """Indicates whether this is an extensive property."""
-        return self.get_property_state("is_extensive")
-
-    @is_extensive.setter
-    def is_extensive(self, value: bool):
-        self.set_property_state("is_extensive", value)

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

@@ -1,21 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-
-class write_csv_chart_files(Command):
-    """
-    For each coupling interface, exports a CSV file containing chart data
-    (convergence and source/target quantity transfer values) for
-    that interface.
-
-    Each file is named according to the convention ``<interface>.csv``, where
-    ``<interface>`` is the object name of the corresponding coupling interface.
-
-    This command will overwrite any CSV charting files that already exist,
-    including any that were written during the solution.
-    """
-
-    syc_name = "WriteCsvChartFiles"

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

@@ -1,46 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-
-class write_ensight(Command):
-    """
-    Write a file with mesh and results which can be loaded into EnSight for
-    post processing.
-
-    Parameters
-    ----------
-    file_name : str
-        Base name for EnSight files. It will generate <base>.encas file which
-        should be loaded into EnSight. Other files are generated for geometry
-        and variables.
-    binary : bool, optional
-        To control if file is to be written in binary format or ASCII. ASCII
-        slows down performance, but may be useful for debugging and seeing
-        raw data.
-
-    """
-
-    syc_name = "WriteEnSight"
-
-    argument_names = ["file_name", "binary"]
-
-    class file_name(String):
-        """
-        Base name for EnSight files. It will generate <base>.encas file which
-        should be loaded into EnSight. Other files are generated for geometry
-        and variables.
-        """
-
-        syc_name = "FileName"
-
-    class binary(Boolean):
-        """
-        To control if file is to be written in binary format or ASCII. ASCII
-        slows down performance, but may be useful for debugging and seeing
-        raw data.
-        """
-
-        syc_name = "Binary"

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

@@ -1,32 +0,0 @@
-#
-# This is an auto-generated file.  DO NOT EDIT!
-#
-
-from ansys.systemcoupling.core.adaptor.impl.types import *
-
-
-class write_target_data(Command):
-    """
-    Command to write target data for target participant after mapping operation.
-
-    The purpose of this command is to write target mesh and target mapped data in
-    the target participant working directory and thus mapping results from SystemCoupling can
-    be check in the target participant.
-
-    Parameters
-    ----------
-    overwrite : bool, optional
-        Flag indicating whether to overwrite the existing target data file. Default value is False.
-
-    """
-
-    syc_name = "WriteTargetData"
-
-    argument_names = ["overwrite"]
-
-    class overwrite(Boolean):
-        """
-        Flag indicating whether to overwrite the existing target data file. Default value is False.
-        """
-
-        syc_name = "Overwrite"