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

ansys/fluent/core/solver/flobject.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 """Module for accessing and modifying hierarchy of Fluent settings.
 
 The only useful method is '`get_root``, which returns the root object for
@@ -18,6 +16,8 @@ Example
 >>> r.boundary_conditions.velocity_inlet['inlet'].vmag.constant = 20
 """
 
+from __future__ import annotations
+
 import collections
 from contextlib import contextmanager, nullcontext
 import fnmatch
@@ -69,6 +69,7 @@ class InactiveObjectError(RuntimeError):
 
 class _InlineConstants:
     is_active = "active?"
+    is_stable = "webui-release-active?"
     is_read_only = "read-only?"
     default_value = "default"
     min = "min"
@@ -101,6 +102,7 @@ StateType = Union[PrimitiveStateType, DictStateType, ListStateType]
 
 
 def check_type(val, tp):
+    """Check type of object."""
     if hasattr(tp, "__supertype__"):
         return check_type(val, tp.__supertype__)
     if isinstance(tp, ForwardRef):
@@ -131,6 +133,13 @@ def check_type(val, tp):
 
 
 def assert_type(val, tp):
+    """Assert type.
+
+    Raises
+    ------
+    TypeError
+        If the given value is not of the given type.
+    """
     if not check_type(val, tp):
         raise TypeError(f"{val} is not of type {tp}.")
 
@@ -176,12 +185,13 @@ class Base:
         self._setattr("_file_transfer_service", None)
         if name is not None:
             self._setattr("_name", name)
+        self._setattr("_child_alias_objs", {})
 
     def set_flproxy(self, flproxy):
         """Set flproxy object."""
         self._setattr("_flproxy", flproxy)
 
-    def set_file_transfer_service(self, file_transfer_service):
+    def _set_file_transfer_service(self, file_transfer_service):
         """Set file_transfer_service."""
         self._setattr("_file_transfer_service", file_transfer_service)
 
@@ -319,6 +329,20 @@ class Base:
         attr = self.get_attr(_InlineConstants.is_active)
         return False if attr is False else True
 
+    def _check_stable(self) -> None:
+        """Whether the object is stable."""
+        if not self.is_active():
+            return
+        attr = self.get_attr(_InlineConstants.is_stable)
+        attr = True if attr is None else attr
+        if not attr:
+            warnings.warn(
+                f"The API feature at '{self.path}' is not stable. "
+                f"It is not guaranteed that it is fully validated and "
+                f"there is no commitment to its backwards compatibility.",
+                UnstableSettingWarning,
+            )
+
     def is_read_only(self) -> bool:
         """Whether the object is read-only."""
         attr = self.get_attr(_InlineConstants.is_read_only)
@@ -333,6 +357,7 @@ class Base:
         super().__setattr__(name, value)
 
     def find_object(self, relative_path):
+        """Find object."""
         obj = self
         for comp in relative_path.split("/"):
             if comp == "..":
@@ -342,29 +367,37 @@ class Base:
         return obj
 
     def before_execute(self, value):
+        """Executes before command execution."""
         if hasattr(self, "_do_before_execute"):
             self._do_before_execute(value)
 
     def after_execute(self, value):
+        """Executes after command execution."""
         if hasattr(self, "_do_after_execute"):
             self._do_after_execute(value)
 
-    def while_setting_state(self):
+    def _while_setting_state(self):
+        """Avoid additional processing while setting the state."""
         return nullcontext()
 
-    def while_renaming(self):
+    def _while_renaming(self):
+        """Avoid additional processing while renaming."""
         return nullcontext()
 
-    def while_deleting(self):
+    def _while_deleting(self):
+        """Avoid additional processing while deleting."""
         return nullcontext()
 
-    def while_creating(self):
+    def _while_creating(self):
+        """Avoid additional processing while creating."""
         return nullcontext()
 
-    def while_resizing(self):
+    def _while_resizing(self):
+        """Avoid additional processing while resizing."""
         return nullcontext()
 
-    def while_executing_command(self):
+    def _while_executing_command(self):
+        """Avoid additional processing while executing a command."""
         return nullcontext()
 
 
@@ -437,6 +470,8 @@ class RealNumerical(Numerical):
         state
             The type of state can be float, str (representing either
             an expression or a value with units), or an ansys.units.Quantity.
+        kwargs : Any
+            Keyword arguments.
 
         Raises
         ------
@@ -479,6 +514,14 @@ class Textual(Property):
 
 
 class DeprecatedSettingWarning(FutureWarning):
+    """Provides deprecated settings warning."""
+
+    pass
+
+
+class UnstableSettingWarning(UserWarning):
+    """Provides unstable settings warning."""
+
     pass
 
 
@@ -527,22 +570,22 @@ class _Alias:
                     )
                     _Alias.once = True
 
-    def while_setting_state(self):
+    def _while_setting_state(self):
         return self._print_newer_api()
 
-    def while_renaming(self):
+    def _while_renaming(self):
         return self._print_newer_api()
 
-    def while_deleting(self):
+    def _while_deleting(self):
         return self._print_newer_api()
 
-    def while_creating(self):
+    def _while_creating(self):
         return self._print_newer_api()
 
-    def while_resizing(self):
+    def _while_resizing(self):
         return self._print_newer_api()
 
-    def while_executing_command(self):
+    def _while_executing_command(self):
         return self._print_newer_api()
 
 
@@ -596,47 +639,52 @@ class SettingsBase(Base, Generic[StateT]):
         return self.to_python_keys(self.flproxy.get_var(self.path))
 
     @classmethod
-    def unalias(cls, value):
+    def _unalias(cls, value):
+        """Unalias the given value.
+
+        Raises
+        ------
+        NotImplementedError
+            If '..' is present in the alias path.
+        """
         if isinstance(value, collections.abc.Mapping):
             ret = {}
             for k, v in value.items():
                 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
                     # TODO: handle ".." in alias path
                     if ".." in alias:
                         raise NotImplementedError(
-                            'Cannot handle ".." in alias path while setting state.'
+                            'Cannot handle ".." in alias path while setting dictionary state.'
                         )
                     ret_alias = ret
                     comps = alias.split("/")
                     for i, comp in enumerate(comps):
                         cls = cls._child_classes[comp]
                         if i == len(comps) - 1:
-                            ret_alias[comp] = cls.unalias(v)
+                            ret_alias[comp] = cls._unalias(v)
                         else:
                             ret_alias[comp] = {}
                             ret_alias = ret_alias[comp]
                 else:
                     if issubclass(cls, Group):
                         ccls = cls._child_classes[k]
-                        ret[k] = ccls.unalias(v)
+                        ret[k] = ccls._unalias(v)
                     else:
-                        ret[k] = cls.unalias(v)
+                        ret[k] = cls._unalias(v)
             return ret
         else:
             return value
 
     def set_state(self, state: Optional[StateT] = None, **kwargs):
         """Set the state of the object."""
-        with self.while_setting_state():
+        with self._while_setting_state():
             if isinstance(state, (tuple, ansys_units.Quantity)) and hasattr(
                 self, "value"
             ):
                 self.value.set_state(state, **kwargs)
             else:
-                state = self.unalias(kwargs or state)
+                state = self._unalias(kwargs or state)
                 return self.flproxy.set_var(self.path, self.to_scheme_keys(state))
 
     @staticmethod
@@ -737,6 +785,8 @@ class FilenameList(SettingsBase[StringListType], Textual):
 
 
 class FileName(Base):
+    """Resolves MRO for child classes."""
+
     pass
 
 
@@ -850,10 +900,15 @@ class Group(SettingsBase[DictStateType]):
         else:
             return self.get_state()
 
-    # pylint: disable=missing-raises-doc
     @classmethod
     def to_scheme_keys(cls, value):
-        """Convert value to have keys with scheme names."""
+        """Convert value to have keys with scheme names.
+
+        Raises
+        ------
+        RuntimeError
+            If key is invalid.
+        """
         if isinstance(value, collections.abc.Mapping):
             ret = {}
             for k, v in value.items():
@@ -941,24 +996,26 @@ class Group(SettingsBase[DictStateType]):
         return ret
 
     def _get_parent_of_active_child_names(self, name):
-        parents = ""
-        path_list = []
-        for parent in self.get_active_child_names():
-            try:
-                if hasattr(getattr(self, parent), str(name)):
-                    path_list.append(f"    {self.python_path}.{parent}.{str(name)}")
-                    if len(parents) != 0:
-                        parents += ", " + parent
-                    else:
-                        parents += parent
-            except AttributeError:
-                pass
-        if len(path_list):
-            print(f"\n {str(name)} can be accessed from the following paths: \n")
-            for path in path_list:
-                print(path)
-        if len(parents):
-            return f"\n {name} is a child of {parents} \n"
+        with warnings.catch_warnings():
+            warnings.filterwarnings(action="ignore", category=UnstableSettingWarning)
+            parents = ""
+            path_list = []
+            for parent in self.get_active_child_names():
+                try:
+                    if hasattr(getattr(self, parent), str(name)):
+                        path_list.append(f"    {self.python_path}.{parent}.{str(name)}")
+                        if len(parents) != 0:
+                            parents += ", " + parent
+                        else:
+                            parents += parent
+                except AttributeError:
+                    pass
+            if len(path_list):
+                print(f"\n {str(name)} can be accessed from the following paths: \n")
+                for path in path_list:
+                    print(path)
+            if len(parents):
+                return f"\n {name} is a child of {parents} \n"
 
     def __getattribute__(self, name):
         if name in super().__getattribute__("child_names"):
@@ -966,16 +1023,18 @@ class Group(SettingsBase[DictStateType]):
                 raise InactiveObjectError(self.python_path)
         alias = super().__getattribute__("_child_aliases").get(name)
         if alias:
-            if isinstance(alias, str):
+            alias_obj = self._child_alias_objs.get(name)
+            if alias_obj is None:
                 obj = self.find_object(alias)
-                # replacing aliased paths with alias objects in _child_aliases
-                alias_obj = self._child_aliases[name] = _create_child(
+                alias_obj = self._child_alias_objs[name] = _create_child(
                     obj.__class__, None, obj.parent, alias
                 )
-                return alias_obj
-            return alias
+            return alias_obj
         try:
-            return super().__getattribute__(name)
+            attr = super().__getattribute__(name)
+            if name in super().__getattribute__("_child_classes"):
+                attr._check_stable()
+            return attr
         except AttributeError as ex:
             self._get_parent_of_active_child_names(name)
             error_msg = allowed_name_error_message(
@@ -1178,7 +1237,7 @@ class NamedObject(SettingsBase[DictStateType], Generic[ChildTypeT]):
                 self._create_child_object(name)
 
     def __delitem__(self, name: str):
-        with self.while_deleting():
+        with self._while_deleting():
             self.flproxy.delete(self.path, name)
         if name in self._objects:
             del self._objects[name]
@@ -1264,14 +1323,13 @@ class NamedObject(SettingsBase[DictStateType], Generic[ChildTypeT]):
     def __getattr__(self, name: str):
         alias = self._child_aliases.get(name)
         if alias:
-            if isinstance(alias, str):
+            alias_obj = self._child_alias_objs.get(name)
+            if alias_obj is None:
                 obj = self.find_object(alias)
-                # replacing aliased paths with alias objects in _child_aliases
-                alias_obj = self._child_aliases[name] = _create_child(
+                alias_obj = self._child_alias_objs[name] = _create_child(
                     obj.__class__, None, obj.parent, alias
                 )
-                return alias_obj
-            return alias
+            return alias_obj
         else:
             return getattr(super(), name)
 
@@ -1288,7 +1346,7 @@ def _rename(obj: Union[NamedObject, _Alias], new: str, old: str):
     old : str
         Current name.
     """
-    with obj.while_renaming():
+    with obj._while_renaming():
         obj.flproxy.rename(obj.path, new, old)
     if old in obj._objects:
         del obj._objects[old]
@@ -1382,14 +1440,13 @@ class ListObject(SettingsBase[ListStateType], Generic[ChildTypeT]):
     def __getattr__(self, name: str):
         alias = self._child_aliases.get(name)
         if alias:
-            if isinstance(alias, str):
+            alias_obj = self._child_alias_objs.get(name)
+            if alias_obj is None:
                 obj = self.find_object(alias)
-                # replacing aliased paths with alias objects in _child_aliases
-                alias_obj = self._child_aliases[name] = _create_child(
+                alias_obj = self._child_alias_objs[name] = _create_child(
                     obj.__class__, None, obj.parent, alias
                 )
-                return alias_obj
-            return alias
+            return alias_obj
         else:
             return getattr(super(), name)
 
@@ -1461,20 +1518,22 @@ class Action(Base):
     def __getattr__(self, name: str):
         alias = self._child_aliases.get(name)
         if alias:
-            if isinstance(alias, str):
+            alias_obj = self._child_alias_objs.get(name)
+            if alias_obj is None:
                 obj = self.find_object(alias)
-                # replacing aliased paths with alias objects in _child_aliases
-                alias_obj = self._child_aliases[name] = _create_child(
+                alias_obj = self._child_alias_objs[name] = _create_child(
                     obj.__class__, None, obj.parent, alias
                 )
-                return alias_obj
-            return alias
+            return alias_obj
         else:
             return getattr(super(), name)
 
 
 class BaseCommand(Action):
+    """Executes command."""
+
     def execute_command(self, *args, **kwds):
+        """Execute command."""
         for arg, value in kwds.items():
             argument = getattr(self, arg)
             argument.before_execute(value)
@@ -1512,7 +1571,7 @@ class Command(BaseCommand):
                         print("Enter y[es]/n[o]")
                 if response in ["n", "N", "no"]:
                     return
-        with self.while_executing_command():
+        with self._while_executing_command():
             return self.flproxy.execute_cmd(self._parent.path, self.obj_name, **newkwds)
 
     def __call__(self, **kwds):
@@ -1539,7 +1598,7 @@ class CommandWithPositionalArgs(BaseCommand):
                         print("Enter y[es]/n[o]")
                 if response in ["n", "N", "no"]:
                     return
-        with self.while_executing_command():
+        with self._while_executing_command():
             return self.flproxy.execute_cmd(self._parent.path, self.obj_name, **newkwds)
 
     def __call__(self, *args, **kwds):
@@ -1659,13 +1718,13 @@ class _CreatableNamedObjectMixin(collections.abc.MutableMapping, Generic[ChildTy
         Object
             Object that has been created.
         """
-        with self.while_creating():
+        with self._while_creating():
             self.flproxy.create(self.path, name)
         return self._create_child_object(name)
 
     def __setitem__(self, name: str, value):
         if name not in self.get_object_names():
-            with self.while_creating():
+            with self._while_creating():
                 self.flproxy.create(self.path, name)
         child = self._objects.get(name)
         if not child:
@@ -1875,7 +1934,6 @@ def _gethash(obj_info):
     return dhash.hexdigest()
 
 
-# pylint: disable=missing-raises-doc
 def get_root(
     flproxy,
     version: str = "",
@@ -1888,6 +1946,17 @@ def get_root(
     ----------
     flproxy: Proxy
         Object that interfaces with the Fluent backend.
+    file_transfer_service : optional
+        File transfer service. Uploads/downloads files to/from the server.
+    scheme_eval : Any
+        A gRPC service to execute Scheme code.
+    version : str
+        Fluent version.
+
+    Raises
+    ------
+    RuntimeError
+        If hash values are inconsistent.
 
     Returns
     -------
@@ -1911,7 +1980,7 @@ def get_root(
         cls, _ = get_cls("", obj_info, version=version)
     root = cls()
     root.set_flproxy(flproxy)
-    root.set_file_transfer_service(file_transfer_service)
+    root._set_file_transfer_service(file_transfer_service)
     _Alias.scheme_eval = scheme_eval
     root._setattr("_static_info", obj_info)
     root._setattr("_file_transfer_service", file_transfer_service)

ansys/fluent/core/solver/flunits.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 """Module for accessing Fluent units labels per quantity type.
 
 Example
@@ -103,6 +101,8 @@ Unhandled:
  'wave-length': 'Angstrom'}
 """
 
+from __future__ import annotations
+
 from typing import Optional
 
 _fl_unit_table = {
@@ -219,6 +219,8 @@ _fl_unit_table = {
 
 
 class InvalidQuantityType(TypeError):
+    """Raised on an attempt to get a Quantity with invalid type."""
+
     def __init__(
         self,
         quantity,
@@ -229,6 +231,8 @@ class InvalidQuantityType(TypeError):
 
 
 class UnitsNotDefinedForQuantity(ValueError):
+    """Raised on an attempt to get undefined units for the specified Quantity."""
+
     def __init__(
         self,
         quantity: str,
@@ -239,6 +243,8 @@ class UnitsNotDefinedForQuantity(ValueError):
 
 
 class UnhandledQuantity(RuntimeError):
+    """Raised on an attempt to get an unhandled Quantity."""
+
     def __init__(
         self,
         path: str,

ansys/fluent/core/solver/function/reduction.py

@@ -64,6 +64,8 @@ from numpy import array
 
 
 class BadReductionRequest(Exception):
+    """Raised on an attempt to make a bad reduction request."""
+
     def __init__(self, err):
         """__init__ method of BadReductionRequest class."""
         super().__init__(f"Could not complete reduction function request: {err}")
@@ -258,14 +260,17 @@ class _Vector:
 
     @property
     def x(self):
+        """Get X vector."""
         return self.array[0]
 
     @property
     def y(self):
+        """Get Y vector."""
         return self.array[1]
 
     @property
     def z(self):
+        """Get Z vector."""
         return self.array[2]
 
 

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 = "8cfb9f8cb00d0dcc187ef81e554dfdbfad1d69951eed31348358a0e3907ec9c7"
+SHASH = "5d4d7352ed86930fd93f62053dd2ad4472eea398bb68d92f9e3a437a902f6266"
 from .root import root

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

@@ -26,15 +26,15 @@ class abaqus(Command):
     Parameters
     ----------
         file_name : str
-            'file_name' child.
+            Enter the desired file name to export.
         surface_name_list : typing.List[str]
-            Select surface.
+            List of surfaces to export.
         structural_analysis : bool
-            'structural_analysis' child.
+            Choose whether structural analysis or not.
         write_loads : bool
-            'write_loads' child.
+            Choose whether or not to write loads.
         loads : typing.List[str]
-            'loads' child.
+            Choose the structural loads type to export.
     
     """
 

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

@@ -14,8 +14,8 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option_9 import option as option_cls
-from .value_10 import value as value_cls
+from .option_10 import option as option_cls
+from .value_11 import value as value_cls
 from .piecewise_linear_2 import piecewise_linear as piecewise_linear_cls
 from .piecewise_polynomial import piecewise_polynomial as piecewise_polynomial_cls
 from .polynomial_2 import polynomial as polynomial_cls

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

@@ -14,8 +14,8 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option_9 import option as option_cls
-from .value_10 import value as value_cls
+from .option_10 import option as option_cls
+from .value_11 import value as value_cls
 from .piecewise_linear_2 import piecewise_linear as piecewise_linear_cls
 from .piecewise_polynomial import piecewise_polynomial as piecewise_polynomial_cls
 from .polynomial_2 import polynomial as polynomial_cls

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

@@ -14,7 +14,7 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option_10 import option as option_cls
+from .option_11 import option as option_cls
 from .value_12 import value as value_cls
 from .profile_name import profile_name as profile_name_cls
 from .field_name import field_name as field_name_cls

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

@@ -14,7 +14,7 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option_18 import option as option_cls
+from .option_20 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):

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

@@ -14,8 +14,8 @@ from ansys.fluent.core.solver.flobject import (
     _InOutFile,
 )
 
-from .option_9 import option as option_cls
-from .value_10 import value as value_cls
+from .option_10 import option as option_cls
+from .value_11 import value as value_cls
 class acentric_factor(Group):
     """
     'acentric_factor' child.

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

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class activate_env_ground(Boolean):
     """
-    Show a ground plane.
+    Choose whether or not the displayed object's location in the environment is fixed, so its location appears consistent as the object is rotated.
     """
 
     fluent_name = "activate-env-ground?"

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

@@ -16,7 +16,7 @@ from ansys.fluent.core.solver.flobject import (
 
 class activate_env_ground_shadow(Boolean):
     """
-    Show a ground plane.
+    Choose whether or not the displayed objects cast a shadow based on the environment lighting.
     """
 
     fluent_name = "activate-env-ground-shadow?"

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

@@ -15,7 +15,7 @@ from ansys.fluent.core.solver.flobject import (
 )
 
 from .method_4 import method as method_cls
-from .value_1 import value as value_cls
+from .value_2 import value as value_cls
 from .user_defined import user_defined as user_defined_cls
 class activity_term(Group):
     """