ansys-fluent-core 0.14.dev0__py3-none-any.whl → 0.14.dev2__py3-none-any.whl

ansys/fluent/core/services/datamodel_se.py

@@ -1,5 +1,6 @@
 """Wrappers over StateEngine based datamodel gRPC service of Fluent."""
 from enum import Enum
+import functools
 import itertools
 import logging
 from typing import Any, Callable, Dict, Iterator, List, Tuple, Type
@@ -10,6 +11,7 @@ import grpc
 from ansys.api.fluent.v0 import datamodel_se_pb2 as DataModelProtoModule
 from ansys.api.fluent.v0 import datamodel_se_pb2_grpc as DataModelGrpcModule
 from ansys.api.fluent.v0.variant_pb2 import Variant
+import ansys.fluent.core as pyfluent
 from ansys.fluent.core.data_model_cache import DataModelCache
 from ansys.fluent.core.services.error_handler import catch_grpc_error
 from ansys.fluent.core.services.interceptors import BatchInterceptor, TracingInterceptor
@@ -273,6 +275,42 @@ class PyCallableStateObject:
         return self.get_state()
 
 
+class EventSubscription:
+    """EventSubscription class for any datamodel event."""
+
+    def __init__(
+        self,
+        service: DatamodelService,
+        request: DataModelProtoModule.SubscribeEventsRequest,
+    ):
+        """Subscribe to a datamodel event."""
+        self._service = service
+        response = service.subscribe_events(request)
+        response = response.response[0]
+        if response.status != DataModelProtoModule.STATUS_SUBSCRIBED:
+            raise RuntimeError(f"Failed to subscribe event: {request}!")
+        self.status = response.status
+        self.tag = response.tag
+        self._service.events[self.tag] = self
+
+    def unsubscribe(self):
+        """Unsubscribe the datamodel event."""
+        if self.status == DataModelProtoModule.STATUS_SUBSCRIBED:
+            self._service.event_streaming.unregister_callback(self.tag)
+            request = DataModelProtoModule.UnsubscribeEventsRequest()
+            request.tag.append(self.tag)
+            response = self._service.unsubscribe_events(request)
+            response = response.response[0]
+            if response.status != DataModelProtoModule.STATUS_UNSUBSCRIBED:
+                raise RuntimeError(f"Failed to unsubscribe event: {request}!")
+            self.status = response.status
+        self._service.events.pop(self.tag, None)
+
+    def __del__(self):
+        """Unsubscribe the datamodel event."""
+        self.unsubscribe()
+
+
 class PyStateContainer(PyCallableStateObject):
     """Object class using StateEngine based DatamodelService as backend. Use
     this class instead of directly calling DatamodelService's method.
@@ -306,6 +344,7 @@ class PyStateContainer(PyCallableStateObject):
             self.path = []
         else:
             self.path = path
+        self.cached_attrs = {}
 
     docstring = None
 
@@ -337,6 +376,28 @@ class PyStateContainer(PyCallableStateObject):
 
     setState = set_state
 
+    def _get_remote_attr(self, attrib: str) -> Any:
+        request = DataModelProtoModule.GetAttributeValueRequest()
+        request.rules = self.rules
+        request.path = convert_path_to_se_path(self.path)
+        request.attribute = attrib
+        response = self.service.get_attribute_value(request)
+        return _convert_variant_to_value(response.result)
+
+    def _get_cached_attr(self, attrib: str) -> Any:
+        cached_val = self.cached_attrs.get(attrib)
+        if cached_val is None:
+            cached_val = self._get_remote_attr(attrib)
+            try:  # will fail for Fluent 23.1 or before
+                self.add_on_attribute_changed(
+                    attrib,
+                    functools.partial(dict.__setitem__, self.cached_attrs, attrib),
+                )
+                self.cached_attrs[attrib] = cached_val
+            except Exception:
+                pass
+        return cached_val
+
     def get_attr(self, attrib: str) -> Any:
         """Get attribute value of the current object.
 
@@ -350,12 +411,9 @@ class PyStateContainer(PyCallableStateObject):
         Any
             Value of the attribute.
         """
-        request = DataModelProtoModule.GetAttributeValueRequest()
-        request.rules = self.rules
-        request.path = convert_path_to_se_path(self.path)
-        request.attribute = attrib
-        response = self.service.get_attribute_value(request)
-        return _convert_variant_to_value(response.result)
+        if pyfluent.DATAMODEL_USE_ATTR_CACHE:
+            return self._get_cached_attr(attrib)
+        return self._get_remote_attr(attrib)
 
     getAttribValue = get_attr
 
@@ -388,41 +446,58 @@ class PyStateContainer(PyCallableStateObject):
 
     docstring = None
 
+    def add_on_attribute_changed(
+        self, attribute: str, cb: Callable
+    ) -> EventSubscription:
+        """Register a callback for when an attribute is changed
 
-class EventSubscription:
-    """EventSubscription class for any datamodel event."""
+        Parameters
+        ----------
+        attribute : str
+            attribute name
+        cb : Callable
+            Callback function
 
-    def __init__(
-        self,
-        service: DatamodelService,
-        request: DataModelProtoModule.SubscribeEventsRequest,
-    ):
-        """Subscribe to a datamodel event."""
-        self._service = service
-        response = service.subscribe_events(request)
-        response = response.response[0]
-        if response.status != DataModelProtoModule.STATUS_SUBSCRIBED:
-            raise RuntimeError(f"Failed to subscribe event: {request}!")
-        self.status = response.status
-        self.tag = response.tag
-        self._service.events[self.tag] = self
+        Returns
+        -------
+        EventSubscription
+            EventSubscription instance which can be used to unregister the callback
+        """
+        request = DataModelProtoModule.SubscribeEventsRequest()
+        e = request.eventrequest.add(rules=self.rules)
+        e.attributeChangedEventRequest.path = convert_path_to_se_path(self.path)
+        e.attributeChangedEventRequest.attribute = attribute
+        subscription = EventSubscription(self.service, request)
+        self.service.event_streaming.register_callback(subscription.tag, self, cb)
+        return subscription
 
-    def unsubscribe(self):
-        """Unsubscribe the datamodel event."""
-        if self.status == DataModelProtoModule.STATUS_SUBSCRIBED:
-            self._service.event_streaming.unregister_callback(self.tag)
-            request = DataModelProtoModule.UnsubscribeEventsRequest()
-            request.tag.append(self.tag)
-            response = self._service.unsubscribe_events(request)
-            response = response.response[0]
-            if response.status != DataModelProtoModule.STATUS_UNSUBSCRIBED:
-                raise RuntimeError(f"Failed to unsubscribe event: {request}!")
-            self.status = response.status
-        self._service.events.pop(self.tag, None)
+    def add_on_command_attribute_changed(
+        self, command: str, attribute: str, cb: Callable
+    ) -> EventSubscription:
+        """Register a callback for when an attribute is changed
 
-    def __del__(self):
-        """Unsubscribe the datamodel event."""
-        self.unsubscribe()
+        Parameters
+        ----------
+        command : str
+            command name
+        attribute : str
+            attribute name
+        cb : Callable
+            Callback function
+
+        Returns
+        -------
+        EventSubscription
+            EventSubscription instance which can be used to unregister the callback
+        """
+        request = DataModelProtoModule.SubscribeEventsRequest()
+        e = request.eventrequest.add(rules=self.rules)
+        e.commandAttributeChangedEventRequest.path = convert_path_to_se_path(self.path)
+        e.commandAttributeChangedEventRequest.command = command
+        e.commandAttributeChangedEventRequest.attribute = attribute
+        subscription = EventSubscription(self.service, request)
+        self.service.event_streaming.register_callback(subscription.tag, self, cb)
+        return subscription
 
 
 class PyMenu(PyStateContainer):
@@ -539,8 +614,8 @@ class PyMenu(PyStateContainer):
         self.service.event_streaming.register_callback(subscription.tag, self, cb)
         return subscription
 
-    def add_on_changed(self, cb: Callable) -> EventSubscription:
-        """Register a callback for when the object is modified.
+    def add_on_deleted(self, cb: Callable) -> EventSubscription:
+        """Register a callback for when the object is deleted.
 
         Parameters
         ----------
@@ -554,13 +629,13 @@ class PyMenu(PyStateContainer):
         """
         request = DataModelProtoModule.SubscribeEventsRequest()
         e = request.eventrequest.add(rules=self.rules)
-        e.modifiedEventRequest.path = convert_path_to_se_path(self.path)
+        e.deletedEventRequest.path = convert_path_to_se_path(self.path)
         subscription = EventSubscription(self.service, request)
         self.service.event_streaming.register_callback(subscription.tag, self, cb)
         return subscription
 
-    def add_on_affected(self, cb: Callable) -> EventSubscription:
-        """Register a callback for when the object is affected.
+    def add_on_changed(self, cb: Callable) -> EventSubscription:
+        """Register a callback for when the object is modified.
 
         Parameters
         ----------
@@ -574,20 +649,16 @@ class PyMenu(PyStateContainer):
         """
         request = DataModelProtoModule.SubscribeEventsRequest()
         e = request.eventrequest.add(rules=self.rules)
-        e.affectedEventRequest.path = convert_path_to_se_path(self.path)
+        e.modifiedEventRequest.path = convert_path_to_se_path(self.path)
         subscription = EventSubscription(self.service, request)
         self.service.event_streaming.register_callback(subscription.tag, self, cb)
         return subscription
 
-    def add_on_affected_at_type_path(
-        self, child_type: str, cb: Callable
-    ) -> EventSubscription:
-        """Register a callback for when the object is affected at child type
+    def add_on_affected(self, cb: Callable) -> EventSubscription:
+        """Register a callback for when the object is affected.
 
         Parameters
         ----------
-        child_type : str
-            child type
         cb : Callable
             Callback function
 
@@ -599,47 +670,19 @@ class PyMenu(PyStateContainer):
         request = DataModelProtoModule.SubscribeEventsRequest()
         e = request.eventrequest.add(rules=self.rules)
         e.affectedEventRequest.path = convert_path_to_se_path(self.path)
-        e.affectedEventRequest.subtype = child_type
-        subscription = EventSubscription(self.service, request)
-        self.service.event_streaming.register_callback(subscription.tag, self, cb)
-        return subscription
-
-    def add_on_attribute_changed(
-        self, attribute: str, cb: Callable
-    ) -> EventSubscription:
-        """Register a callback for when an attribute is changed
-
-        Parameters
-        ----------
-        attribute : str
-            attribute name
-        cb : Callable
-            Callback function
-
-        Returns
-        -------
-        EventSubscription
-            EventSubscription instance which can be used to unregister the callback
-        """
-        request = DataModelProtoModule.SubscribeEventsRequest()
-        e = request.eventrequest.add(rules=self.rules)
-        e.attributeChangedEventRequest.path = convert_path_to_se_path(self.path)
-        e.attributeChangedEventRequest.attribute = attribute
         subscription = EventSubscription(self.service, request)
         self.service.event_streaming.register_callback(subscription.tag, self, cb)
         return subscription
 
-    def add_on_command_attribute_changed(
-        self, command: str, attribute: str, cb: Callable
+    def add_on_affected_at_type_path(
+        self, child_type: str, cb: Callable
     ) -> EventSubscription:
-        """Register a callback for when an attribute is changed
+        """Register a callback for when the object is affected at child type
 
         Parameters
         ----------
-        command : str
-            command name
-        attribute : str
-            attribute name
+        child_type : str
+            child type
         cb : Callable
             Callback function
 
@@ -650,9 +693,8 @@ class PyMenu(PyStateContainer):
         """
         request = DataModelProtoModule.SubscribeEventsRequest()
         e = request.eventrequest.add(rules=self.rules)
-        e.commandAttributeChangedEventRequest.path = convert_path_to_se_path(self.path)
-        e.commandAttributeChangedEventRequest.command = command
-        e.commandAttributeChangedEventRequest.attribute = attribute
+        e.affectedEventRequest.path = convert_path_to_se_path(self.path)
+        e.affectedEventRequest.subtype = child_type
         subscription = EventSubscription(self.service, request)
         self.service.event_streaming.register_callback(subscription.tag, self, cb)
         return subscription
@@ -712,31 +754,6 @@ class PyParameter(PyStateContainer):
         self.service.event_streaming.register_callback(subscription.tag, self, cb)
         return subscription
 
-    def add_on_attribute_changed(
-        self, attribute: str, cb: Callable
-    ) -> EventSubscription:
-        """Register a callback for when an attribute is changed
-
-        Parameters
-        ----------
-        attribute : str
-            attribute name
-        cb : Callable
-            Callback function
-
-        Returns
-        -------
-        EventSubscription
-            EventSubscription instance which can be used to unregister the callback
-        """
-        request = DataModelProtoModule.SubscribeEventsRequest()
-        e = request.eventrequest.add(rules=self.rules)
-        e.attributeChangedEventRequest.path = convert_path_to_se_path(self.path)
-        e.attributeChangedEventRequest.attribute = attribute
-        subscription = EventSubscription(self.service, request)
-        self.service.event_streaming.register_callback(subscription.tag, self, cb)
-        return subscription
-
 
 def _bool_value_if_none(val, default):
     if isinstance(val, bool) or val is None:
@@ -1145,6 +1162,21 @@ class PyCommandArguments(PyStateContainer):
                 py_class = mode.value[1]
                 return py_class(self, attr, self.service, self.rules, self.path, arg)
 
+    def get_attr(self, attrib: str) -> Any:
+        """Get attribute value of the current object.
+
+        Parameters
+        ----------
+        attrib : str
+            Name of the attribute.
+
+        Returns
+        -------
+        Any
+            Value of the attribute.
+        """
+        return self._get_remote_attr(attrib)
+
 
 class PyTextualCommandArgumentsSubItem(PyCommandArgumentsSubItem, PyTextual):
     """Class representing textual command argument in datamodel."""