ansys-fluent-core 0.20.dev6__py3-none-any.whl → 0.20.dev8__py3-none-any.whl

ansys/fluent/core/session.py

@@ -21,6 +21,7 @@ from ansys.fluent.core.streaming_services.events_streaming import EventsManager
 from ansys.fluent.core.streaming_services.field_data_streaming import FieldDataStreaming
 from ansys.fluent.core.streaming_services.monitor_streaming import MonitorsManager
 from ansys.fluent.core.streaming_services.transcript_streaming import Transcript
+from ansys.fluent.core.utils.fluent_version import FluentVersion
 
 from .rpvars import RPVars
 
@@ -258,9 +259,9 @@ class BaseSession:
         """Executes a tui command."""
         self.scheme_eval.scheme_eval(f"(ti-menu-load-string {json.dumps(command)})")
 
-    def get_fluent_version(self):
+    def get_fluent_version(self) -> FluentVersion:
         """Gets and returns the fluent version."""
-        return self.scheme_eval.version
+        return FluentVersion(self.scheme_eval.version)
 
     def exit(self, **kwargs) -> None:
         """Exit session."""

ansys/fluent/core/session_base_meshing.py

@@ -10,7 +10,10 @@ from ansys.fluent.core.meshing.meshing_workflow import (
 from ansys.fluent.core.services.datamodel_se import PyMenuGeneric
 from ansys.fluent.core.services.datamodel_tui import TUIMenu
 from ansys.fluent.core.session_shared import _CODEGEN_MSG_DATAMODEL, _CODEGEN_MSG_TUI
-from ansys.fluent.core.utils.fluent_version import get_version_for_file_name
+from ansys.fluent.core.utils.fluent_version import (
+    FluentVersion,
+    get_version_for_file_name,
+)
 
 pyfluent_logger = logging.getLogger("pyfluent.general")
 datamodel_logger = logging.getLogger("pyfluent.datamodel")
@@ -51,10 +54,10 @@ class BaseMeshing:
         self._session_execute_tui = session_execute_tui
         self._product_version = None
 
-    def get_fluent_version(self):
+    def get_fluent_version(self) -> FluentVersion:
         """Gets and returns the fluent version."""
         pyfluent_logger.debug("Fluent version = " + str(self._fluent_version))
-        return self._fluent_version
+        return FluentVersion(self._fluent_version)
 
     @property
     def _version(self):
@@ -103,7 +106,7 @@ class BaseMeshing:
     def _meshing_utilities_root(self):
         """Datamodel root of meshing_utilities."""
         try:
-            if self.get_fluent_version() >= "24.2.0":
+            if self.get_fluent_version() >= FluentVersion.v242:
                 meshing_utilities_module = importlib.import_module(
                     f"ansys.fluent.core.datamodel_{self._version}.MeshingUtilities"
                 )
@@ -112,7 +115,7 @@ class BaseMeshing:
                 )
         except ImportError:
             datamodel_logger.warning(_CODEGEN_MSG_DATAMODEL)
-            if self.get_fluent_version() >= "24.2.0":
+            if self.get_fluent_version() >= FluentVersion.v242:
                 meshing_utilities_root = PyMenuGeneric(
                     self._se_service, "meshing_utilities"
                 )

ansys/fluent/core/session_pure_meshing.py

@@ -14,6 +14,7 @@ from ansys.fluent.core.session import BaseSession
 from ansys.fluent.core.session_base_meshing import BaseMeshing
 from ansys.fluent.core.streaming_services.datamodel_streaming import DatamodelStream
 from ansys.fluent.core.utils.data_transfer import transfer_case
+from ansys.fluent.core.utils.fluent_version import FluentVersion
 
 
 class PureMeshing(BaseSession):
@@ -55,7 +56,7 @@ class PureMeshing(BaseSession):
         self._base_meshing = BaseMeshing(
             self.execute_tui,
             fluent_connection,
-            self.get_fluent_version(),
+            self.get_fluent_version().value,
             self.datamodel_service_tui,
             self.datamodel_service_se,
         )
@@ -93,13 +94,13 @@ class PureMeshing(BaseSession):
     @property
     def meshing_queries(self):
         """Datamodel root of meshing_queries."""
-        if float(self.get_fluent_version()[:-2]) >= 23.2:
+        if self.get_fluent_version() >= FluentVersion.v232:
             return MeshingQueries(self.meshing_queries_service)
 
     @property
     def meshing_utilities(self):
         """Datamodel root of meshing_utilities."""
-        if self.get_fluent_version() >= "24.2.0":
+        if self.get_fluent_version() >= FluentVersion.v242:
             return self._base_meshing.meshing_utilities
 
     @property

ansys/fluent/core/solver/flobject.py

@@ -478,7 +478,7 @@ class Textual(Property):
     """Exposes attribute accessor on settings object - specific to string objects."""
 
 
-class DeprecatedSettingWarning(DeprecationWarning):
+class DeprecatedSettingWarning(FutureWarning):
     pass
 
 
@@ -493,7 +493,6 @@ def _show_warning(message, category, *args, **kwargs):
 
 
 warnings.showwarning = _show_warning
-warnings.simplefilter("default", category=DeprecatedSettingWarning)
 
 
 class _Alias:
@@ -601,7 +600,7 @@ class SettingsBase(Base, Generic[StateT]):
         if isinstance(value, collections.abc.Mapping):
             ret = {}
             for k, v in value.items():
-                if k in cls._child_aliases:
+                if hasattr(cls, "_child_aliases") and k in cls._child_aliases:
                     alias = cls._child_aliases[k]
                     if not isinstance(alias, str):
                         alias = alias.alias_path
@@ -620,7 +619,11 @@ class SettingsBase(Base, Generic[StateT]):
                             ret_alias[comp] = {}
                             ret_alias = ret_alias[comp]
                 else:
-                    ret[k] = cls.unalias(v)
+                    if issubclass(cls, Group):
+                        ccls = cls._child_classes[k]
+                        ret[k] = ccls.unalias(v)
+                    else:
+                        ret[k] = cls.unalias(v)
             return ret
         else:
             return value
@@ -1118,6 +1121,13 @@ class NamedObject(SettingsBase[DictStateType], Generic[ChildTypeT]):
         for query in self.query_names:
             cls = self.__class__._child_classes[query]
             self._setattr(query, _create_child(cls, None, self))
+        if not hasattr(
+            self, "rename"
+        ):  # if rename command is not available from settings API
+            self._setattr(
+                "rename",
+                types.MethodType(lambda obj, new, old: _rename(obj, new, old), self),
+            )
 
     @classmethod
     def to_scheme_keys(cls, value):

ansys/fluent/core/solver/settings_242/__init__.py

@@ -5,5 +5,5 @@
 """A package providing Fluent's Settings Objects in Python."""
 from ansys.fluent.core.solver.flobject import *
 
-SHASH = "434001f6c09fcef5f6eb73216b946c271f9cf19e7dd568517325e8effd6d36e5"
+SHASH = "8cfb9f8cb00d0dcc187ef81e554dfdbfad1d69951eed31348358a0e3907ec9c7"
 from .root import root

ansys/fluent/core/solver/settings_242/accuracy_control_1.py

@@ -14,12 +14,12 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option import option as option_cls
+from .option_18 import option as option_cls
 from .step_size import step_size as step_size_cls
 from .tolerance_2 import tolerance as tolerance_cls
 class accuracy_control(Group):
     """
-    'accuracy_control' child.
+    Control the accuracy.
     """
 
     fluent_name = "accuracy-control"

ansys/fluent/core/solver/settings_242/animate_on.py

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class animate_on(String, _HasAllowedValuesMixin):
     """
-    'animate_on' child.
+    Select graphics object as animate on which will be recored at set frequency.
     """
 
     fluent_name = "animate-on"

ansys/fluent/core/solver/settings_242/appended_time_decimal_precision.py

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class appended_time_decimal_precision(Integer):
     """
-    'appended_time_decimal_precision' child.
+    Specify the number of decimal places included in the appended flow-time value.
     """
 
     fluent_name = "appended-time-decimal-precision"

ansys/fluent/core/solver/settings_242/appended_time_freq_of.py

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class appended_time_freq_of(String, _HasAllowedValuesMixin):
     """
-    'appended_time_freq_of' child.
+    Specify whether the time-step, flow-time, or iteration number is appended to the animation image file name.
     """
 
     fluent_name = "appended-time-freq-of"

ansys/fluent/core/solver/settings_242/autosave.py

@@ -15,7 +15,7 @@ from ansys.fluent.core.solver.flobject import (
 )
 
 from .file_name_11 import file_name as file_name_cls
-from .frequency_3 import frequency as frequency_cls
+from .frequency_4 import frequency as frequency_cls
 from .max_files_1 import max_files as max_files_cls
 class autosave(Command):
     """

ansys/fluent/core/solver/settings_242/axes_1.py

@@ -21,7 +21,7 @@ from .auto_scale_1 import auto_scale as auto_scale_cls
 from .labels import labels as labels_cls
 class axes(Group):
     """
-    'axes' child.
+    Choose X Y axes.
     """
 
     fluent_name = "axes"

ansys/fluent/core/solver/settings_242/axis_origin_4.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class axis_origin(RealList):
+    """
+    Enter x y z rotation axis origin values.
+    """
+
+    fluent_name = "axis-origin"
+

ansys/fluent/core/solver/settings_242/camera.py

@@ -15,7 +15,7 @@ from ansys.fluent.core.solver.flobject import (
 )
 
 from .dolly import dolly as dolly_cls
-from .field_2 import field as field_cls
+from .field_4 import field as field_cls
 from .orbit import orbit as orbit_cls
 from .pan import pan as pan_cls
 from .position_1 import position as position_cls

ansys/fluent/core/solver/settings_242/clear_repeats.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class clear_repeats(Command):
+    """
+    Clear all periodic repeats.
+    """
+
+    fluent_name = "clear-repeats"
+

ansys/fluent/core/solver/settings_242/clustering_settings.py

@@ -17,6 +17,7 @@ from ansys.fluent.core.solver.flobject import (
 from .enable_mesh_interface_clustering import enable_mesh_interface_clustering as enable_mesh_interface_clustering_cls
 from .split_angle import split_angle as split_angle_cls
 from .clustering_algorithm import clustering_algorithm as clustering_algorithm_cls
+from .enable_clustering import enable_clustering as enable_clustering_cls
 from .faces_per_cluster import faces_per_cluster as faces_per_cluster_cls
 from .print_thread_clusters import print_thread_clusters as print_thread_clusters_cls
 class clustering_settings(Group):
@@ -28,7 +29,7 @@ class clustering_settings(Group):
 
     child_names = \
         ['enable_mesh_interface_clustering', 'split_angle',
-         'clustering_algorithm', 'faces_per_cluster']
+         'clustering_algorithm', 'enable_clustering', 'faces_per_cluster']
 
     command_names = \
         ['print_thread_clusters']
@@ -37,6 +38,7 @@ class clustering_settings(Group):
         enable_mesh_interface_clustering=enable_mesh_interface_clustering_cls,
         split_angle=split_angle_cls,
         clustering_algorithm=clustering_algorithm_cls,
+        enable_clustering=enable_clustering_cls,
         faces_per_cluster=faces_per_cluster_cls,
         print_thread_clusters=print_thread_clusters_cls,
     )

ansys/fluent/core/solver/settings_242/coarsen_1.py

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class coarsen(Integer):
     """
-    'coarsen' child.
+    Set coarsen level for pathlines.
     """
 
     fluent_name = "coarsen"

ansys/fluent/core/solver/settings_242/coarsen_2.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class coarsen(Integer):
+    """
+    Set coarsen level for particle tracks.
+    """
+
+    fluent_name = "coarsen"
+

ansys/fluent/core/solver/settings_242/color_map.py

@@ -32,7 +32,7 @@ from .bground_color import bground_color as bground_color_cls
 from .title_elements import title_elements as title_elements_cls
 class color_map(Group):
     """
-    'color_map' child.
+    Choose color using the colormap panel.
     """
 
     fluent_name = "color-map"

ansys/fluent/core/solver/settings_242/curves_1.py

@@ -18,7 +18,7 @@ from .lines import lines as lines_cls
 from .markers import markers as markers_cls
 class curves(Group):
     """
-    'curves' child.
+    Choose line, marker style and color for Curves.
     """
 
     fluent_name = "curves"

ansys/fluent/core/solver/settings_242/display_6.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class display(Command):
+    """
+    Display periodic instancing.
+    """
+
+    fluent_name = "display"
+

ansys/fluent/core/solver/settings_242/enable_clustering.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class enable_clustering(Boolean):
+    """
+    Enable/Disable clustering for S2S in GPU.
+    """
+
+    fluent_name = "enable-clustering"
+

ansys/fluent/core/solver/settings_242/field_2.py

@@ -14,28 +14,10 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .width import width as width_cls
-from .height import height as height_cls
-class field(Command):
+class field(String, _HasAllowedValuesMixin):
     """
-    Set the field of view (width and height).
-    
-    Parameters
-    ----------
-        width : real
-            'width' child.
-        height : real
-            'height' child.
-    
+    Select path line color by.
     """
 
     fluent_name = "field"
 
-    argument_names = \
-        ['width', 'height']
-
-    _child_classes = dict(
-        width=width_cls,
-        height=height_cls,
-    )
-

ansys/fluent/core/solver/settings_242/field_3.py

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class field(String, _HasAllowedValuesMixin):
     """
-    Set the field.
+    Select particle line color by.
     """
 
     fluent_name = "field"

ansys/fluent/core/solver/settings_242/field_4.py

@@ -0,0 +1,41 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+from .width import width as width_cls
+from .height import height as height_cls
+class field(Command):
+    """
+    Set the field of view (width and height).
+    
+    Parameters
+    ----------
+        width : real
+            'width' child.
+        height : real
+            'height' child.
+    
+    """
+
+    fluent_name = "field"
+
+    argument_names = \
+        ['width', 'height']
+
+    _child_classes = dict(
+        width=width_cls,
+        height=height_cls,
+    )
+

ansys/fluent/core/solver/settings_242/field_5.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class field(String, _HasAllowedValuesMixin):
+    """
+    Set the field.
+    """
+
+    fluent_name = "field"
+

ansys/fluent/core/solver/settings_242/filter_settings.py

@@ -21,7 +21,7 @@ from .filter_minimum import filter_minimum as filter_minimum_cls
 from .filter_maximum import filter_maximum as filter_maximum_cls
 class filter_settings(Group):
     """
-    'filter_settings' child.
+    Choose the filter settings.
     """
 
     fluent_name = "filter-settings"

ansys/fluent/core/solver/settings_242/flow_time_frequency.py

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class flow_time_frequency(Real):
     """
-    'flow_time_frequency' child.
+    Set flow time after which image will be captured.
     """
 
     fluent_name = "flow-time-frequency"

ansys/fluent/core/solver/settings_242/fluid_child_1.py

@@ -16,6 +16,9 @@ from ansys.fluent.core.solver.flobject import (
 
 from .name import name as name_cls
 from .phase import phase as phase_cls
+from .zonal_models import zonal_models as zonal_models_cls
+from .zonal_flow import zonal_flow as zonal_flow_cls
+from .zonal_flow_spec import zonal_flow_spec as zonal_flow_spec_cls
 from .general_2 import general as general_cls
 from .conical import conical as conical_cls
 from .reference_frame_1 import reference_frame as reference_frame_cls
@@ -38,8 +41,9 @@ class fluid_child(Group):
     fluent_name = "child-object-type"
 
     child_names = \
-        ['name', 'phase', 'general', 'conical', 'reference_frame',
-         'mesh_motion', 'porous_zone', 'fan_zone', 'embedded_les', 'reaction',
+        ['name', 'phase', 'zonal_models', 'zonal_flow', 'zonal_flow_spec',
+         'general', 'conical', 'reference_frame', 'mesh_motion',
+         'porous_zone', 'fan_zone', 'embedded_les', 'reaction',
          'source_terms', 'fixed_values', 'multiphase', 'disabled']
 
     query_names = \
@@ -48,6 +52,9 @@ class fluid_child(Group):
     _child_classes = dict(
         name=name_cls,
         phase=phase_cls,
+        zonal_models=zonal_models_cls,
+        zonal_flow=zonal_flow_cls,
+        zonal_flow_spec=zonal_flow_spec_cls,
         general=general_cls,
         conical=conical_cls,
         reference_frame=reference_frame_cls,

ansys/fluent/core/solver/settings_242/free_stream_particles.py

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class free_stream_particles(Boolean):
     """
-    'free_stream_particles' child.
+    Select free stream particles.
     """
 
     fluent_name = "free-stream-particles?"

ansys/fluent/core/solver/settings_242/frequency_2.py

@@ -14,22 +14,10 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option_15 import option as option_cls
-from .iterations_1 import iterations as iterations_cls
-from .time_steps import time_steps as time_steps_cls
-class frequency(Group):
+class frequency(Integer):
     """
-    Define the frequency at which cells in the register are marked for poor mesh numerics treatment.
+    Specify the timestep/iteration number after which image will be captured.
     """
 
     fluent_name = "frequency"
 
-    child_names = \
-        ['option', 'iterations', 'time_steps']
-
-    _child_classes = dict(
-        option=option_cls,
-        iterations=iterations_cls,
-        time_steps=time_steps_cls,
-    )
-

ansys/fluent/core/solver/settings_242/frequency_3.py

@@ -14,10 +14,22 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-class frequency(Integer):
+from .option_15 import option as option_cls
+from .iterations_1 import iterations as iterations_cls
+from .time_steps import time_steps as time_steps_cls
+class frequency(Group):
     """
-    Autosave adjoint iteration frequency.
+    Define the frequency at which cells in the register are marked for poor mesh numerics treatment.
     """
 
     fluent_name = "frequency"
 
+    child_names = \
+        ['option', 'iterations', 'time_steps']
+
+    _child_classes = dict(
+        option=option_cls,
+        iterations=iterations_cls,
+        time_steps=time_steps_cls,
+    )
+

ansys/fluent/core/solver/settings_242/frequency_4.py

@@ -0,0 +1,23 @@
+#
+# This is an auto-generated file.  DO NOT EDIT!
+#
+
+from ansys.fluent.core.solver.flobject import *
+
+from ansys.fluent.core.solver.flobject import (
+    _ChildNamedObjectAccessorMixin,
+    _CreatableNamedObjectMixin,
+    _NonCreatableNamedObjectMixin,
+    _HasAllowedValuesMixin,
+    _InputFile,
+    _OutputFile,
+    _InOutFile,
+)
+
+class frequency(Integer):
+    """
+    Autosave adjoint iteration frequency.
+    """
+
+    fluent_name = "frequency"
+