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

ansys/fluent/core/file_session.py

@@ -43,8 +43,12 @@ from ansys.fluent.core.field_data_interfaces import (
     _ReturnFieldData,
 )
 from ansys.fluent.core.filereader.case_file import CaseFile
-from ansys.fluent.core.filereader.data_file import DataFile
-from ansys.fluent.core.utils.deprecate import deprecate_argument, deprecate_arguments
+from ansys.fluent.core.filereader.data_file import (
+    DataFile,
+    _to_scalar_field_name,
+    _to_vector_field_name,
+)
+from ansys.fluent.core.utils.deprecate import all_deprecators
 
 
 class InvalidMultiPhaseFieldName(ValueError):
@@ -113,7 +117,7 @@ class TransactionFieldData:
             )
         ]
         return self._returned_data._scalar_data(
-            kwargs.get("field_name"),
+            _to_scalar_field_name(kwargs.get("field_name")),
             kwargs.get("surfaces"),
             self.get_surface_ids(kwargs.get("surfaces")),
             scalar_field_data,
@@ -137,7 +141,7 @@ class TransactionFieldData:
     ) -> Dict[int | str, np.array]:
         vector_field_data = self.data[(("type", "vector-field"),)]
         return self._returned_data._vector_data(
-            kwargs.get("field_name"),
+            _to_vector_field_name(kwargs.get("field_name")),
             kwargs.get("surfaces"),
             self.get_surface_ids(kwargs.get("surfaces")),
             vector_field_data,
@@ -151,10 +155,16 @@ class TransactionFieldData:
             zones = []
         del zones
         pathlines_data = self.data[
-            (("type", "pathlines-field"), ("field", kwargs.get("field_name")))
+            (
+                ("type", "pathlines-field"),
+                (
+                    "field",
+                    _to_scalar_field_name(kwargs.get("field_name")),
+                ),
+            )
         ]
         return self._returned_data._pathlines_data(
-            kwargs.get("field_name"),
+            _to_scalar_field_name(kwargs.get("field_name")),
             kwargs.get("surfaces"),
             self.get_surface_ids(kwargs.get("surfaces")),
             pathlines_data,
@@ -223,21 +233,23 @@ class Transaction(FieldTransaction):
             surfaces=surfaces,
         )
 
-    @deprecate_argument(
-        old_arg="surface_names",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
-    )
-    @deprecate_arguments(
-        converter=_data_type_convertor,
-        warning_cls=PyFluentDeprecationWarning,
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+        ],
+        data_type_converter=_data_type_convertor,
+        deprecated_version="v0.25.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message="'add_surfaces_request' is deprecated, use 'add_requests' instead.",
     )
     def add_surfaces_request(
         self,
@@ -258,10 +270,6 @@ class Transaction(FieldTransaction):
         -------
         None
         """
-        warnings.warn(
-            "'add_surfaces_request' is deprecated, use 'add_requests' instead",
-            PyFluentDeprecationWarning,
-        )
         self._add_surfaces_request(data_types=data_types, surfaces=surfaces)
 
     def _add_surfaces_request(
@@ -285,17 +293,23 @@ class Transaction(FieldTransaction):
                 )
             )
 
-    @deprecate_argument(
-        old_arg="surface_names",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.25.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message="'add_scalar_fields_request' is deprecated, use 'add_requests' instead.",
     )
     def add_scalar_fields_request(
         self,
@@ -328,10 +342,6 @@ class Transaction(FieldTransaction):
         InvalidMultiPhaseFieldName
             If field name does not have prefix ``phase-`` for multi-phase cases.
         """
-        warnings.warn(
-            "'add_scalar_fields_request' is deprecated, use 'add_requests' instead",
-            PyFluentDeprecationWarning,
-        )
         self._add_scalar_fields_request(
             field_name=field_name,
             surfaces=surfaces,
@@ -360,17 +370,23 @@ class Transaction(FieldTransaction):
                 Transaction._ScalarFieldTransaction(field_name, surface_ids)
             )
 
-    @deprecate_argument(
-        old_arg="surface_names",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.25.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message="'add_vector_fields_request' is deprecated, use 'add_requests' instead.",
     )
     def add_vector_fields_request(
         self,
@@ -395,10 +411,6 @@ class Transaction(FieldTransaction):
         InvalidMultiPhaseFieldName
             If field name does not have prefix ``phase-`` for multi-phase cases.
         """
-        warnings.warn(
-            "'add_vector_fields_request' is deprecated, use 'add_requests' instead",
-            PyFluentDeprecationWarning,
-        )
         self._add_vector_fields_request(field_name=field_name, surfaces=surfaces)
 
     def _add_vector_fields_request(
@@ -420,17 +432,23 @@ class Transaction(FieldTransaction):
                 Transaction._VectorFieldTransaction(field_name, surface_ids)
             )
 
-    @deprecate_argument(
-        old_arg="surface_names",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.25.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message="Pathlines are not supported.",
     )
     def add_pathlines_fields_request(
         self,
@@ -604,23 +622,28 @@ class FileFieldData(FieldDataSource):
             surfaces=surfaces,
         )
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val],
-        warning_cls=PyFluentDeprecationWarning,
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
-    )
-    @deprecate_argument(
-        old_arg="data_type",
-        new_arg="data_types",
-        converter=lambda old_arg_val: [old_arg_val] if old_arg_val else None,
-        warning_cls=PyFluentDeprecationWarning,
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+            {
+                "old_arg": "data_type",
+                "new_arg": "data_types",
+                "converter": lambda old_arg_val: [old_arg_val] if old_arg_val else None,
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.25.0",
+        deprecated_reason="Old arguments 'surface_ids', 'surface_names' and 'data_type' are deprecated. Use 'surfaces' and 'data_types' instead.",
+        warn_message="'get_surface_data' is deprecated, use 'get_field_data' instead.",
     )
     def get_surface_data(
         self,
@@ -646,10 +669,6 @@ class FileFieldData(FieldDataSource):
              If surface IDs are provided as input, a dictionary containing a map of surface IDs to face
              vertices, connectivity data, and normal or centroid data is returned.
         """
-        warnings.warn(
-            "'get_surface_data' is deprecated, use 'get_field_data' instead",
-            PyFluentDeprecationWarning,
-        )
         return self._get_surface_data(
             data_types=data_types,
             surfaces=surfaces,
@@ -697,17 +716,23 @@ class FileFieldData(FieldDataSource):
             i = end
         return faces_data
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val],
-        warning_cls=PyFluentDeprecationWarning,
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.25.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message="'get_scalar_field_data' is deprecated, use 'get_field_data' instead.",
     )
     def get_scalar_field_data(
         self,
@@ -743,10 +768,6 @@ class FileFieldData(FieldDataSource):
         InvalidMultiPhaseFieldName
             If field name does not have prefix ``phase-`` for multi-phase cases.
         """
-        warnings.warn(
-            "'get_scalar_field_data' is deprecated, use 'get_field_data' instead",
-            PyFluentDeprecationWarning,
-        )
         return self._get_scalar_field_data(
             field_name=field_name,
             surfaces=surfaces,
@@ -781,17 +802,23 @@ class FileFieldData(FieldDataSource):
                 for count, surface in enumerate(surfaces)
             }
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val],
-        warning_cls=PyFluentDeprecationWarning,
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.25.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message="'get_vector_field_data' is deprecated, use 'get_field_data' instead.",
     )
     def get_vector_field_data(
         self,
@@ -821,10 +848,6 @@ class FileFieldData(FieldDataSource):
         InvalidMultiPhaseFieldName
             If field name does not have prefix ``phase-`` for multi-phase cases.
         """
-        warnings.warn(
-            "'get_vector_field_data' is deprecated, use 'get_field_data' instead",
-            PyFluentDeprecationWarning,
-        )
         return self._get_vector_field_data(
             field_name=field_name,
             surfaces=surfaces,
@@ -835,6 +858,7 @@ class FileFieldData(FieldDataSource):
         field_name: str,
         surfaces: List[int | str],
     ):
+        field_name = _to_vector_field_name(field_name)
         surface_ids = self.get_surface_ids(surfaces=surfaces)
         if (
             field_name.lower() != "velocity"
@@ -859,17 +883,23 @@ class FileFieldData(FieldDataSource):
                 for count, surface in enumerate(surfaces)
             }
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val],
-        warning_cls=PyFluentDeprecationWarning,
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val,
-        warning_cls=PyFluentDeprecationWarning,
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val,
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.25.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message="Pathlines are not supported.",
     )
     def get_pathlines_field_data(
         self,

ansys/fluent/core/filereader/data_file.py

@@ -52,6 +52,16 @@ except ModuleNotFoundError as exc:
         "Missing dependencies, use 'pip install ansys-fluent-core[reader]' to install them."
     ) from exc
 
+from ansys.fluent.core.variable_strategies import (
+    FluentFieldDataNamingStrategy as vector_naming,
+)
+from ansys.fluent.core.variable_strategies import (
+    FluentSVarNamingStrategy as scalar_naming,
+)
+
+_to_scalar_field_name = scalar_naming().to_string if scalar_naming else lambda s: s
+_to_vector_field_name = vector_naming().to_string if vector_naming else lambda s: s
+
 
 class DataFile:
     """Class to read a Fluent case file.
@@ -186,6 +196,7 @@ class DataFile:
         -------
             Numpy array containing scalar field data for a particular phase, field and surface.
         """
+        field_name = _to_scalar_field_name(field_name)
         if ":" in field_name:
             field_name = field_name.split(":")[1]
         min_id, max_id = self._case_file_handle.get_mesh().get_surface_locs(surface_id)

ansys/fluent/core/filereader/pre_processor.py

@@ -1,3 +1,25 @@
+# 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.
+
 """
 Pre-processor for XML content from Fluent project files.
 """

ansys/fluent/core/fluent_connection.py

@@ -42,6 +42,7 @@ import weakref
 import grpc
 
 import ansys.fluent.core as pyfluent
+from ansys.fluent.core.launcher.launcher_utils import is_compose
 from ansys.fluent.core.pyfluent_warnings import PyFluentDeprecationWarning
 from ansys.fluent.core.services import service_creator
 from ansys.fluent.core.services.app_utilities import (
@@ -150,7 +151,12 @@ def get_container(container_id_or_name: str) -> bool | ContainerT | None:
         container = docker_client.containers.get(container_id_or_name)
     except _docker().errors.NotFound:  # NotFound is a child from DockerException
         return False
-    except _docker().errors.DockerException as exc:
+    # DockerException is the most common exception we can get here.
+    # However, in some system setup, we get ReadTimeoutError from urllib3 library
+    # (https://github.com/ansys/pyfluent/issues/3425).
+    # As urllib3 is not a direct dependency of PyFluent, we don't want to import it here,
+    # hence we catch the generic Exception.
+    except Exception as exc:
         logger.info(f"{type(exc).__name__}: {exc}")
         return None
     return container
@@ -372,6 +378,7 @@ class FluentConnection:
         file_transfer_service: Any | None = None,
         slurm_job_id: str | None = None,
         inside_container: bool | None = None,
+        container: ContainerT | None = None,
     ):
         """Initialize a Session.
 
@@ -408,6 +415,9 @@ class FluentConnection:
         inside_container: bool, optional
             Whether the Fluent session that is being connected to
             is running inside a Docker container.
+        container: ContainerT, optional
+            The container instance if the Fluent session is running inside
+            a container.
 
         Raises
         ------
@@ -453,15 +463,16 @@ class FluentConnection:
             self._connection_interface.get_cortex_connection_properties()
         )
         self._cleanup_on_exit = cleanup_on_exit
-
+        self._container = container
         if (
             (inside_container is None or inside_container is True)
             and not remote_instance
             and cortex_host is not None
         ):
             logger.info("Checking if Fluent is running inside a container.")
-            inside_container = get_container(cortex_host)
-            logger.debug(f"get_container({cortex_host}): {inside_container}")
+            if not is_compose():
+                inside_container = get_container(cortex_host)
+                logger.debug(f"get_container({cortex_host}): {inside_container}")
             if inside_container is False:
                 logger.info("Fluent is not running inside a container.")
             elif inside_container is None:
@@ -519,13 +530,18 @@ class FluentConnection:
         -----
         If the Fluent session is responsive, prefer using :func:`exit()` instead.
 
+        Raises
+        ------
+        subprocess.CalledProcessError
+            If the cleanup script fails to execute.
+
         Examples
         --------
         >>> import ansys.fluent.core as pyfluent
         >>> session = pyfluent.launch_fluent()
         >>> session.force_exit()
         """
-        if self.connection_properties.inside_container:
+        if self.connection_properties.inside_container or is_compose():
             self._force_exit_container()
         elif self._remote_instance is not None:
             logger.error("Cannot execute cleanup script, Fluent running remotely.")
@@ -559,11 +575,15 @@ class FluentConnection:
                 )
                 cmd_list.append(cleanup_file_name)
                 logger.debug(f"Cleanup command list = {cmd_list}")
-                subprocess.Popen(
+                result = subprocess.run(
                     cmd_list,
                     stdout=subprocess.DEVNULL,
                     stderr=subprocess.DEVNULL,
+                    timeout=120,
+                    check=True,
                 )
+                if result.returncode != 0:
+                    raise subprocess.CalledProcessError(result.returncode, cmd_list)
             elif self._slurm_job_id:
                 logger.debug("Fluent running inside Slurm, closing Slurm session...")
                 self._close_slurm()
@@ -573,21 +593,28 @@ class FluentConnection:
     def _force_exit_container(self):
         """Immediately terminates the Fluent client running inside a container, losing
         unsaved progress and data."""
-        container = self.connection_properties.inside_container
-        container_id = self.connection_properties.cortex_host
-        pid = self.connection_properties.fluent_host_pid
-        cleanup_file_name = f"cleanup-fluent-{container_id}-{pid}.sh"
-        logger.debug(f"Executing Fluent container cleanup script: {cleanup_file_name}")
-        if get_container(container_id):
-            try:
-                container.exec_run(["bash", cleanup_file_name], detach=True)
-            except _docker().errors.APIError as e:
-                logger.info(f"{type(e).__name__}: {e}")
+        if is_compose() and self._container:
+            self._container.stop()
+        else:
+            container = self.connection_properties.inside_container
+            container_id = self.connection_properties.cortex_host
+            pid = self.connection_properties.fluent_host_pid
+            cleanup_file_name = f"cleanup-fluent-{container_id}-{pid}.sh"
+            logger.debug(
+                f"Executing Fluent container cleanup script: {cleanup_file_name}"
+            )
+            if get_container(container_id):
+                try:
+                    container.exec_run(["bash", cleanup_file_name], detach=True)
+                except _docker().errors.APIError as e:
+                    logger.info(f"{type(e).__name__}: {e}")
+                    logger.debug(
+                        "Caught Docker APIError, Docker container probably not running anymore."
+                    )
+            else:
                 logger.debug(
-                    "Caught Docker APIError, Docker container probably not running anymore."
+                    "Container not found, cancelling cleanup script execution."
                 )
-        else:
-            logger.debug("Container not found, cancelling cleanup script execution.")
 
     def register_finalizer_cb(self, cb, at_start=False):
         """Register a callback to run with the finalizer."""
@@ -648,7 +675,8 @@ class FluentConnection:
             logger.info(f"Waiting {wait} seconds for Fluent processes to finish...")
         else:
             raise WaitTypeError()
-        if self.connection_properties.inside_container:
+
+        if self.connection_properties.inside_container and not is_compose():
             _response = timeout_loop(
                 get_container,
                 wait,