ansys-fluent-core 0.27.dev1__py3-none-any.whl → 0.28.dev0__py3-none-any.whl

ansys/fluent/core/solver/flunits.py

@@ -7,61 +7,62 @@ Example
 The following code is employed to translate the source data
 into Python data structures:
 
-from ansys.fluent.core.filereader import lispy
-from ansys.units import Quantity, Unit
-from ansys.units.quantity import get_si_value
-import re
-from pprint import pprint
-
-fl_unit_re_subs = {
-    'deg': 'radian',
-    'rad': 'radian',
-    'Ohm': 'ohm'
-}
-
-fl_unit_subs = {'%': ''}
-
-def replace_units(match):
-    return fl_unit_re_subs[match.group(0)]
-
-def substitute_fl_units_with_py_units(fl_units_dict):
-    subs = {}
-    for k, v in fl_units_dict.items():
-        new_val = re.sub('|'.join(r'\b%s\b' % re.escape(s) for s in fl_unit_re_subs), replace_units, v)
-        if new_val != v:
-            subs[k] = new_val
-        else:
-            new_val = fl_unit_subs.get(v, None)
-            if new_val is not None:
-                subs[k] = new_val
-    print("Substitutions:")
-    for k, v in subs.items():
-        print(f"'{fl_units_dict[k]}' -> '{v}' for '{k}'")
-    fl_units_dict.update(subs)
-    return fl_units_dict
-
-def remove_unhandled_units(fl_units_dict):
-    not_si = {}
-    unhandled = {}
-    for k, v in fl_units_dict.items():
-        try:
-            Unit(v)
-            q = Quantity(1.0, v)
-            if get_si_value(q) != 1.0:
-                not_si[k] = v
-        except Exception:
-            unhandled[k] = v
-    print("Not SI:")
-    pprint(not_si)
-    print("Unhandled:")
-    pprint(unhandled)
-    [fl_units_dict.pop(key) for key in list(not_si) + list(unhandled)]
-    return fl_units_dict
-
-def make_python_fl_unit_table(scheme_unit_table):
-    as_list = lispy.parse(scheme_unit_table)[1][1]
-    as_dict = { x[0]:x[1][3].split('"')[1] for x in as_list }
-    return remove_unhandled_units(substitute_fl_units_with_py_units(as_dict))
+>>> from ansys.fluent.core.filereader import lispy
+>>> from ansys.units import Quantity, Unit
+>>> from ansys.units.quantity import get_si_value
+>>> import re
+>>> from pprint import pprint
+>>>
+>>> fl_unit_re_subs = {
+...     'deg': 'radian',
+...     'rad': 'radian',
+...     'Ohm': 'ohm'
+... }
+>>>
+>>> fl_unit_subs = {'%': ''}
+>>>
+>>> def replace_units(match):
+...     return fl_unit_re_subs[match.group(0)]
+...
+>>> def substitute_fl_units_with_py_units(fl_units_dict):
+...     subs = {}
+...     for k, v in fl_units_dict.items():
+...         new_val = re.sub('|'.join(r'\b%s\b' % re.escape(s) for s in fl_unit_re_subs), replace_units, v)
+...         if new_val != v:
+...             subs[k] = new_val
+...         else:
+...             new_val = fl_unit_subs.get(v, None)
+...             if new_val is not None:
+...                 subs[k] = new_val
+...     print("Substitutions:")
+...     for k, v in subs.items():
+...         print(f"'{fl_units_dict[k]}' -> '{v}' for '{k}'")
+...     fl_units_dict.update(subs)
+...     return fl_units_dict
+...
+>>> def remove_unhandled_units(fl_units_dict):
+...     not_si = {}
+...     unhandled = {}
+...     for k, v in fl_units_dict.items():
+...         try:
+...             Unit(v)
+...             q = Quantity(1.0, v)
+...             if get_si_value(q) != 1.0:
+...                 not_si[k] = v
+...         except Exception:
+...             unhandled[k] = v
+...     print("Not SI:")
+...     pprint(not_si)
+...     print("Unhandled:")
+...     pprint(unhandled)
+...     [fl_units_dict.pop(key) for key in list(not_si) + list(unhandled)]
+...     return fl_units_dict
+...
+>>> def make_python_fl_unit_table(scheme_unit_table):
+...     as_list = lispy.parse(scheme_unit_table)[1][1]
+...     as_dict = { x[0]:x[1][3].split('"')[1] for x in as_list }
+...     return remove_unhandled_units(substitute_fl_units_with_py_units(as_dict))
+...
 
 Output from most recent run to generate the table below:
 
@@ -103,6 +104,8 @@ Unhandled:
 
 from __future__ import annotations
 
+from typing import TypeVar
+
 _fl_unit_table = {
     "acceleration": "m s^-2",
     "angle": "radian",
@@ -223,6 +226,7 @@ class InvalidQuantityType(TypeError):
         self,
         quantity,
     ) -> None:
+        """Initialize InvalidQuantityType."""
         super().__init__(
             f"The specified quantity, '{quantity}' is not a string ({type(quantity)})."
         )
@@ -235,19 +239,24 @@ class UnitsNotDefinedForQuantity(ValueError):
         self,
         quantity: str,
     ) -> None:
+        """Initialize UnitsNotDefinedForQuantity."""
         super().__init__(
             f"The units for the specified quantity, '{quantity}' are not defined in PyFluent."
         )
 
 
+QuantityT = TypeVar("QuantityT")
+
+
 class UnhandledQuantity(RuntimeError):
     """Raised on an attempt to get an unhandled Quantity."""
 
     def __init__(
         self,
         path: str,
-        quantity: Quantity,
+        quantity: QuantityT,
     ) -> None:
+        """Initialize UnhandledQuantity."""
         super().__init__(
             f"Could not handle the quantity, '{quantity}' for the path, {path}."
         )

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

@@ -6,7 +6,7 @@ expr parameter is not relevant to all reductions functions.
 
 Parameters
 ----------
-expr : Any
+expression : Any
     Expression that can be either a string or an
     instance of a specific settings API named_expressions
     object. The expression can be a field variable or a
@@ -197,7 +197,7 @@ def _extent_expression(
             numerator += val * extent
             denominator += extent
         except TypeError:
-            if type(val) == list:
+            if isinstance(val, list):
                 numerator += np.multiply(val, extent)
                 denominator += extent
             else:
@@ -217,7 +217,7 @@ def _extent_moment_vector(f_string, expr, locations, ctxt):
             total += array(extent)
         except TypeError:
             raise RuntimeError(extent)
-    return _Vector(total)
+    return tuple(total)
 
 
 def _extent_average(extent_name, expr, locations, ctxt):
@@ -251,27 +251,7 @@ def _extent_vectors(extent_name, locations, ctxt):
             total += array(extent)
         except TypeError:
             raise RuntimeError(extent)
-    return _Vector(total)
-
-
-class _Vector:
-    def __init__(self, np_arr):
-        self.array = np_arr
-
-    @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]
+    return tuple(total)
 
 
 def _limit(limit, expr, locations, ctxt):
@@ -401,7 +381,7 @@ def centroid(locations, ctxt=None):
     ctxt : Any, optional
     Returns
     -------
-    float
+    tuple
     """
     return _extent_vectors("Centroid", locations, ctxt)
 
@@ -416,7 +396,7 @@ def force(locations, ctxt=None):
     ctxt : Any, optional
     Returns
     -------
-    float
+    tuple
     """
     return _extent_vectors("Force", locations, ctxt)
 
@@ -431,7 +411,7 @@ def pressure_force(locations, ctxt=None):
     ctxt : Any, optional
     Returns
     -------
-    float
+    tuple
     """
     return _extent_vectors("PressureForce", locations, ctxt)
 
@@ -446,7 +426,7 @@ def viscous_force(locations, ctxt=None):
     ctxt : Any, optional
     Returns
     -------
-    float
+    tuple
     """
     return _extent_vectors("ViscousForce", locations, ctxt)
 
@@ -462,7 +442,7 @@ def moment(expression, locations, ctxt=None):
     ctxt : Any, optional
     Returns
     -------
-    float
+    tuple
     """
     return _extent_moment_vector("Moment", expression, locations, ctxt)
 

ansys/fluent/core/solver/settings_builtin_bases.py

@@ -2,7 +2,7 @@
 
 from typing import Protocol, runtime_checkable
 
-from ansys.fluent.core.solver.flobject import SettingsBase
+from ansys.fluent.core.solver.flobject import NamedObject, SettingsBase
 from ansys.fluent.core.solver.settings_builtin_data import DATA
 from ansys.fluent.core.utils.fluent_version import FluentVersion
 
@@ -28,55 +28,60 @@ def _get_settings_root(settings_source: SettingsBase | Solver):
         )
 
 
-def _get_settings_obj(settings_source: SettingsBase | Solver, cls_name: str):
-    obj = _get_settings_root(settings_source)
-    path = DATA[cls_name][1]
+def _get_settings_obj(settings_root, builtin_settings_obj):
+    builtin_cls_name = builtin_settings_obj.__class__.__name__
+    obj = settings_root
+    path = DATA[builtin_cls_name][1]
     if isinstance(path, dict):
         version = FluentVersion(obj.version)
         path = path.get(version)
         if path is None:
             raise RuntimeError(
-                f"{cls_name} is not supported in Fluent version {version}."
+                f"{builtin_cls_name} is not supported in Fluent version {version}."
             )
-    for comp in path.split("."):
+    comps = path.split(".")
+    for i, comp in enumerate(comps):
         obj = SettingsBase.__getattribute__(obj, comp)  # bypass InactiveObjectError
+        if i < len(comps) - 1 and isinstance(obj, NamedObject):
+            obj_name = getattr(builtin_settings_obj, comp)
+            obj = obj[obj_name]
     return obj
 
 
 class _SingletonSetting:
     # Covers both groups and named-object containers
-    def __init__(self, settings_source: SettingsBase | Solver | None = None):
-        self.__dict__.update(dict(settings_source=None))
+    def __init__(self, settings_source: SettingsBase | Solver | None = None, **kwargs):
+        self.__dict__.update(dict(settings_source=None) | kwargs)
         if settings_source is not None:
             self.settings_source = settings_source
 
     def __setattr__(self, name, value):
         if name == "settings_source":
-            obj = _get_settings_obj(value, self.__class__.__name__)
+            settings_root = _get_settings_root(value)
+            obj = _get_settings_obj(settings_root, self)
             self.__class__ = obj.__class__
             self.__dict__.clear()
-            self.__dict__.update(
-                obj.__dict__ | dict(settings_source=_get_settings_root(value))
-            )
+            self.__dict__.update(obj.__dict__ | dict(settings_source=settings_root))
         else:
             super().__setattr__(name, value)
 
 
 class _NonCreatableNamedObjectSetting:
-    def __init__(self, name: str, settings_source: SettingsBase | Solver | None = None):
-        self.__dict__.update(dict(settings_source=None, name=name))
+    def __init__(
+        self, name: str, settings_source: SettingsBase | Solver | None = None, **kwargs
+    ):
+        self.__dict__.update(dict(settings_source=None, name=name) | kwargs)
         if settings_source is not None:
             self.settings_source = settings_source
 
     def __setattr__(self, name, value):
         if name == "settings_source":
-            obj = _get_settings_obj(value, self.__class__.__name__)
+            settings_root = _get_settings_root(value)
+            obj = _get_settings_obj(settings_root, self)
             obj = obj[self.name]
             self.__class__ = obj.__class__
             self.__dict__.clear()
-            self.__dict__.update(
-                obj.__dict__ | dict(settings_source=_get_settings_root(value))
-            )
+            self.__dict__.update(obj.__dict__ | dict(settings_source=settings_root))
         else:
             super().__setattr__(name, value)
 
@@ -87,18 +92,21 @@ class _CreatableNamedObjectSetting:
         settings_source: SettingsBase | Solver | None = None,
         name: str | None = None,
         new_instance_name: str | None = None,
+        **kwargs,
     ):
         if name and new_instance_name:
             raise ValueError("Cannot specify both name and new_instance_name.")
         self.__dict__.update(
             dict(settings_source=None, name=name, new_instance_name=new_instance_name)
+            | kwargs
         )
         if settings_source is not None:
             self.settings_source = settings_source
 
     def __setattr__(self, name, value):
         if name == "settings_source":
-            obj = _get_settings_obj(value, self.__class__.__name__)
+            settings_root = _get_settings_root(value)
+            obj = _get_settings_obj(settings_root, self)
             if self.name:
                 obj = obj[self.name]
             elif self.new_instance_name:
@@ -107,8 +115,6 @@ class _CreatableNamedObjectSetting:
                 obj = obj.create()
             self.__class__ = obj.__class__
             self.__dict__.clear()
-            self.__dict__.update(
-                obj.__dict__ | dict(settings_source=_get_settings_root(value))
-            )
+            self.__dict__.update(obj.__dict__ | dict(settings_source=settings_root))
         else:
             super().__setattr__(name, value)