ansys-fluent-core 0.34.dev0__py3-none-any.whl → 0.35.dev0__py3-none-any.whl

ansys/fluent/core/session.py

@@ -33,7 +33,6 @@ from deprecated.sphinx import deprecated
 
 from ansys.fluent.core.fluent_connection import FluentConnection
 from ansys.fluent.core.journaling import Journal
-from ansys.fluent.core.launcher.launcher_utils import is_compose
 from ansys.fluent.core.pyfluent_warnings import (
     PyFluentDeprecationWarning,
     PyFluentUserWarning,
@@ -151,6 +150,7 @@ class BaseSession:
             file_transfer_service,
             event_type,
             get_zones_info,
+            launcher_args,
         )
         self.register_finalizer_callback = fluent_connection.register_finalizer_cb
 
@@ -161,10 +161,14 @@ class BaseSession:
         file_transfer_service: Any | None = None,
         event_type=None,
         get_zones_info: weakref.WeakMethod[Callable[[], list[ZoneInfo]]] | None = None,
+        launcher_args: Dict[str, Any] | None = None,
     ):
         """Build a BaseSession object from fluent_connection object."""
         self._fluent_connection = fluent_connection
+        # Stores the backup of the fluent connection for later reference.
+        self._fluent_connection_backup = self._fluent_connection
         self._file_transfer_service = file_transfer_service
+        self._launcher_args = launcher_args
         self._error_state = fluent_connection._error_state
         self.scheme = scheme_eval
         self.rp_vars = RPVars(self.scheme.string_eval)
@@ -354,8 +358,32 @@ class BaseSession:
         return FluentVersion(self.scheme.version)
 
     def _exit_compose_service(self):
-        if self._fluent_connection._container and is_compose():
-            self._fluent_connection._container.stop()
+        args = self._launcher_args or {}
+        compose_config = args.get("compose_config", None)
+
+        container = self._fluent_connection._container
+        if compose_config and compose_config.is_compose:
+            container.stop()
+
+    def wait_process_finished(self, wait: float | int | bool = 60):
+        """Returns ``True`` if local Fluent processes have finished, ``False`` if they
+        are still running when wait limit (default 60 seconds) is reached. Immediately
+        cancels and returns ``None`` if ``wait`` is set to ``False``.
+
+        Parameters
+        ----------
+        wait : float, int or bool, optional
+            How long to wait for processes to finish before returning, by default 60 seconds.
+            Can also be set to ``True``, which will result in waiting indefinitely.
+
+        Raises
+        ------
+        UnsupportedRemoteFluentInstance
+            If current Fluent instance is running remotely.
+        WaitTypeError
+            If ``wait`` is specified improperly.
+        """
+        return self._fluent_connection_backup.wait_process_finished()
 
     def exit(self, **kwargs) -> None:
         """Exit session."""
@@ -452,9 +480,18 @@ class BaseSession:
             "field_data_streaming",
             "start_journal",
             "stop_journal",
+            "scheme_eval",
         }
         return sorted(dir_list)
 
+    def enable_beta_features(self):
+        """Enable access to Fluent beta-features"""
+        self._app_utilities.enable_beta()
+
+    @property
+    def _is_beta_enabled(self):
+        return self._app_utilities.is_beta_enabled()
+
 
 class Fields:
     """Container for field and solution variables."""
@@ -468,7 +505,7 @@ class Fields:
         self._is_solution_data_valid = (
             _session._app_utilities.is_solution_data_available
         )
-        self.field_info = service_creator("field_info").create(
+        self._field_info = service_creator("field_info").create(
             _session._field_data_service,
             self._is_solution_data_valid,
         )
@@ -488,3 +525,9 @@ class Fields:
             self._is_solution_data_valid,
             _session.scheme,
         )
+
+    @property
+    @deprecated(version="0.34.0", reason="Use relevant ``field_data`` methods..")
+    def field_info(self):
+        """Field Information."""
+        return self._field_info

ansys/fluent/core/session_pure_meshing.py

@@ -27,6 +27,7 @@ from typing import Any, Dict
 
 import ansys.fluent.core as pyfluent
 from ansys.fluent.core.data_model_cache import DataModelCache, NameKey
+from ansys.fluent.core.exceptions import BetaFeaturesNotEnabled
 from ansys.fluent.core.fluent_connection import FluentConnection
 from ansys.fluent.core.services import SchemeEval
 from ansys.fluent.core.session import BaseSession
@@ -119,7 +120,7 @@ class PureMeshing(BaseSession):
                 self.datamodel_streams[rules] = stream
                 stream.start(
                     rules=rules,
-                    no_commands_diff_state=pyfluent.DATAMODEL_USE_NOCOMMANDS_DIFF_STATE,
+                    no_commands_diff_state=pyfluent.config.datamodel_use_nocommands_diff_state,
                 )
                 self._fluent_connection.register_finalizer_cb(stream.stop)
 
@@ -175,13 +176,12 @@ class PureMeshing(BaseSession):
 
         Raises
         ------
-        RuntimeError
+        AttributeError
             If beta features are not enabled in Fluent.
         """
-        if not self._app_utilities.is_beta_enabled():
-            raise RuntimeError("Topology-based Meshing is a beta feature in Fluent.")
-        self._base_meshing.topology_based_meshing_workflow.initialize()
-        return self._base_meshing.topology_based_meshing_workflow
+        if not self._is_beta_enabled:
+            raise BetaFeaturesNotEnabled("Topology-based meshing")
+        return self._base_meshing.topology_based_meshing_workflow()
 
     @property
     def PartManagement(self):

ansys/fluent/core/session_pure_meshing.pyi

@@ -66,3 +66,4 @@ class PureMeshing:
         clean_up_mesh_file: bool = ...,
         overwrite_previous: bool = ...,
     ): ...
+    def enable_beta_features(self): ...

ansys/fluent/core/session_shared.py

@@ -47,11 +47,11 @@ tui_logger = logging.getLogger("pyfluent.tui")
 
 def _make_tui_module(session, module_name):
     try:
-        from ansys.fluent.core import CODEGEN_OUTDIR
+        from ansys.fluent.core import config
 
         tui_module = pyfluent.utils.load_module(
             f"{module_name}_tui_{session._version}",
-            CODEGEN_OUTDIR / module_name / f"tui_{session._version}.py",
+            config.codegen_outdir / module_name / f"tui_{session._version}.py",
         )
         warning_for_fluent_dev_version(session._version)
         return tui_module.main_menu(
@@ -64,13 +64,13 @@ def _make_tui_module(session, module_name):
 
 def _make_datamodel_module(session, module_name):
     try:
-        from ansys.fluent.core import CODEGEN_OUTDIR
+        from ansys.fluent.core import config
         from ansys.fluent.core.codegen.datamodelgen import datamodel_file_name_map
 
         file_name = datamodel_file_name_map[module_name]
         module = pyfluent.utils.load_module(
             f"{module_name}_{session._version}",
-            CODEGEN_OUTDIR / f"datamodel_{session._version}" / f"{file_name}.py",
+            config.codegen_outdir / f"datamodel_{session._version}" / f"{file_name}.py",
         )
         warning_for_fluent_dev_version(session._version)
         return module.Root(session._se_service, module_name, [])

ansys/fluent/core/session_solver.py

@@ -30,6 +30,7 @@ import weakref
 
 from ansys.api.fluent.v0 import svar_pb2 as SvarProtoModule
 import ansys.fluent.core as pyfluent
+from ansys.fluent.core.exceptions import BetaFeaturesNotEnabled
 from ansys.fluent.core.pyfluent_warnings import PyFluentDeprecationWarning
 from ansys.fluent.core.services import SchemeEval, service_creator
 from ansys.fluent.core.services.field_data import ZoneInfo, ZoneType
@@ -118,13 +119,16 @@ class Solver(BaseSession):
             get_zones_info=weakref.WeakMethod(self._get_zones_info),
         )
         self._settings = None
-        self._build_from_fluent_connection(fluent_connection, scheme_eval)
+        self._build_from_fluent_connection(
+            fluent_connection, scheme_eval, launcher_args=launcher_args
+        )
 
     def _build_from_fluent_connection(
         self,
         fluent_connection,
         scheme_eval: SchemeEval,
         file_transfer_service: Any | None = None,
+        launcher_args: Dict[str, Any] | None = None,
     ):
         self._tui_service = self._datamodel_service_tui
         self._se_service = self._datamodel_service_se
@@ -133,6 +137,7 @@ class Solver(BaseSession):
         self._system_coupling = None
         self._fluent_version = None
         self._bg_session_threads = []
+        self._launcher_args = launcher_args
         self._solution_variable_service = service_creator("svar").create(
             fluent_connection._channel, fluent_connection._metadata
         )
@@ -266,7 +271,7 @@ class Solver(BaseSession):
             "solution/run-calculation/calculate",
             "solution/run-calculation/dual-time-iterate",
         ]
-        if pyfluent.SUPPORT_SOLVER_INTERRUPT:
+        if pyfluent.config.support_solver_interrupt:
             if command.path in interruptible_commands:
                 command._root.solution.run_calculation.interrupt()
 
@@ -295,10 +300,12 @@ class Solver(BaseSession):
             bg_session._fluent_connection,
             bg_session._fluent_connection._connection_interface.scheme_eval,
             event_type=SolverEvent,
+            launcher_args=launcher_args,
         )
         self._build_from_fluent_connection(
             bg_session._fluent_connection,
             bg_session._fluent_connection._connection_interface.scheme_eval,
+            launcher_args=launcher_args,
         )
         # TODO temporary fix till set_state at settings root is fixed
         _set_state_safe(self.settings, state)
@@ -353,16 +360,40 @@ class Solver(BaseSession):
                 raise ex
 
     def __dir__(self):
-        if self._fluent_connection is None:
-            return ["is_active"]
-        dir_list = set(list(self.__dict__.keys()) + dir(type(self))) - {
+        dir_list = set(super().__dir__()) - {
             "svar_data",
             "svar_info",
             "reduction",
-            "field_data",
-            "field_info",
-            "field_data_streaming",
-            "start_journal",
-            "stop_journal",
         }
         return sorted(dir_list)
+
+    def switch_to_meshing(self):
+        """Switch to meshing mode and return a meshing session object. Deactivate this
+        object's public interface and streaming services.
+
+        Raises
+        ------
+        AttributeError
+            If beta features are not enabled in Fluent.
+
+        Returns
+        -------
+        Meshing
+        """
+        if not self._is_beta_enabled:
+            raise BetaFeaturesNotEnabled("switch_to_meshing")
+        from ansys.fluent.core.session_meshing import Meshing
+
+        self.settings.switch_to_meshing_mode()
+        for cb in self._fluent_connection.finalizer_cbs:
+            cb()
+        meshing_session = Meshing(
+            fluent_connection=self._fluent_connection,
+            scheme_eval=self.scheme,
+            file_transfer_service=self._file_transfer_service,
+        )
+        self._fluent_connection = None
+        self.__doc__ = (
+            "The solver session is no longer usable after switching to meshing mode."
+        )
+        return meshing_session

ansys/fluent/core/session_solver.pyi

@@ -44,3 +44,4 @@ class Solver:
     def write_case(self, file_name: str): ...
     @property
     def settings(self) -> settings_root.root: ...
+    def enable_beta_features(self): ...

ansys/fluent/core/session_utilities.py

@@ -264,6 +264,7 @@ class SessionBase:
     @classmethod
     def from_pim(
         cls,
+        ui_mode: UIMode | str | None = None,
         graphics_driver: (
             FluentWindowsGraphicsDriver | FluentLinuxGraphicsDriver | str | None
         ) = None,
@@ -274,6 +275,7 @@ class SessionBase:
         start_timeout: int = 60,
         additional_arguments: str = "",
         cleanup_on_exit: bool = True,
+        dry_run: bool | None = None,
         start_transcript: bool = True,
         gpu: bool | None = None,
         start_watchdog: bool | None = None,
@@ -284,6 +286,8 @@ class SessionBase:
 
         Parameters
         ----------
+        ui_mode : UIMode or str, optional
+            Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
         graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
             Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
             (for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).
@@ -309,6 +313,9 @@ class SessionBase:
         cleanup_on_exit : bool
             Determines whether to shut down the connected Fluent session upon exit or when calling
             the session's `exit()` method. Defaults to True.
+        dry_run : bool, optional
+            If True, does not launch Fluent but prints configuration information instead. If dry running a
+            PIM start, this method will return a configuration dictionary. Defaults to False.
         start_transcript : bool
             Indicates whether to start streaming the Fluent transcript in the client. Defaults to True;
             streaming can be controlled via `transcript.start()` and `transcript.stop()` methods on the session object.

ansys/fluent/core/solver/error_message.py

@@ -49,9 +49,9 @@ def allowed_name_error_message(
         if all(isinstance(item, str) for item in allowed_values) and allowed_values:
             matches = closest_allowed_names(trial_name, allowed_values)
         if matches:
-            message += f"The most similar names are: {', '.join(matches)}."
+            message += f"The most similar names are: {', '.join(matches)}"
         else:
-            message += f"The allowed values are: {allowed_values}."
+            message += f"The allowed values are: {allowed_values}"
 
     return message