ansys-fluent-core 0.28.dev0__py3-none-any.whl → 0.28.2__py3-none-any.whl

ansys/fluent/core/streaming_services/events_streaming.py

@@ -1,5 +1,6 @@
 """Module for events management."""
 
+from dataclasses import dataclass, field, fields
 from enum import Enum
 from functools import partial
 import inspect
@@ -7,11 +8,41 @@ import logging
 from typing import Callable, Generic, Literal, Type, TypeVar
 import warnings
 
+from google.protobuf.json_format import MessageToDict
+
 from ansys.api.fluent.v0 import events_pb2 as EventsProtoModule
 from ansys.fluent.core.exceptions import InvalidArgument
 from ansys.fluent.core.streaming_services.streaming import StreamingService
 from ansys.fluent.core.warnings import PyFluentDeprecationWarning
 
+__all__ = [
+    "EventsManager",
+    "Event",
+    "SolverEvent",
+    "MeshingEvent",
+    "TimestepStartedEventInfo",
+    "TimestepEndedEventInfo",
+    "IterationEndedEventInfo",
+    "CalculationsStartedEventInfo",
+    "CalculationsEndedEventInfo",
+    "CalculationsPausedEventInfo",
+    "CalculationsResumedEventInfo",
+    "AboutToLoadCaseEventInfo",
+    "CaseLoadedEventInfo",
+    "AboutToLoadDataEventInfo",
+    "DataLoadedEventInfo",
+    "AboutToInitializeSolutionEventInfo",
+    "SolutionInitializedEventInfo",
+    "ReportDefinitionUpdatedEventInfo",
+    "ReportPlotSetUpdatedEventInfo",
+    "ResidualPlotUpdatedEventInfo",
+    "SettingsClearedEventInfo",
+    "SolutionPausedEventInfo",
+    "ProgressUpdatedEventInfo",
+    "SolverTimeEstimateUpdatedEventInfo",
+    "FatalErrorEventInfo",
+]
+
 network_logger = logging.getLogger("pyfluent.networking")
 
 
@@ -70,6 +101,269 @@ class MeshingEvent(Enum):
         return _missing_for_events(cls, value)
 
 
+class EventInfoBase:
+    """Base class for event information classes."""
+
+    derived_classes = {}
+
+    def __init_subclass__(cls, event, **kwargs):
+        super().__init_subclass__(**kwargs)
+        cls.derived_classes[event] = cls
+
+    def __post_init__(self):
+        for f in fields(self):
+            # Cast to the correct type
+            setattr(self, f.name, f.type(getattr(self, f.name)))
+
+    def __getattr__(self, name):
+        for f in fields(self):
+            if f.metadata.get("deprecated_name") == name:
+                warnings.warn(
+                    f"'{name}' is deprecated. Use '{f.name}' instead.",
+                    PyFluentDeprecationWarning,
+                )
+                return getattr(self, f.name)
+        return self.__getattribute__(name)
+
+
+@dataclass
+class TimestepStartedEventInfo(EventInfoBase, event=SolverEvent.TIMESTEP_STARTED):
+    """Information about the event triggered when a timestep is started.
+
+    Attributes
+    ----------
+    index : int
+        Timestep index.
+    size : float
+        Timestep size.
+    """
+
+    index: int
+    size: float
+
+
+@dataclass
+class TimestepEndedEventInfo(EventInfoBase, event=SolverEvent.TIMESTEP_ENDED):
+    """Information about the event triggered when a timestep is ended.
+
+    Attributes
+    ----------
+    index : int
+        Timestep index.
+    size : float
+        Timestep size.
+    """
+
+    index: int
+    size: float
+
+
+@dataclass
+class IterationEndedEventInfo(EventInfoBase, event=SolverEvent.ITERATION_ENDED):
+    """Information about the event triggered when an iteration is ended.
+
+    Attributes
+    ----------
+    index : int
+        Iteration index.
+    """
+
+    index: int
+
+
+class CalculationsStartedEventInfo(
+    EventInfoBase, event=SolverEvent.CALCULATIONS_STARTED
+):
+    """Information about the event triggered when calculations are started."""
+
+
+class CalculationsEndedEventInfo(EventInfoBase, event=SolverEvent.CALCULATIONS_ENDED):
+    """Information about the event triggered when calculations are ended."""
+
+
+class CalculationsPausedEventInfo(EventInfoBase, event=SolverEvent.CALCULATIONS_PAUSED):
+    """Information about the event triggered when calculations are paused."""
+
+
+class CalculationsResumedEventInfo(
+    EventInfoBase, event=SolverEvent.CALCULATIONS_RESUMED
+):
+    """Information about the event triggered when calculations are resumed."""
+
+
+@dataclass
+class AboutToLoadCaseEventInfo(EventInfoBase, event=SolverEvent.ABOUT_TO_LOAD_CASE):
+    """Information about the event triggered just before a case file is loaded.
+
+    Attributes
+    ----------
+    case_file_name : str
+        Case filename.
+    """
+
+    case_file_name: str = field(metadata=dict(deprecated_name="casefilepath"))
+
+
+@dataclass
+class CaseLoadedEventInfo(EventInfoBase, event=SolverEvent.CASE_LOADED):
+    """Information about the event triggered after a case file is loaded.
+
+    Attributes
+    ----------
+    case_file_name : str
+        Case filename.
+    """
+
+    case_file_name: str = field(metadata=dict(deprecated_name="casefilepath"))
+
+
+@dataclass
+class AboutToLoadDataEventInfo(EventInfoBase, event=SolverEvent.ABOUT_TO_LOAD_DATA):
+    """Information about the event triggered just before a data file is loaded.
+
+    Attributes
+    ----------
+    data_file_name : str
+        Data filename.
+    """
+
+    data_file_name: str = field(metadata=dict(deprecated_name="datafilepath"))
+
+
+@dataclass
+class DataLoadedEventInfo(EventInfoBase, event=SolverEvent.DATA_LOADED):
+    """Information about the event triggered after a data file is loaded.
+
+    Attributes
+    ----------
+    data_file_name : str
+        Data filename.
+    """
+
+    data_file_name: str = field(metadata=dict(deprecated_name="datafilepath"))
+
+
+class AboutToInitializeSolutionEventInfo(
+    EventInfoBase, event=SolverEvent.ABOUT_TO_INITIALIZE_SOLUTION
+):
+    """Information about the event triggered just before solution is initialized."""
+
+
+class SolutionInitializedEventInfo(
+    EventInfoBase, event=SolverEvent.SOLUTION_INITIALIZED
+):
+    """Information about the event triggered after solution is initialized."""
+
+
+@dataclass
+class ReportDefinitionUpdatedEventInfo(
+    EventInfoBase, event=SolverEvent.REPORT_DEFINITION_UPDATED
+):
+    """Information about the event triggered when a report definition is updated.
+
+    Attributes
+    ----------
+    report_name : str
+        Report name.
+    """
+
+    report_name: str = field(metadata=dict(deprecated_name="reportdefinitionname"))
+
+
+@dataclass
+class ReportPlotSetUpdatedEventInfo(
+    EventInfoBase, event=SolverEvent.REPORT_PLOT_SET_UPDATED
+):
+    """Information about the event triggered when a report plot set is updated.
+
+    Attributes
+    ----------
+    plot_set_name : str
+        Plot set name.
+    """
+
+    plot_set_name: str = field(metadata=dict(deprecated_name="plotsetname"))
+
+
+class ResidualPlotUpdatedEventInfo(
+    EventInfoBase, event=SolverEvent.RESIDUAL_PLOT_UPDATED
+):
+    """Information about the event triggered when residual plots are updated."""
+
+
+class SettingsClearedEventInfo(EventInfoBase, event=SolverEvent.SETTINGS_CLEARED):
+    """Information about the event triggered when settings are cleared."""
+
+
+@dataclass
+class SolutionPausedEventInfo(EventInfoBase, event=SolverEvent.SOLUTION_PAUSED):
+    """Information about the event triggered when solution is paused.
+
+    Attributes
+    ----------
+    level : str
+        Level of the pause event.
+    index : int
+        Index of the pause event.
+    """
+
+    level: str
+    index: int
+
+
+@dataclass
+class ProgressUpdatedEventInfo(EventInfoBase, event=SolverEvent.PROGRESS_UPDATED):
+    """Information about the event triggered when progress is updated.
+
+    Attributes
+    ----------
+    message : str
+        Progress message.
+    percentage : int
+        Progress percentage.
+    """
+
+    message: str
+    percentage: int = field(metadata=dict(deprecated_name="percentComplete"))
+
+
+@dataclass
+class SolverTimeEstimateUpdatedEventInfo(
+    EventInfoBase, event=SolverEvent.SOLVER_TIME_ESTIMATE_UPDATED
+):
+    """Information about the event triggered when solver time estimate is updated.
+
+    Attributes
+    ----------
+    hours : float
+        Hours of solver time estimate.
+    minutes : float
+        Minutes of solver time estimate.
+    seconds : float
+        Seconds of solver time estimate.
+    """
+
+    hours: float
+    minutes: float
+    seconds: float
+
+
+@dataclass
+class FatalErrorEventInfo(EventInfoBase, event=SolverEvent.FATAL_ERROR):
+    """Information about the event triggered when a fatal error occurs.
+
+    Attributes
+    ----------
+    message : str
+        Error message.
+    error_code : int
+        Error code.
+    """
+
+    message: str
+    error_code: int = field(metadata=dict(deprecated_name="errorCode"))
+
+
 TEvent = TypeVar("TEvent")
 
 
@@ -100,6 +394,17 @@ class EventsManager(Generic[TEvent]):
         self._session = session
         self._sync_event_ids = {}
 
+    def _construct_event_info(
+        self, response: EventsProtoModule.BeginStreamingResponse, event: TEvent
+    ):
+        event_info_msg = getattr(response, event.value.lower())
+        # Note: MessageToDict's parameter names are different in different protobuf versions
+        event_info_dict = MessageToDict(event_info_msg, True)
+        solver_event = SolverEvent(event.value)
+        event_info_cls = EventInfoBase.derived_classes.get(solver_event)
+        # Key names can be different, but their order is the same
+        return event_info_cls(*event_info_dict.values())
+
     def _process_streaming(
         self, service, id, stream_begin_method, started_evt, *args, **kwargs
     ):
@@ -129,30 +434,33 @@ class EventsManager(Generic[TEvent]):
                     for callback in callbacks_map.values():
                         callback(
                             session=self._session,
-                            event_info=getattr(response, event_name.value.lower()),
+                            event_info=self._construct_event_info(response, event_name),
                         )
             except StopIteration:
                 break
 
     @staticmethod
     def _make_callback_to_call(callback: Callable, args, kwargs):
-        old_style = "session_id" in inspect.signature(callback).parameters
-        if old_style:
+        params = inspect.signature(callback).parameters
+        if "session_id" in params:
             warnings.warn(
                 "Update event callback function signatures"
                 " substituting 'session' for 'session_id'.",
                 PyFluentDeprecationWarning,
             )
-        fn = partial(callback, *args, **kwargs)
-        return (
-            (
-                lambda session, event_info: fn(
-                    session_id=session.id, event_info=event_info
-                )
+            return lambda session, event_info: callback(
+                *args, session_id=session.id, event_info=event_info, **kwargs
+            )
+        else:
+            positional_args = [
+                p
+                for p in params
+                if p not in kwargs and p not in ("session", "event_info")
+            ]
+            kwargs.update(dict(zip(positional_args, args)))
+            return lambda session, event_info: callback(
+                session=session, event_info=event_info, **kwargs
             )
-            if old_style
-            else fn
-        )
 
     def register_callback(
         self,
@@ -229,8 +537,8 @@ class EventsManager(Generic[TEvent]):
                     del callbacks_map[callback_id]
             sync_event_id = self._sync_event_ids.pop(callback_id, None)
             if sync_event_id:
-                self._session.scheme_eval.scheme_eval(
-                    f"(cancel-solution-monitor 'pyfluent-{sync_event_id})"
+                self._session._app_utilities.unregister_pause_on_solution_events(
+                    registration_id=sync_event_id
                 )
 
     def start(self, *args, **kwargs) -> None:
@@ -247,44 +555,20 @@ class EventsManager(Generic[TEvent]):
         callback_id: str,
         callback: Callable,
     ) -> tuple[Literal[SolverEvent.SOLUTION_PAUSED], Callable]:
-        unique_id = self._session.scheme_eval.scheme_eval(
-            f"""
-            (let
-                ((ids
-                    (let loop ((i 1))
-                        (define next-id (string->symbol (format #f "pyfluent-~d" i)))
-                        (if (check-monitor-existence next-id)
-                            (loop (1+ i))
-                            (list i next-id)
-                            )
-                        )
-                    ))
-                (register-solution-monitor
-                    (cadr ids)
-                    (lambda (niter time)
-                        (if (integer? niter)
-                            (begin
-                                (events/transmit 'auto-pause (cons (car ids) niter))
-                                (grpcserver/auto-pause (is-server-running?) (cadr ids))
-                                )
-                            )
-                        ()
-                        )
-                    {'#t' if event_type == SolverEvent.TIMESTEP_ENDED else '#f'}
-                    )
-                (car ids)
-                )
-        """
+        unique_id: int = self._session._app_utilities.register_pause_on_solution_events(
+            solution_event=event_type
         )
 
-        def on_pause(session, event_info: EventsProtoModule.AutoPauseEvent):
-            if unique_id == event_info.level:
-                event_info_cls = (
-                    EventsProtoModule.TimestepEndedEvent
-                    if event_type == SolverEvent.TIMESTEP_ENDED
-                    else EventsProtoModule.IterationEndedEvent
-                )
-                event_info = event_info_cls(index=event_info.index)
+        def on_pause(session, event_info: SolutionPausedEventInfo):
+            if unique_id == int(event_info.level):
+                if event_type == SolverEvent.ITERATION_ENDED:
+                    event_info = IterationEndedEventInfo(index=event_info.index)
+                else:
+                    event_info = TimestepEndedEventInfo(
+                        # TODO: Timestep size is currently not available
+                        index=event_info.index,
+                        size=0,
+                    )
                 try:
                     callback(session, event_info)
                 except Exception as e:
@@ -293,8 +577,8 @@ class EventsManager(Generic[TEvent]):
                         exc_info=True,
                     )
                 finally:
-                    session.scheme_eval.scheme_eval(
-                        f"(grpcserver/auto-resume (is-server-running?) 'pyfluent-{unique_id})"
+                    session._app_utilities.resume_on_solution_event(
+                        registration_id=unique_id
                     )
 
         self._sync_event_ids[callback_id] = unique_id

ansys/fluent/tests/conftest.py

@@ -16,6 +16,8 @@ from ansys.fluent.core.examples.downloads import download_file
 from ansys.fluent.core.utils.file_transfer_service import RemoteFileTransferStrategy
 from ansys.fluent.core.utils.fluent_version import FluentVersion
 
+sys.path.append(Path(__file__).parent / "util")
+
 
 def pytest_addoption(parser):
     parser.addoption(
@@ -281,6 +283,13 @@ def new_solver_session():
     solver.exit()
 
 
+@pytest.fixture
+def new_solver_session_t4():
+    solver = create_session(processor_count=4)
+    yield solver
+    solver.exit()
+
+
 @pytest.fixture
 def new_solver_session_sp():
     solver = create_session(precision="single")
@@ -327,6 +336,14 @@ def mixing_elbow_settings_session(new_solver_session):
     return solver
 
 
+@pytest.fixture
+def mixing_elbow_case_session_t4(new_solver_session_t4):
+    solver = new_solver_session_t4
+    case_name = download_file("mixing_elbow.cas.h5", "pyfluent/mixing_elbow")
+    solver.settings.file.read(file_type="case", file_name=case_name)
+    return solver
+
+
 @pytest.fixture
 def mixing_elbow_case_data_session(new_solver_session):
     solver = new_solver_session
@@ -383,3 +400,16 @@ def periodic_rot_settings_session(new_solver_session):
 @pytest.fixture
 def disable_datamodel_cache(monkeypatch: pytest.MonkeyPatch):
     monkeypatch.setattr(pyfluent, "DATAMODEL_USE_STATE_CACHE", False)
+
+
+@pytest.fixture(params=["old", "new"])
+def datamodel_api_version_all(request, monkeypatch: pytest.MonkeyPatch) -> None:
+    if request.param == "new":
+        monkeypatch.setenv("REMOTING_NEW_DM_API", "1")
+        monkeypatch.setenv("REMOTING_MAPPED_NEW_DM_API", "1")
+
+
+@pytest.fixture
+def datamodel_api_version_new(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setenv("REMOTING_NEW_DM_API", "1")
+    monkeypatch.setenv("REMOTING_MAPPED_NEW_DM_API", "1")

ansys/fluent/tests/test_builtin_settings.py

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