feat: Move the direct settings classes under ansys.fluent.core.solver…

… namespace (#3572)

Co-authored-by: Prithwish Mukherjee <[email protected]>

doc/source/user_guide/solver_settings/index.rst

@@ -100,23 +100,23 @@ as a dictionary for ``Group`` and ``NamedObject`` types or as a list for ``ListO
 .. code-block::
 
   >>> import ansys.fluent.core as pyfluent
-  >>> viscous = pyfluent.Viscous(settings_source=solver)
+  >>> viscous = pyfluent.solver.Viscous(settings_source=solver)
   >>> viscous.model()
   'k-epsilon-standard'
 
 
 .. code-block::
 
   >>> import ansys.fluent.core as pyfluent
-  >>> energy = pyfluent.Energy(settings_source=solver)
+  >>> energy = pyfluent.solver.Energy(settings_source=solver)
   >>> from pprint import pprint
   >>> pprint (energy(), width=1)
   {'enabled': True,
    'inlet_diffusion': True,
    'kinetic_energy': False,
    'pressure_work': False,
    'viscous_dissipation': False}
-  >>> inlet1 = pyfluent.VelocityInlet(settings_source=solver, name="inlet1")
+  >>> inlet1 = pyfluent.solver.VelocityInlet(settings_source=solver, name="inlet1")
   >>> inlet1.vmag.constant()
   10.0
 
@@ -129,11 +129,11 @@ and ``NamedObject`` types, the state value is a dictionary. For the
 .. code-block::
 
   >>> import ansys.fluent.core as pyfluent
-  >>> viscous = pyfluent.Viscous(settings_source=solver)
+  >>> viscous = pyfluent.solver.Viscous(settings_source=solver)
   >>> viscous.model = 'laminar'
-  >>> energy = pyfluent.Energy(settings_source=solver)
+  >>> energy = pyfluent.solver.Energy(settings_source=solver)
   >>> energy = { 'enabled' : False }
-  >>> inlet1 = pyfluent.VelocityInlet(settings_source=solver, name="inlet1")
+  >>> inlet1 = pyfluent.solver.VelocityInlet(settings_source=solver, name="inlet1")
   >>> inlet1.vmag.constant = 14
 
 
@@ -165,7 +165,7 @@ You can print the current state in a simple text format with the
 .. code-block::
 
   >>> import ansys.fluent.core as pyfluent
-  >>> models = pyfluent.Models(settings_source=solver)
+  >>> models = pyfluent.solver.Models(settings_source=solver)
   >>> models.print_state()
 
 
@@ -219,23 +219,23 @@ for that object or returns ``None`` otherwise.
 .. code-block::
 
   >>> import ansys.fluent.core as pyfluent
-  >>> viscous = pyfluent.Viscous(settings_source=solver)
+  >>> viscous = pyfluent.solver.Viscous(settings_source=solver)
   >>> viscous.model.allowed_values()
   ['inviscid', 'laminar', 'k-epsilon-standard', 'k-omega-standard', 'mixing-length', 'spalart-allmaras', 'k-kl-w', 'transition-sst', 'reynolds-stress', 'scale-adaptive-simulation', 'detached-eddy-simulation', 'large-eddy-simulation']
 
 
 .. code-block::
 
   >>> import ansys.fluent.core as pyfluent
-  >>> viscous = pyfluent.Viscous(settings_source=solver)
+  >>> viscous = pyfluent.solver.Viscous(settings_source=solver)
   >>> viscous.model.get_attr('allowed-values')
   ['inviscid', 'laminar', 'k-epsilon-standard', 'k-omega-standard', 'mixing-length', 'spalart-allmaras', 'k-kl-w', 'transition-sst', 'reynolds-stress', 'scale-adaptive-simulation', 'detached-eddy-simulation', 'large-eddy-simulation']
 
 
 .. code-block::
 
   >>> import ansys.fluent.core as pyfluent
-  >>> viscous = pyfluent.Viscous(settings_source=solver)
+  >>> viscous = pyfluent.solver.Viscous(settings_source=solver)
   >>> viscous.model.get_attrs(['allowed-values'])
   {'allowed-values': ['inviscid', 'laminar', 'k-epsilon', 'k-omega', 'mixing-length', 'spalart-allmaras', 'k-kl-w', 'transition-sst', 'reynolds-stress', 'scale-adaptive-simulation', 'detached-eddy-simulation', 'large-eddy-simulation']}
 
@@ -303,7 +303,7 @@ in a single solver session:
   >>> solver.settings.file.read(file_type="case", file_name=import_file_name)
   Fast-loading...
   ...Done
-  >>> viscous = pyfluent.Viscous(settings_source=solver)
+  >>> viscous = pyfluent.solver.Viscous(settings_source=solver)
   >>> viscous.is_active()
   True
   >>> viscous.model.is_read_only()
@@ -322,7 +322,7 @@ in a single solver session:
    'scale-adaptive-simulation',
    'detached-eddy-simulation',
    'large-eddy-simulation']
-  >>> cold_inlet = pyfluent.VelocityInlet(settings_source=solver, name="cold-inlet")
+  >>> cold_inlet = pyfluent.solver.VelocityInlet(settings_source=solver, name="cold-inlet")
   >>> cold_inlet.turb_intensity.min()
   0
   >>> cold_inlet.turb_intensity.max()
@@ -339,7 +339,7 @@ The ``get_active_child_names()`` method returns a list of
 active children::
 
   >>> import ansys.fluent.core as pyfluent
-  >>> models = pyfluent.Models(settings_source=solver)
+  >>> models = pyfluent.solver.Models(settings_source=solver)
   >>> models.get_active_child_names()
   ['energy', 'multiphase', 'viscous']
 
@@ -355,14 +355,14 @@ You can use wildcards when using named objects, list objects, and string list se
 For named objects and list objects, for instance::
 
   >>> import ansys.fluent.core as pyfluent
-  >>> fluid = pyfluent.FluidCellZone(settings_source=solver, name="*")
+  >>> fluid = pyfluent.solver.FluidCellZone(settings_source=solver, name="*")
   >>> fluid.source_terms["*mom*"]()
   {'fluid': {'source_terms': {'x-momentum': [], 'y-momentum': [], 'z-momentum': []}}}
 
 Also, when you have one or more velocity inlets with "inlet" in their names::
 
   >>> import ansys.fluent.core as pyfluent
-  >>> inlet = pyfluent.VelocityInlet(settings_source=solver, name="*inlet*")
+  >>> inlet = pyfluent.solver.VelocityInlet(settings_source=solver, name="*inlet*")
   >>> inlet.vmag()
   {'velo-inlet_2': {'vmag': {'option': 'value', 'value': 50}},
   'velo-inlet_1': {'vmag': {'option': 'value', 'value': 35}}

examples/00-fluent/species_transport.py

@@ -70,7 +70,8 @@
 
 from pathlib import Path  # noqa: E402
 
-from ansys.fluent.core import (  # noqa: E402
+from ansys.fluent.core.examples import download_file  # noqa: E402
+from ansys.fluent.core.solver import (  # noqa: E402
     Contour,
     Energy,
     Mesh,
@@ -82,7 +83,6 @@
     Viscous,
     WallBoundary,
 )
-from ansys.fluent.core.examples import download_file  # noqa: E402
 
 # %%
 # Mesh

src/ansys/fluent/core/__init__.py

@@ -41,11 +41,6 @@
     warning,
 )
 
-try:
-    from ansys.fluent.core.generated.solver.settings_builtin import *  # noqa: F401, F403
-except (ImportError, AttributeError, SyntaxError):
-    pass
-
 _VERSION_INFO = None
 """Global variable indicating the version of the PyFluent package - Empty by default"""
 

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

@@ -0,0 +1,6 @@
+"""The top-level module of PyFluent providing solver-related functionality."""
+
+try:
+    from ansys.fluent.core.generated.solver.settings_builtin import *  # noqa: F401, F403
+except (ImportError, AttributeError, SyntaxError):
+    pass

src/ansys/fluent/core/solver/settings_builtin_data.py

@@ -1,6 +1,6 @@
 """Data for for builtin setting classes."""
 
-from ansys.fluent.core import FluentVersion
+from ansys.fluent.core.utils.fluent_version import FluentVersion
 
 # {<class name>: (<kind>, <path>)}
 DATA = {

tests/test_builtin_settings.py

@@ -4,7 +4,7 @@
 import pytest
 
 try:
-    from ansys.fluent.core import (
+    from ansys.fluent.core.solver import (
         Ablation,
         Battery,
         BoundaryCondition,