ansys-fluent-core 0.33.0__py3-none-any.whl → 0.34.0__py3-none-any.whl

ansys/fluent/core/launcher/container_launcher.py

@@ -216,13 +216,17 @@ class DockerLauncher:
 
         if is_compose():
             port, config_dict, container = start_fluent_container(
-                self._args, self.argvals["container_dict"]
+                self._args,
+                self.argvals["container_dict"],
+                self.argvals["start_timeout"],
             )
 
             _, _, password = _get_server_info_from_container(config_dict=config_dict)
         else:
             port, password, container = start_fluent_container(
-                self._args, self.argvals["container_dict"]
+                self._args,
+                self.argvals["container_dict"],
+                self.argvals["start_timeout"],
             )
 
         fluent_connection = FluentConnection(

ansys/fluent/core/launcher/error_handler.py

@@ -70,7 +70,7 @@ class LaunchFluentError(Exception):
 
     def __init__(self, launch_string):
         """__init__ method of LaunchFluentError class."""
-        details = "\n" + "Fluent Launch string: " + launch_string
+        details = "\n" + "Fluent Launch command: " + launch_string
         super().__init__(details)
 
 

ansys/fluent/core/launcher/fluent_container.py

@@ -77,10 +77,16 @@ from pathlib import Path, PurePosixPath
 from pprint import pformat
 import tempfile
 from typing import Any, List
+import warnings
 
 import ansys.fluent.core as pyfluent
 from ansys.fluent.core.docker.docker_compose import ComposeBasedLauncher
+from ansys.fluent.core.docker.utils import get_ghcr_fluent_image_name
+from ansys.fluent.core.launcher.error_handler import (
+    LaunchFluentError,
+)
 from ansys.fluent.core.launcher.launcher_utils import is_compose
+from ansys.fluent.core.pyfluent_warnings import PyFluentDeprecationWarning
 from ansys.fluent.core.session import _parse_server_info_file
 from ansys.fluent.core.utils.deprecate import all_deprecators
 from ansys.fluent.core.utils.execution import timeout_loop
@@ -155,7 +161,7 @@ def configure_container_dict(
     args: List[str],
     mount_source: str | Path | None = None,
     mount_target: str | Path | None = None,
-    timeout: int = 60,
+    timeout: int | None = None,
     port: int | None = None,
     license_server: str | None = None,
     container_server_info_file: str | Path | None = None,
@@ -180,7 +186,7 @@ def configure_container_dict(
         Path inside the container where ``mount_source`` will be mounted. This will be the working directory path
         visible to the Fluent process running inside the container.
     timeout : int, optional
-        Time limit  for the Fluent container to start, in seconds. By default, 30 seconds.
+        Time limit for the Fluent container to start, in seconds.
     port : int, optional
         Port for Fluent container to use.
     license_server : str, optional
@@ -231,6 +237,12 @@ def configure_container_dict(
     See also :func:`start_fluent_container`.
     """
 
+    if timeout is not None:
+        warnings.warn(
+            "configure_container_dict(timeout) is deprecated, use launch_fluent(start_timeout) instead.",
+            PyFluentDeprecationWarning,
+        )
+
     logger.debug(f"container_dict before processing:\n{dict_to_str(container_dict)}")
 
     # Starting with 'mount_source' because it is not tied to the 'working_dir'.
@@ -390,8 +402,10 @@ def configure_container_dict(
             image_tag = os.getenv(
                 "FLUENT_IMAGE_TAG", f"v{pyfluent.FLUENT_RELEASE_VERSION}"
             )
-        if not image_name:
-            image_name = os.getenv("FLUENT_IMAGE_NAME", "ghcr.io/ansys/pyfluent")
+        if not image_name and image_tag:
+            image_name = os.getenv(
+                "FLUENT_IMAGE_NAME", get_ghcr_fluent_image_name(image_tag)
+            )
         if not image_tag or not image_name:
             fluent_image = os.getenv("FLUENT_CONTAINER_IMAGE", None)
         elif image_tag and image_name:
@@ -444,7 +458,7 @@ def configure_container_dict(
         container_dict["mount_target"] = mount_target
 
     logger.debug(
-        f"Fluent container timeout: {timeout}, container_grpc_port: {container_grpc_port}, "
+        f"Fluent container container_grpc_port: {container_grpc_port}, "
         f"host_server_info_file: '{host_server_info_file}', "
         f"remove_server_info_file: {remove_server_info_file}"
     )
@@ -460,7 +474,7 @@ def configure_container_dict(
 
 
 def start_fluent_container(
-    args: List[str], container_dict: dict | None = None
+    args: List[str], container_dict: dict | None = None, start_timeout: int = 60
 ) -> tuple[int, str, Any]:
     """Start a Fluent container.
 
@@ -470,6 +484,9 @@ def start_fluent_container(
         List of Fluent launch arguments.
     container_dict : dict, optional
         Dictionary with Docker container configuration.
+    start_timeout : int, optional
+        Timeout in seconds for the container to start. If not specified, it defaults to 60
+        seconds.
 
     Returns
     -------
@@ -503,6 +520,14 @@ def start_fluent_container(
         host_server_info_file,
         remove_server_info_file,
     ) = container_vars
+    launch_string = " ".join(config_dict["command"])
+
+    if timeout:
+        logger.warning(
+            "launch_fluent(start_timeout) overridden by configure_container_dict(timeout) value."
+        )
+        start_timeout = timeout
+        del timeout
 
     try:
         if is_compose():
@@ -536,18 +561,36 @@ def start_fluent_container(
                 config_dict.pop("fluent_image"), **config_dict
             )
 
+            logger.debug(
+                f"Waiting for Fluent container for up to {start_timeout} seconds..."
+            )
+
             success = timeout_loop(
-                lambda: host_server_info_file.stat().st_mtime > last_mtime, timeout
+                lambda: host_server_info_file.stat().st_mtime > last_mtime,
+                start_timeout,
             )
 
             if not success:
-                raise TimeoutError(
-                    "Fluent container launch has timed out, stop container manually."
-                )
+                try:
+                    container.stop()
+                except Exception as stop_ex:
+                    logger.error(f"Failed to stop container: {stop_ex}")
+                    raise TimeoutError(
+                        f"Fluent container launch has timed out after {start_timeout} seconds. "
+                        f"Additionally, stopping the container failed: {stop_ex}"
+                    ) from stop_ex
+                else:
+                    raise TimeoutError(
+                        f"Fluent container launch has timed out after {start_timeout} seconds."
+                        " The container was stopped."
+                    )
             else:
                 _, _, password = _parse_server_info_file(str(host_server_info_file))
 
                 return port, password, container
+    except Exception as ex:
+        logger.error(f"Exception caught - {type(ex).__name__}: {ex}")
+        raise LaunchFluentError(launch_string) from ex
     finally:
         if remove_server_info_file and host_server_info_file.exists():
             host_server_info_file.unlink()

ansys/fluent/core/launcher/launcher.py

@@ -322,6 +322,9 @@ def launch_fluent(
     if env is None:
         env = {}
 
+    if start_timeout is None:
+        start_timeout = int(os.getenv("PYFLUENT_FLUENT_LAUNCH_TIMEOUT", "60"))
+
     def _mode_to_launcher_type(fluent_launch_mode: LaunchMode):
         launcher_mode_type = {
             LaunchMode.CONTAINER: DockerLauncher,

ansys/fluent/core/launcher/watchdog.py

@@ -76,8 +76,8 @@ def launch(
         )
     )
 
-    env_watchdog_debug = os.getenv("PYFLUENT_WATCHDOG_DEBUG", "off").upper()
-    if env_watchdog_debug in ("1", "ON"):
+    debug_watchdog = os.getenv("PYFLUENT_WATCHDOG_DEBUG") == "1"
+    if debug_watchdog:
         logger.debug(
             f"PYFLUENT_WATCHDOG_DEBUG environment variable found, "
             f"enabling debugging for watchdog ID {watchdog_id}..."
@@ -131,7 +131,7 @@ def launch(
         watchdog_id,
     ]
 
-    if env_watchdog_debug in ("1", "ON"):
+    if debug_watchdog:
         logger.debug(f"Starting Watchdog logging to directory {os.getcwd()}")
 
     kwargs = {"env": watchdog_env, "stdin": subprocess.DEVNULL, "close_fds": True}
@@ -151,7 +151,7 @@ def launch(
     if os.name == "posix":
         kwargs.update(start_new_session=True)
 
-    if env_watchdog_debug in ("1", "ON") and os.name != "nt":
+    if debug_watchdog and os.name != "nt":
         kwargs.update(
             stdout=open(f"pyfluent_watchdog_out_{watchdog_id}.log", mode="w"),
             stderr=open(f"pyfluent_watchdog_err_{watchdog_id}.log", mode="w"),
@@ -194,13 +194,13 @@ def launch(
                 err_content = "Watchdog - %s" % f.read().replace("\n", "")
             watchdog_err.unlink()
             logger.error(err_content)
-            if os.getenv("PYFLUENT_WATCHDOG_EXCEPTION_ON_ERROR"):
+            if os.getenv("PYFLUENT_WATCHDOG_EXCEPTION_ON_ERROR") == "1":
                 raise UnsuccessfulWatchdogLaunch(err_content)
 
         logger.warning(
             "PyFluent Watchdog did not initialize correctly, proceeding without it..."
         )
-        if os.getenv("PYFLUENT_WATCHDOG_EXCEPTION_ON_ERROR"):
+        if os.getenv("PYFLUENT_WATCHDOG_EXCEPTION_ON_ERROR") == "1":
             raise UnsuccessfulWatchdogLaunch(
                 "PyFluent Watchdog did not initialize correctly."
             )

ansys/fluent/core/launcher/watchdog_exec

@@ -34,7 +34,7 @@ if __name__ == "__main__":
 
         logger = pyfluent.logger.get_logger("pyfluent.watchdog")
 
-        if os.getenv("PYFLUENT_WATCHDOG_DEBUG", "OFF").upper() in ("1", "ON"):
+        if os.getenv("PYFLUENT_WATCHDOG_DEBUG") == "1":
             pyfluent.logger.enable(custom_config=log_config)
             logger.setLevel("DEBUG")
             logger.handlers = pyfluent.logger.get_logger(

ansys/fluent/core/pyfluent_warnings.py

@@ -38,6 +38,12 @@ class PyFluentUserWarning(UserWarning):
     pass
 
 
+class FluentDevVersionWarning(PyFluentUserWarning):
+    """Warning raised when a released PyFluent version is used with a development version of Fluent."""
+
+    pass
+
+
 def warning_for_fluent_dev_version(version):
     """Provides warning if Fluent develop branch is used."""
     from ansys.fluent.core import FLUENT_RELEASE_VERSION, FluentVersion
@@ -47,7 +53,7 @@ def warning_for_fluent_dev_version(version):
             "⚠️ Warning: You are using PyFluent with an unreleased or development version of Fluent.\n"
             "Compatibility is not guaranteed, and unexpected behavior may occur. Please use a released "
             "version of Fluent that is officially supported by this version of PyFluent.",
-            PyFluentUserWarning,
+            FluentDevVersionWarning,
         )
 
 

ansys/fluent/core/report.py

@@ -44,6 +44,8 @@ ANSYS_ENV_VARS = [
     "PYFLUENT_FLUENT_IP",
     "PYFLUENT_FLUENT_PORT",
     "PYFLUENT_FLUENT_ROOT",
+    "PYFLUENT_FLUENT_LAUNCH_TIMEOUT",
+    "PYFLUENT_FLUENT_AUTOMATIC_TRANSCRIPT",
     "PYFLUENT_GRPC_LOG_BYTES_LIMIT",
     "PYFLUENT_LAUNCH_CONTAINER",
     "PYFLUENT_LOGGING",

ansys/fluent/core/search.py

@@ -207,10 +207,18 @@ def _print_search_results(
             for query in queries:
                 if isinstance(query, tuple):
                     name, score = query
-                    if name in first_token and has_query(name, substrings):
-                        results.add((api_object, round(score, 2)))
                 else:
-                    if query in first_token and has_query(query, substrings):
+                    name = query
+                    score = None
+
+                if (
+                    name in first_token
+                    and has_query(name, substrings)
+                    and name in substrings[-1]
+                ):
+                    if score is not None:
+                        results.add((api_object, round(score, 2)))
+                    else:
                         results.add(api_object)
 
         return sorted(results)

ansys/fluent/core/services/__init__.py

@@ -32,7 +32,7 @@ from ansys.fluent.core.services.datamodel_tui import (
 )
 from ansys.fluent.core.services.deprecated_field_data import DeprecatedFieldData
 from ansys.fluent.core.services.events import EventsService
-from ansys.fluent.core.services.field_data import FieldInfo, LiveFieldData
+from ansys.fluent.core.services.field_data import LiveFieldData, _FieldInfo
 from ansys.fluent.core.services.health_check import HealthCheckService
 from ansys.fluent.core.services.monitor import MonitorsService
 from ansys.fluent.core.services.reduction import Reduction
@@ -54,7 +54,7 @@ _service_cls_by_name = {
     "events": EventsService,
     "field_data": LiveFieldData,
     "field_data_old": DeprecatedFieldData,
-    "field_info": FieldInfo,
+    "field_info": _FieldInfo,
     "monitors": MonitorsService,
     "reduction": Reduction,
     "svar": SolutionVariableService,

ansys/fluent/core/services/app_utilities.py

@@ -104,6 +104,12 @@ class AppUtilitiesService:
         """Is beta enabled RPC of AppUtilities service."""
         return self._stub.IsBetaEnabled(request, metadata=self._metadata)
 
+    def enable_beta(
+        self, request: AppUtilitiesProtoModule.EnableBetaRequest
+    ) -> AppUtilitiesProtoModule.EnableBetaResponse:
+        """Is beta enabled RPC of AppUtilities service."""
+        return self._stub.EnableBeta(request, metadata=self._metadata)
+
     def is_wildcard(
         self, request: AppUtilitiesProtoModule.IsWildcardRequest
     ) -> AppUtilitiesProtoModule.IsWildcardResponse:
@@ -255,6 +261,18 @@ class AppUtilitiesOld:
         """Is beta enabled."""
         return self.scheme.eval("(is-beta-feature-available?)")
 
+    def enable_beta(self):
+        """Enable beta features.
+
+        Raises
+        ------
+        RuntimeError
+            Not supported before Fluent 2025 R2.
+        """
+        raise RuntimeError(
+            "Enabling beta is not supported by PyFluent for Fluent versions before 2025 R2."
+        )
+
     def is_wildcard(self, input: str | None = None) -> bool:
         """Is wildcard."""
         return self.scheme.eval(f'(has-fnmatch-wild-card? "{input}")')
@@ -405,6 +423,11 @@ class AppUtilities:
         response = self.service.is_beta_enabled(request)
         return response.is_beta_enabled
 
+    def enable_beta(self) -> None:
+        """Enable beta features."""
+        request = AppUtilitiesProtoModule.EnableBetaRequest()
+        self.service.enable_beta(request)
+
     def is_wildcard(self, input: str | None = None) -> bool:
         """Is wildcard."""
         request = AppUtilitiesProtoModule.IsWildcardRequest()
@@ -456,3 +479,19 @@ class AppUtilities:
         request = AppUtilitiesProtoModule.SetWorkingDirectoryRequest()
         request.path = path
         self.service.set_working_directory(request)
+
+
+class AppUtilitiesV252(AppUtilities):
+    """AppUtilitiesV252.
+    This is for methods whose implementations are missing in the 25R2 server.
+    """
+
+    def __init__(self, service: AppUtilitiesService, scheme):
+        super().__init__(service)
+        self.scheme = scheme
+
+    def enable_beta(self) -> None:
+        """Enable beta features."""
+        self.scheme.eval(
+            '(fl-execute-cmd "file" "beta-settings" (list (cons "enable?" #t)))'
+        )

ansys/fluent/core/services/deprecated_field_data.py

@@ -28,15 +28,15 @@ import warnings
 from ansys.api.fluent.v0 import field_data_pb2 as FieldDataProtoModule
 from ansys.fluent.core.pyfluent_warnings import PyFluentDeprecationWarning
 from ansys.fluent.core.services.field_data import (
+    Batch,
     ChunkParser,
     FieldDataService,
-    FieldInfo,
     SurfaceDataType,
-    Transaction,
     _AllowedScalarFieldNames,
     _AllowedSurfaceIDs,
     _AllowedSurfaceNames,
     _AllowedVectorFieldNames,
+    _FieldInfo,
     _FieldMethod,
     _get_surface_ids,
     get_fields_request,
@@ -223,7 +223,7 @@ class DeprecatedFieldData:
     def __init__(
         self,
         service: FieldDataService,
-        field_info: FieldInfo,
+        field_info: _FieldInfo,
         is_data_valid: Callable[[], bool],
         scheme_eval=None,
     ):
@@ -288,7 +288,7 @@ class DeprecatedFieldData:
     def new_transaction(self):
         """Create a new field transaction."""
         warnings.warn(DEPRECATION_MSG, PyFluentDeprecationWarning)
-        return Transaction(
+        return Batch(
             self._service,
             self._field_info,
             self._allowed_surface_ids,