ansys-fluent-core 0.31.dev1__py3-none-any.whl → 0.31.1__py3-none-any.whl

ansys/fluent/core/solver/flobject.py

@@ -74,6 +74,9 @@ from ansys.fluent.core.pyfluent_warnings import (
     PyFluentUserWarning,
 )
 from ansys.fluent.core.utils.fluent_version import FluentVersion
+from ansys.fluent.core.variable_strategies import (
+    FluentFieldDataNamingStrategy as naming_strategy,
+)
 
 from . import _docstrings
 from .error_message import allowed_name_error_message, allowed_values_error
@@ -196,6 +199,9 @@ def to_python_name(fluent_name: str) -> str:
     return name
 
 
+_to_field_name_str = naming_strategy().to_string if naming_strategy else lambda s: s
+
+
 def _get_python_path_comps(obj):
     """Get python path components for traversing class hierarchy."""
     comps = []
@@ -628,6 +634,18 @@ class RealNumerical(Numerical):
 class Textual(Property):
     """Exposes attribute accessor on settings object - specific to string objects."""
 
+    def set_state(self, state: StateT | None = None, **kwargs):
+        """Set the state of the object.
+
+        Parameters
+        ----------
+        state
+            Either str or VariableDescriptor.
+        kwargs : Any
+            Keyword arguments.
+        """
+        return self.base_set_state(state=_to_field_name_str(state), **kwargs)
+
 
 class DeprecatedSettingWarning(PyFluentDeprecationWarning):
     """Provides deprecated settings warning."""
@@ -853,6 +871,9 @@ class String(SettingsBase[str], Textual):
 
     _state_type = str
 
+    base_set_state = SettingsBase[str].set_state
+    set_state = Textual.set_state
+
 
 class Filename(SettingsBase[str], Textual):
     """A ``Filename`` object representing a file name."""
@@ -1164,6 +1185,10 @@ class Group(SettingsBase[DictStateType]):
             raise
 
     def __setattr__(self, name: str, value):
+        # 'settings_source' will be set to settings object when they are created from builtin settings classes.
+        # We don't allow overwriting it.
+        if name == "settings_source":
+            raise AttributeError("Cannot overwrite settings_source after it is set.")
         attr = None
         try:
             attr = getattr(self, name)
@@ -2103,6 +2128,9 @@ def get_cls(name, info, parent=None, version=None, parent_taboo=None):
         dct["_child_classes"] = {}
         cls = type(pname, bases, dct)
 
+        deprecated_version = info.get("deprecated_version", "")
+        cls._deprecated_version = deprecated_version
+
         taboo = set(dir(cls))
         taboo |= set(
             [

ansys/fluent/core/utils/deprecate.py

@@ -23,14 +23,60 @@
 """Module that provides a method to handle deprecated arguments."""
 
 import functools
+from functools import wraps
 import logging
 import warnings
 
+from deprecated.sphinx import deprecated
+
 from ansys.fluent.core.pyfluent_warnings import PyFluentDeprecationWarning
 
 logger = logging.getLogger("pyfluent.general")
 
 
+def all_deprecators(
+    deprecate_arg_mappings,
+    data_type_converter,
+    deprecated_version,
+    deprecated_reason,
+    warn_message,
+):
+    """Decorator that applies multiple deprecators to a function."""
+
+    def decorator(func):
+        decorated = func
+        for mapping in deprecate_arg_mappings:
+            decorated = deprecate_argument(
+                old_arg=mapping["old_arg"],
+                new_arg=mapping["new_arg"],
+                converter=mapping.get("converter", lambda x: x),
+                warning_cls=PyFluentDeprecationWarning,
+            )(decorated)
+        if data_type_converter:
+            decorated = deprecate_arguments(
+                converter=data_type_converter,
+                warning_cls=PyFluentDeprecationWarning,
+            )(decorated)
+        decorated = deprecated(
+            version=deprecated_version,
+            reason=deprecated_reason,
+        )(decorated)
+
+        @wraps(decorated)
+        def wrapper(*args, **kwargs):
+            if warn_message:
+                warnings.warn(
+                    warn_message,
+                    PyFluentDeprecationWarning,
+                    stacklevel=2,
+                )
+            return decorated(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
 def deprecate_argument(
     old_arg,
     new_arg,

ansys/fluent/core/utils/file_transfer_service.py

@@ -31,7 +31,7 @@ import warnings
 
 from ansys.fluent.core.pyfluent_warnings import PyFluentUserWarning
 from ansys.fluent.core.utils import get_user_data_dir
-from ansys.fluent.core.utils.deprecate import deprecate_argument
+from ansys.fluent.core.utils.deprecate import all_deprecators
 import ansys.platform.instancemanagement as pypim
 
 # Host path which is mounted to the file-transfer-service container
@@ -229,8 +229,24 @@ class ContainerFileTransferStrategy(FileTransferStrategy):
     >>> solver_session.download(file_name="write_elbow.cas.h5", local_directory="<local_directory_path>")
     """
 
-    @deprecate_argument("container_mount_path", "mount_target")
-    @deprecate_argument("host_mount_path", "mount_source")
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "container_mount_path",
+                "new_arg": "mount_target",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+            {
+                "old_arg": "host_mount_path",
+                "new_arg": "mount_source",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.23.dev1",
+        deprecated_reason="'container_mount_path' and 'host_mount_path' are deprecated. Use 'mount_target' and 'mount_source' instead.",
+        warn_message="",
+    )
     def __init__(
         self,
         image_name: str | None = None,

ansys/fluent/core/utils/fluent_version.py

@@ -25,6 +25,9 @@
 from enum import Enum
 from functools import total_ordering
 import os
+from pathlib import Path
+import platform
+from typing import Any
 
 import ansys.fluent.core as pyfluent
 
@@ -32,7 +35,19 @@ import ansys.fluent.core as pyfluent
 class AnsysVersionNotFound(RuntimeError):
     """Raised when Ansys version is not found."""
 
-    pass
+    def __init__(self, version: Any):
+        """Initialize VersionNotFound.
+
+        Parameters
+        ----------
+        version : str
+            Version that was not found.
+        """
+        super().__init__(
+            f"The specified version '{version}' is not supported."
+            + " Supported versions are: "
+            + ", ".join([member.value for member in FluentVersion][::-1])
+        )
 
 
 class ComparisonError(RuntimeError):
@@ -74,6 +89,7 @@ class FluentVersion(Enum):
     FluentVersion.v232.awp_var == 'AWP_ROOT232'
     """
 
+    v261 = "26.1.0"
     v252 = "25.2.0"
     v251 = "25.1.0"
     v242 = "24.2.0"
@@ -83,7 +99,7 @@ class FluentVersion(Enum):
     v222 = "22.2.0"
 
     @classmethod
-    def _missing_(cls, version):
+    def _missing_(cls, version: Any):
         if isinstance(version, (int, float, str)):
             version = str(version)
             if len(version) == 3:
@@ -92,11 +108,8 @@ class FluentVersion(Enum):
             for member in cls:
                 if version == member.value:
                     return member
-        raise AnsysVersionNotFound(
-            f"The specified version '{version[:-2]}' is not supported."
-            + " Supported versions are: "
-            + ", ".join([member.value for member in cls][::-1])
-        )
+
+        raise AnsysVersionNotFound(version[:-2])
 
     @classmethod
     def get_latest_installed(cls):
@@ -110,15 +123,33 @@ class FluentVersion(Enum):
 
         Raises
         ------
-        AnsysVersionNotFound
+        FileNotFoundError
             If an Ansys version cannot be found.
         """
         for member in cls:
-            if member.awp_var in os.environ:
+            if member.awp_var in os.environ and member.get_fluent_exe_path().exists():
                 return member
 
-        raise AnsysVersionNotFound(
-            "Verify the value of the 'AWP_ROOT' environment variable."
+        raise FileNotFoundError(
+            "Unable to locate a compatible Ansys Fluent installation. "
+            "Ensure that an environment variable like 'AWP_ROOT242' or 'AWP_ROOT251' "
+            "points to a supported Ansys version, and that Fluent is included in the installation."
+        )
+
+    def get_fluent_exe_path(self) -> Path:
+        """Get the path for the Fluent executable file.
+
+        Returns
+        -------
+        Path
+            Fluent executable path.
+        """
+        awp_root = os.environ[self.awp_var]
+        fluent_root = Path(awp_root) / "fluent"
+        return (
+            fluent_root / "ntbin" / "win64" / "fluent.exe"
+            if platform.system() == "Windows"
+            else fluent_root / "bin" / "fluent"
         )
 
     @classmethod

ansys/fluent/core/variable_strategies/__init__.py

@@ -0,0 +1,29 @@
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Provides ConversionStrategy classes for mapping VariableDescriptor to variable names used in Fluent.
+"""
+
+from .expr import FluentExprNamingStrategy  # noqa: F401
+from .field import FluentFieldDataNamingStrategy  # noqa: F401
+from .svar import FluentSVarNamingStrategy  # noqa: F401

ansys/fluent/core/variable_strategies/expr.py

@@ -0,0 +1,186 @@
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Provides a ConversionStrategy for mapping VariableDescriptor to variable names used in Fluent expressions.
+"""
+
+try:
+    from ansys.units.variable_descriptor import (
+        MappingConversionStrategy,
+        VariableCatalog,
+    )
+except ModuleNotFoundError:
+    MappingConversionStrategy = None
+
+
+if MappingConversionStrategy:
+
+    class FluentExprNamingStrategy(MappingConversionStrategy):
+        """This strategy handles conversion of selected VariableCatalog into Fluent's
+        server-side expression variable naming conventions.
+        """
+
+        _c = VariableCatalog
+
+        _mapping = {
+            # pressure
+            _c.PRESSURE: "StaticPressure",
+            _c.STATIC_PRESSURE: "StaticPressure",
+            _c.ABSOLUTE_PRESSURE: "AbsolutePressure",
+            _c.DYNAMIC_PRESSURE: "DynamicPressure",
+            _c.TOTAL_PRESSURE: "TotalPressure",
+            _c.PRESSURE_COEFFICIENT: "PressureCoefficient",
+            # velocity
+            _c.AXIAL_VELOCITY: "AxialVelocity",
+            _c.CONVECTIVE_COURANT_NUMBER: "ElementConvectionCourantNumber",
+            _c.CELL_REYNOLDS_NUMBER: "ElementReynoldsNumber",
+            _c.fluent.HELICITY: "Helicity",
+            _c.fluent.LAMBDA_2_CRITERION: "Lambda2Criterion",
+            _c.MESH_VELOCITY: "MeshVelocity",
+            _c.MESH_VELOCITY_X: "MeshVelocity.x",
+            _c.MESH_VELOCITY_Y: "MeshVelocity.y",
+            _c.MESH_VELOCITY_Z: "MeshVelocity.z",
+            _c.MESH_VELOCITY_MAGNITUDE: "MeshVelocityMagnitude",
+            _c.NORMALIZED_Q_CRITERION: "QCriterionNormalized",
+            _c.Q_CRITERION: "QCriterionRaw",
+            _c.RADIAL_VELOCITY: "RadialVelocity",
+            _c.TANGENTIAL_VELOCITY: "TangentialVelocity",
+            _c.VELOCITY: "Velocity",
+            _c.VELOCITY_X: "Velocity.x",
+            _c.VELOCITY_Y: "Velocity.y",
+            _c.VELOCITY_Z: "Velocity.z",
+            _c.VELOCITY_MAGNITUDE: "VelocityMagnitude",
+            _c.fluent.VELOCITY_ANGLE: "VelocityAngle",
+            _c.VORTICITY: "Vorticity",
+            _c.VORTICITY_X: "Vorticity.x",
+            _c.VORTICITY_Y: "Vorticity.y",
+            _c.VORTICITY_Z: "Vorticity.z",
+            _c.VORTICITY_MAGNITUDE: "VorticityMagnitude",
+            # density
+            _c.DENSITY: "Density",
+            _c.fluent.DENSITY_ALL: "DensityAll",
+            # "properties"
+            _c.DYNAMIC_VISCOSITY: "DynamicViscosity",
+            _c.PRANDTL_NUMBER: "PrandtlNumber",
+            _c.SPECIFIC_HEAT_CAPACITY: "SpecificHeatCapacity",
+            _c.THERMAL_CONDUCTIVITY: "ThermalConductivity",
+            # turbulence
+            _c.EFFECTIVE_PRANDTL_NUMBER: "EffectivePrandtlNumber",
+            _c.EFFECTIVE_THERMAL_CONDUCTIVITY: "EffectiveThermalConductivity",
+            _c.EFFECTIVE_VISCOSITY: "EffectiveViscosity",
+            _c.PRODUCTION_OF_TURBULENT_KINETIC_ENERGY: "Productionofk",
+            _c.SPECIFIC_DISSIPATION_RATE: "SpecificDissipationRateOmega",
+            _c.TURBULENT_DISSIPATION_RATE: "TurbulenceDissipationRate",
+            _c.TURBULENT_INTENSITY: "TurbulenceIntensity",
+            _c.TURBULENT_VISCOSITY: "TurbulenceViscosity",
+            _c.TURBULENT_VISCOSITY_RATIO: "TurbulenceViscosityRatio",
+            _c.TURBULENT_KINETIC_ENERGY: "TurbulentKineticEnergyk",
+            _c.TURBULENT_REYNOLDS_NUMBER: "TurbulentReynoldsNumberRe_y",
+            _c.WALL_Y_PLUS: "WallYplus",
+            _c.WALL_Y_STAR: "WallYstar",
+            # wall fluxes
+            _c.SURFACE_HEAT_TRANSFER_COEFFICIENT: "HeatTransferCoefficient",
+            _c.SKIN_FRICTION_COEFFICIENT: "SkinFrictionCoefficient",
+            _c.SURFACE_HEAT_FLUX: "SurfaceHeatFlux",
+            _c.SURFACE_HEAT_TRANSFER_COEFFICIENT: "SurfaceHeatTransferCoefficient",
+            _c.SURFACE_NUSSELT_NUMBER: "SurfaceNusseltNumber",
+            _c.SURFACE_STANTON_NUMBER: "SurfaceStantonNumber",
+            _c.WALL_ADJACENT_HEAT_TRANSFER_COEFFICIENT: "WallAdjacentHeatTransferCoef",
+            _c.WALL_SHEAR_STRESS: "WallShearStressVector",
+            _c.WALL_SHEAR_STRESS_X: "WallShearStressVector.x",
+            _c.WALL_SHEAR_STRESS_Y: "WallShearStressVector.y",
+            _c.WALL_SHEAR_STRESS_Z: "WallShearStressVector.z",
+            _c.WALL_SHEAR_STRESS_MAGNITUDE: "WallShearStressVector.mag",
+            _c.fluent.Y_PLUS_BASED_HEAT_TRANSFER_COEFFICIENT: "YplusBasedHeatTranCoef",
+            # residuals
+            _c.fluent.MASS_IMBALANCE: "MassImbalance",
+            # derivatives
+            _c.fluent.PRESSURE_HESSIAN_INDICATOR: "PressureHessianIndicator",
+            _c.STRAIN_RATE: "StrainRate",
+            _c.fluent.DVELOCITY_DX: "dVelocitydx",
+            _c.fluent.DVELOCITY_DX_X: "dVelocitydx.x",
+            _c.fluent.DVELOCITY_DX_Y: "dVelocitydx.y",
+            _c.fluent.DVELOCITY_DX_Z: "dVelocitydx.z",
+            _c.fluent.DVELOCITY_DX_MAGNITUDE: "dVelocitydx.mag",
+            _c.fluent.DVELOCITY_DY: "dVelocitydy",
+            _c.fluent.DVELOCITY_DY_X: "dVelocitydy.x",
+            _c.fluent.DVELOCITY_DY_Y: "dVelocitydy.y",
+            _c.fluent.DVELOCITY_DY_Z: "dVelocitydy.z",
+            _c.fluent.DVELOCITY_DY_MAGNITUDE: "dVelocitydy.mag",
+            _c.fluent.DVELOCITY_DZ: "dVelocitydz",
+            _c.fluent.DVELOCITY_DZ_X: "dVelocitydz.x",
+            _c.fluent.DVELOCITY_DZ_Y: "dVelocitydz.y",
+            _c.fluent.DVELOCITY_DZ_Z: "dVelocitydz.z",
+            _c.fluent.DVELOCITY_DZ_MAGNITUDE: "dVelocitydz.mag",
+            # temperature
+            _c.SPECIFIC_ENTHALPY: "SpecificEnthalpy",
+            _c.SPECIFIC_ENTROPY: "SpecificEntropy",
+            _c.SPECIFIC_INTERNAL_ENERGY: "SpecificInternalEnergy",
+            _c.SPECIFIC_TOTAL_ENERGY: "SpecificTotalEnergy",
+            _c.TEMPERATURE: "StaticTemperature",
+            _c.SPECIFIC_TOTAL_ENTHALPY: "SpecificTotalEnthalpy",
+            _c.fluent.TOTAL_ENTHALPY_DEVIATION: "TotalEnthalpyDeviation",
+            _c.TOTAL_TEMPERATURE: "TotalTemperature",
+            _c.WALL_ADJACENT_TEMPERATURE: "WallAdjacentTemperature",
+            _c.WALL_TEMPERATURE: "WallTemperature",
+            _c.WALL_TEMPERATURE_THIN: "WallTemperatureThin",
+            _c.fluent.Y_PLUS_BASED_HEAT_TRANSFER_COEFFICIENT: "YplusBasedHeatTranRefTemperature",
+            # mesh
+            _c.mesh.ANISOTROPIC_ADAPTION_CELLS: "AnisotropicAdaptionCells",
+            _c.mesh.BOUNDARY_CELL_DISTANCE: "BoundaryCellDistance",
+            _c.mesh.BOUNDARY_LAYER_CELLS: "BoundaryLayerCells",
+            _c.mesh.BOUNDARY_NORMAL_DISTANCE: "BoundaryNormalDistance",
+            _c.mesh.BOUNDARY_VOLUME_DISTANCE: "BoundaryVolumeDistance",
+            _c.mesh.CELL_EQUIANGLE_SKEW: "CellEquiangleSkew",
+            _c.mesh.CELL_EQUIVOLUME_SKEW: "CellEquivolumeSkew",
+            _c.mesh.CELL_PARENT_INDEX: "CellParentIndex",
+            _c.mesh.CELL_REFINE_LEVEL: "CellRefineLevel",
+            _c.mesh.CELL_VOLUME: "CellVolume",
+            _c.mesh.CELL_VOLUME_CHANGE: "CellVolumeChange",
+            _c.mesh.ELEMENT_ASPECT_RATIO: "ElementAspectRatio",
+            _c.mesh.ELEMENT_WALL_DISTANCE: "ElementWallDistance",
+            _c.mesh.FACE_AREA_MAGNITUDE: "FaceAreaMagnitude",
+            _c.mesh.FACE_HANDEDNESS: "FaceHandedness",
+            _c.mesh.INTERFACE_OVERLAP_FRACTION: "InterfaceOverlapFraction",
+            _c.mesh.MARK_POOR_ELEMENTS: "MarkPoorElements",
+            _c.POSITION: "Position",
+            _c.POSITION_X: "Position.x",
+            _c.POSITION_Y: "Position.y",
+            _c.POSITION_Z: "Position.z",
+            _c.POSITION_MAGNITUDE: "Position.mag",
+            _c.mesh.SMOOTHED_CELL_REFINE_LEVEL: "SmoothedCellRefineLevel",
+            _c.mesh.X_FACE_AREA: "XFaceArea",
+            _c.mesh.Y_FACE_AREA: "YFaceArea",
+            _c.mesh.Z_FACE_AREA: "ZFaceArea",
+            _c.mesh.ACTIVE_CELL_PARTITION: "ActiveElementPartition",
+            _c.mesh.CELL_ELEMENT_TYPE: "CellElementType",
+            _c.mesh.CELL_ID: "CellId",
+            _c.mesh.CELL_WEIGHT: "CellWeight",
+            _c.mesh.CELL_ZONE_INDEX: "CellZoneIndex",
+            _c.mesh.CELL_ZONE_TYPE: "CellZoneType",
+            _c.mesh.PARTITION_NEIGHBOURS: "PartitionNeighbors",
+            _c.mesh.STORED_CELL_PARTITIION: "StoredElementPartition",
+        }
+
+else:
+    FluentExprNamingStrategy = None

ansys/fluent/core/variable_strategies/field.py

@@ -0,0 +1,186 @@
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Provides a ConversionStrategy for mapping VariableDescriptor to names used in Fluent's field data API.
+"""
+
+try:
+    from ansys.units.variable_descriptor import (
+        MappingConversionStrategy,
+        VariableCatalog,
+    )
+except ModuleNotFoundError:
+    MappingConversionStrategy = None
+
+
+if MappingConversionStrategy:
+
+    class FluentFieldDataNamingStrategy(MappingConversionStrategy):
+        """This strategy handles conversion of selected
+        VariableCatalog into Fluent's server-side field variable naming conventions.
+        """
+
+        _c = VariableCatalog
+
+        _mapping = {
+            # pressure
+            _c.PRESSURE: "pressure",
+            _c.STATIC_PRESSURE: "pressure",
+            _c.ABSOLUTE_PRESSURE: "absolute-pressure",
+            _c.DYNAMIC_PRESSURE: "dynamic-pressure",
+            _c.TOTAL_PRESSURE: "total-pressure",
+            _c.PRESSURE_COEFFICIENT: "pressure-coefficient",
+            # velocity
+            _c.AXIAL_VELOCITY: "axial-velocity",
+            _c.CONVECTIVE_COURANT_NUMBER: "cell-convective-courant-number",
+            _c.CELL_REYNOLDS_NUMBER: "cell-reynolds-number",
+            _c.fluent.HELICITY: "helicity",
+            _c.fluent.LAMBDA_2_CRITERION: "raw-q-criterion",  # ???
+            _c.MESH_VELOCITY: "mesh-velocity",  # ?
+            _c.MESH_VELOCITY_X: "mesh-x-velocity",  # TODO
+            _c.MESH_VELOCITY_Y: "mesh-y-velocity",  # TODO
+            _c.MESH_VELOCITY_Z: "mesh-z-velocity",  # TODO
+            _c.MESH_VELOCITY_MAGNITUDE: "MeshVelocityMagnitude",  # TODO
+            _c.NORMALIZED_Q_CRITERION: "q-criterion",
+            _c.Q_CRITERION: "raw-q-criterion",
+            _c.RADIAL_VELOCITY: "radial-velocity",
+            _c.TANGENTIAL_VELOCITY: "tangential-velocity",
+            _c.VELOCITY: "velocity",
+            _c.VELOCITY_X: "x-velocity",
+            _c.VELOCITY_Y: "y-velocity",
+            _c.VELOCITY_Z: "z-velocity",
+            _c.VELOCITY_MAGNITUDE: "velocity-magnitude",
+            _c.fluent.VELOCITY_ANGLE: "xxx",  # eliminate altogether
+            _c.VORTICITY: "vorticity",
+            _c.VORTICITY_X: "x-vorticity",
+            _c.VORTICITY_Y: "y-vorticity",
+            _c.VORTICITY_Z: "z-vorticity",
+            _c.VORTICITY_MAGNITUDE: "vorticity-mag",
+            # density
+            _c.DENSITY: "density",
+            _c.fluent.DENSITY_ALL: "density-all",
+            # "properties"
+            _c.DYNAMIC_VISCOSITY: "viscosity-lam",
+            _c.PRANDTL_NUMBER: "prandtl-number-lam",
+            _c.SPECIFIC_HEAT_CAPACITY: "specific-heat-cp",
+            _c.THERMAL_CONDUCTIVITY: "thermal-conductivity",
+            # turbulence
+            _c.EFFECTIVE_PRANDTL_NUMBER: "prandtl-number-eff",
+            _c.EFFECTIVE_THERMAL_CONDUCTIVITY: "thermal-conductivity-eff",
+            _c.EFFECTIVE_VISCOSITY: "viscosity-eff",
+            _c.PRODUCTION_OF_TURBULENT_KINETIC_ENERGY: "production-of-k",
+            _c.SPECIFIC_DISSIPATION_RATE: "specific-diss-rate",
+            _c.TURBULENT_DISSIPATION_RATE: "turb-diss-rate",
+            _c.TURBULENT_INTENSITY: "turb-intensity",
+            _c.TURBULENT_VISCOSITY: "viscosity-turb",
+            _c.TURBULENT_VISCOSITY_RATIO: "viscosity-ratio",
+            _c.TURBULENT_KINETIC_ENERGY: "turb-kinetic-energy",
+            _c.TURBULENT_REYNOLDS_NUMBER: "turb-reynolds-number-rey",
+            _c.WALL_Y_PLUS: "y-plus",
+            _c.WALL_Y_STAR: "y-star",
+            # wall fluxes
+            _c.SURFACE_HEAT_TRANSFER_COEFFICIENT: "heat-transfer-coef",
+            _c.SKIN_FRICTION_COEFFICIENT: "skin-friction-coef",
+            _c.SURFACE_HEAT_FLUX: "heat-flux",
+            _c.SURFACE_HEAT_TRANSFER_COEFFICIENT: "heat-transfer-coef-wall",
+            _c.SURFACE_NUSSELT_NUMBER: "nusselt-number",
+            _c.SURFACE_STANTON_NUMBER: "stanton-number",
+            _c.WALL_ADJACENT_HEAT_TRANSFER_COEFFICIENT: "heat-transfer-coef-wall-adj",
+            _c.WALL_SHEAR_STRESS: "wall-shear",
+            _c.WALL_SHEAR_STRESS_X: "x-wall-shear",
+            _c.WALL_SHEAR_STRESS_Y: "y-wall-shear",
+            _c.WALL_SHEAR_STRESS_Z: "z-wall-shear",
+            # _c.WALL_SHEAR_STRESS_MAGNITUDE: "WallShearStressVector.mag",
+            _c.fluent.Y_PLUS_BASED_HEAT_TRANSFER_COEFFICIENT: "heat-transfer-coef-yplus",
+            # residuals
+            _c.fluent.MASS_IMBALANCE: "mass-imbalance",
+            # derivatives
+            _c.fluent.PRESSURE_HESSIAN_INDICATOR: "pressure-hessian-indicator",
+            _c.STRAIN_RATE: "strain-rate-mag",
+            # _c.fluent.DVELOCITY_DX: "dVelocitydx",
+            _c.fluent.DVELOCITY_DX_X: "dx-velocity-dx",
+            _c.fluent.DVELOCITY_DX_Y: "dy-velocity-dx",
+            _c.fluent.DVELOCITY_DX_Z: "dz-velocity-dx",
+            # _c.fluent.DVELOCITY_DX_MAGNITUDE: "dVelocitydx.mag",
+            # _c.fluent.DVELOCITY_DY: "dVelocitydy",
+            _c.fluent.DVELOCITY_DY_X: "dx-velocity-dy",
+            _c.fluent.DVELOCITY_DY_Y: "dy-velocity-dy",
+            _c.fluent.DVELOCITY_DY_Z: "dz-velocity-dy",
+            # _c.fluent.DVELOCITY_DY_MAGNITUDE: "dVelocitydy.mag",
+            # _c.fluent.DVELOCITY_DZ: "dVelocitydz",
+            _c.fluent.DVELOCITY_DZ_X: "dx-velocity-dz",
+            _c.fluent.DVELOCITY_DZ_Y: "dy-velocity-dz",
+            _c.fluent.DVELOCITY_DZ_Z: "dz-velocity-dz",
+            # _c.fluent.DVELOCITY_DZ_MAGNITUDE: "dVelocitydz.mag",
+            # temperature
+            _c.SPECIFIC_ENTHALPY: "enthalpy",
+            _c.SPECIFIC_ENTROPY: "entropy",
+            _c.SPECIFIC_INTERNAL_ENERGY: "internal-energy",
+            _c.SPECIFIC_TOTAL_ENERGY: "total-energy",
+            _c.TEMPERATURE: "temperature",
+            _c.SPECIFIC_TOTAL_ENTHALPY: "total-enthalpy",
+            _c.fluent.TOTAL_ENTHALPY_DEVIATION: "total-enthalpy-deviation",
+            _c.TOTAL_TEMPERATURE: "total-temperature",
+            _c.WALL_ADJACENT_TEMPERATURE: "wall-adjacent-temperature",
+            _c.WALL_TEMPERATURE: "wall-temperature",
+            _c.WALL_TEMPERATURE_THIN: "wall-temp-thin",
+            _c.fluent.Y_PLUS_BASED_HEAT_TRANSFER_COEFFICIENT: "reference-temperature-at-y+",
+            # mesh
+            _c.mesh.ANISOTROPIC_ADAPTION_CELLS: "anisotropic-adaption-cells",
+            _c.mesh.BOUNDARY_CELL_DISTANCE: "boundary-cell-dist",
+            _c.mesh.BOUNDARY_LAYER_CELLS: "boundary-layer-cells",
+            _c.mesh.BOUNDARY_NORMAL_DISTANCE: "boundary-normal-dist",
+            _c.mesh.BOUNDARY_VOLUME_DISTANCE: "boundary-volume-dist",
+            _c.mesh.CELL_EQUIANGLE_SKEW: "cell-equiangle-skew",
+            _c.mesh.CELL_EQUIVOLUME_SKEW: "cell-equivolume-skew",
+            _c.mesh.CELL_PARENT_INDEX: "cell-parent-index",
+            _c.mesh.CELL_REFINE_LEVEL: "cell-refine-level",
+            _c.mesh.CELL_VOLUME: "cell-volume",
+            _c.mesh.CELL_VOLUME_CHANGE: "cell-volume-change",
+            _c.mesh.ELEMENT_ASPECT_RATIO: "aspect-ratio",
+            _c.mesh.ELEMENT_WALL_DISTANCE: "cell-wall-distance",
+            _c.mesh.FACE_AREA_MAGNITUDE: "face-area-magnitude",
+            _c.mesh.FACE_HANDEDNESS: "face-handedness",
+            _c.mesh.INTERFACE_OVERLAP_FRACTION: "interface-overlap-fraction",
+            _c.mesh.MARK_POOR_ELEMENTS: "mark-poor-elements",
+            # _c.POSITION: "Position", ???
+            _c.POSITION_X: "x-coordinate",
+            _c.POSITION_Y: "y-coordinate",
+            _c.POSITION_Z: "z-coordinate",
+            # _c.POSITION_MAGNITUDE: "Position.mag", ???
+            _c.mesh.SMOOTHED_CELL_REFINE_LEVEL: "smoothed-cell-refine-level",
+            _c.mesh.X_FACE_AREA: "x-face-area",
+            _c.mesh.Y_FACE_AREA: "y-face-area",
+            _c.mesh.Z_FACE_AREA: "z-face-area",
+            _c.mesh.ACTIVE_CELL_PARTITION: "cell-partition-active",
+            _c.mesh.CELL_ELEMENT_TYPE: "cell-element-type",
+            _c.mesh.CELL_ID: "cell-id",
+            _c.mesh.CELL_WEIGHT: "cell-weight",
+            _c.mesh.CELL_ZONE_INDEX: "cell-zone",
+            _c.mesh.CELL_ZONE_TYPE: "cell-type",
+            _c.mesh.PARTITION_NEIGHBOURS: "partition-neighbors",
+            _c.mesh.STORED_CELL_PARTITIION: "cell-partition-stored",
+        }
+
+else:
+    FluentFieldDataNamingStrategy = None