local data updates only when modified (#133)

Author: cbellot000

ansys/dpf/core/cache.py

@@ -119,3 +119,21 @@ def wrapper(self, *args, **kwargs):
             func(self, *args, **kwargs)
 
     return wrapper
+
+def _setter(func):
+    """Add a private attribute to the class (``self._is_set = True``)
+    when a method with this decorator is used.
+
+    .. note::
+       The method must be used as a decorator.
+    """
+
+    def wrapper(self, *args, **kwargs):
+        """Call the original function"""
+        if hasattr(self, "_is_set"):
+            self._is_set = True
+        else:
+            setattr(self, "_is_set", True)
+        func(self, *args, **kwargs)
+
+    return wrapper

ansys/dpf/core/field.py

@@ -579,9 +579,9 @@ def deep_copy(self, server=None):
         Parameters
         ----------
         server : :class:`ansys.dpf.core.server`, optional
-        Server with the channel connected to the remote or local instance. The
-        default is ``None``, in which case an attempt is made to use the global
-        server.
+            Server with the channel connected to the remote or local instance. The
+            default is ``None``, in which case an attempt is made to use the global
+            server.
 
         Returns
         -------

ansys/dpf/core/field_base.py

@@ -3,6 +3,7 @@
 from ansys.dpf.core.common import natures, locations
 from ansys.dpf.core import errors
 from ansys.dpf.core import server as serverlib
+from ansys.dpf.core.cache import _setter
 
 import numpy as np
 
@@ -657,6 +658,7 @@ def get_entity_data_by_id(self, id):
             raise ValueError(f"The id {id} doesn't exist in the scoping")
         return self.get_entity_data(index)
 
+    @_setter
     def append(self, data, scopingid):
         """Add an entity data to the existing data.
 
@@ -766,6 +768,7 @@ def data(self):
             return np.array(self._data_copy)
 
     @data.setter
+    @_setter
     def data(self, data):
         if self._is_property_field:
             if not isinstance(data[0], int) and not isinstance(data[0], np.int32):
@@ -834,6 +837,7 @@ def _data_pointer_as_list(self):
         return self._data_pointer_copy
 
     @_data_pointer.setter
+    @_setter
     def _data_pointer(self, data):
         if isinstance(data, (np.ndarray, np.generic)):
             self._data_pointer_copy = data.tolist()
@@ -870,14 +874,20 @@ def scoping(self):
         return self._scoping_copy
 
     @scoping.setter
+    @_setter
     def scoping(self, data):
-        self._scoping_copy = data
+        if not isinstance(data, scoping._LocalScoping):
+            self._scoping_copy = data.as_local_scoping()
+        else:
+            self._scoping_copy = data
 
     def release_data(self):
         """Release the data."""
-        super()._set_data(self._data_copy)
-        super()._set_data_pointer(self._data_pointer_copy)
-        self._scoping_copy.release_data()
+        if hasattr(self, "_is_set") and self._is_set:
+            super()._set_data(self._data_copy)
+            super()._set_data_pointer(self._data_pointer_copy)
+            super()._set_scoping(self._scoping_copy._owner_scoping)
+            self._scoping_copy.release_data()
 
     def __enter__(self):
         return self

ansys/dpf/core/model.py

@@ -344,7 +344,7 @@ def streams_provider(self):
 
         Returns
         -------
-        streams_provider : operators.metadata.streams_provider
+        streams_provider : :class:`ansys.dpf.core.operators.metadata.streams_provider`
 
         Examples
         --------
@@ -392,7 +392,7 @@ def meshed_region(self):
 
         Returns
         -------
-        mesh : :class:`ansys.dpf.core.meshed_region`
+        mesh : :class:`ansys.dpf.core.meshed_region.MeshedRegion`
             Mesh
         """
         # NOTE: this uses the cached mesh and we might consider
@@ -413,7 +413,7 @@ def mesh_provider(self):
 
         Returns
         -------
-        mesh_provider : class:`ansys.dpf.core.operators.mesh.mesh_provider`
+        mesh_provider : :class:`ansys.dpf.core.operators.mesh.mesh_provider`
             Mesh provider operator.
 
         """
@@ -434,7 +434,7 @@ def result_info(self):
 
         Returns
         -------
-        result_info : :class:`ansys.dpf.core.ResultInfo`
+        result_info : :class:`ansys.dpf.core.result_info.ResultInfo`
         """
         self._cache_result_info()
 
@@ -460,6 +460,6 @@ def named_selection(self, named_selection):
 
         Returns
         -------
-        named_selection : :class:`ansys.dpf.core.scoping`
+        named_selection : :class:`ansys.dpf.core.scoping.Scoping`
         """
         return self.meshed_region.named_selection(named_selection)

ansys/dpf/core/scoping.py

@@ -13,6 +13,7 @@
 from ansys.dpf.core.common import _common_progress_bar, locations
 from ansys.dpf.core import misc
 from ansys.grpc.dpf import base_pb2, scoping_pb2, scoping_pb2_grpc
+from ansys.dpf.core.cache import _setter
 
 
 class Scoping:
@@ -430,6 +431,7 @@ def _get_location(self):
         """
         return self._location
 
+    @_setter
     def _set_location(self, loc=locations.nodal):
         """
         Parameters
@@ -440,6 +442,7 @@ def _set_location(self, loc=locations.nodal):
         """
         self._location = loc
 
+    @_setter
     @version_requires("2.1")
     def _set_ids(self, ids):
         """
@@ -477,6 +480,7 @@ def _get_ids(self, np_array=False):
         else:
             return self._scoping_ids_copy
 
+    @_setter
     def set_id(self, index, scopingid):
         """Set the ID of a scoping's index.
 
@@ -494,6 +498,7 @@ def set_id(self, index, scopingid):
         self._scoping_ids_copy[index] = scopingid
         self._mapper[scopingid] = index
 
+    @_setter
     def append(self, id):
         self._scoping_ids_copy.append(id)
         self._mapper[id] = len(self)-1
@@ -530,8 +535,9 @@ def _get_index(self, scopingid):
 
     def release_data(self):
         """Release the data."""
-        super()._set_ids(self._scoping_ids_copy)
-        super()._set_location(self._location)
+        if hasattr(self, "_is_set") and self._is_set:
+            super()._set_ids(self._scoping_ids_copy)
+            super()._set_location(self._location)
 
     def __enter__(self):
         return self

ansys/dpf/core/server.py

@@ -36,7 +36,7 @@
 def shutdown_global_server():
     try:
         if dpf.core.SERVER != None:
-            del dpf.core.SERVER
+            dpf.core.SERVER.__del__()
     except:
         pass
 

tests/test_field.py

@@ -488,6 +488,7 @@ def test_local_field_append():
     with field_to_local.as_local_field() as f:
         for i in range(1, num_entities + 1):
             f.append([0.1 * i, 0.2 * i, 0.3 * i], i)
+        assert f._is_set == True
     field = dpf.core.fields_factory.create_3d_vector_field(num_entities)
     for i in range(1, num_entities + 1):
         field.append([0.1 * i, 0.2 * i, 0.3 * i], i)
@@ -520,7 +521,7 @@ def test_local_elemental_nodal_field_append():
     with field_to_local.as_local_field() as f:
         for i in range(1, num_entities + 1):
             f.append([0.1 * i, 0.2 * i, 0.3 * i, 0.1 * i, 0.2 * i, 0.3 * i], i)
-
+        assert f._is_set == True
     assert np.allclose(field.data, field_to_local.data)
     assert np.allclose(field.scoping.ids, field_to_local.scoping.ids)
     assert len(field_to_local._data_pointer) == num_entities
@@ -532,6 +533,7 @@ def test_local_array_field_append():
     with field_to_local.as_local_field() as f:
         for i in range(1, num_entities + 1):
             f.append(np.array([0.1 * i, 0.2 * i, 0.3 * i]), i)
+        assert f._is_set is True
     field = dpf.core.fields_factory.create_3d_vector_field(num_entities)
     for i in range(1, num_entities + 1):
         field.append(np.array([0.1 * i, 0.2 * i, 0.3 * i]), i)
@@ -588,6 +590,7 @@ def test_local_get_entity_data():
             assert np.allclose(
                 f.get_entity_data_by_id(i), [[0.1 * i, 0.2 * i, 0.3 * i]]
             )
+        assert hasattr(f, "_is_set") is True
 
     with field_to_local.as_local_field() as f:
         for i in range(1, num_entities + 1):
@@ -596,6 +599,8 @@ def test_local_get_entity_data():
                 f.get_entity_data_by_id(i), [[0.1 * i, 0.2 * i, 0.3 * i]]
             )
 
+        assert hasattr(f, "_is_set") is False
+
 
 def test_local_elemental_nodal_get_entity_data():
     num_entities = 100
@@ -615,6 +620,8 @@ def test_local_elemental_nodal_get_entity_data():
                 f.get_entity_data_by_id(i),
                 [[0.1 * i, 0.2 * i, 0.3 * i], [0.1 * i, 0.2 * i, 0.3 * i]],
             )
+        assert hasattr(f, "_is_set") is True
+        assert f._is_set is True
 
     with field_to_local.as_local_field() as f:
         for i in range(1, num_entities + 1):
@@ -626,6 +633,7 @@ def test_local_elemental_nodal_get_entity_data():
                 f.get_entity_data_by_id(i),
                 [[0.1 * i, 0.2 * i, 0.3 * i], [0.1 * i, 0.2 * i, 0.3 * i]],
             )
+        assert hasattr(f, "_is_set") is False
 
 
 def test_auto_delete_field_local():
@@ -689,6 +697,8 @@ def test_get_set_data_elemental_nodal_local_field():
         assert np.allclose(f._data_pointer, [0, 6])
         assert np.allclose(f.get_entity_data(0), [[0.1, 0.2, 0.3], [0.1, 0.2, 0.3]])
         assert np.allclose(f.get_entity_data(1), [[0.1, 0.2, 0.3], [0.1, 0.2, 0.4]])
+        assert hasattr(f, "_is_set") is True
+        assert f._is_set is True
 
     assert np.allclose(
         field_to_local.data,
@@ -712,6 +722,8 @@ def test_get_set_data_elemental_nodal_local_field():
         assert np.allclose(f._data_pointer, [0, 6])
         assert np.allclose(f.get_entity_data(0), [[0.1, 0.2, 0.3], [0.1, 0.2, 0.3]])
         assert np.allclose(f.get_entity_data(1), [[0.1, 0.2, 0.3], [0.1, 0.2, 0.4]])
+        assert hasattr(f, "_is_set") is True
+        assert f._is_set is True
 
     assert np.allclose(
         field_to_local.data,
@@ -737,6 +749,8 @@ def test_get_set_data_elemental_nodal_local_field():
         assert np.allclose(f._data_pointer, [0, 6])
         assert np.allclose(f.get_entity_data(0), [[0.1, 0.2, 0.3], [0.1, 0.2, 0.3]])
         assert np.allclose(f.get_entity_data(1), [[0.1, 0.2, 0.3], [0.1, 0.2, 0.4]])
+        assert hasattr(f, "_is_set") is True
+        assert f._is_set is True
 
     assert np.allclose(
         field_to_local.data,
@@ -751,6 +765,20 @@ def test_get_set_data_elemental_nodal_local_field():
     )
 
 
+def test_get_set_scoping_local_field():
+    field_to_local = dpf.core.fields_factory.create_3d_vector_field(
+        2, location=dpf.core.locations.elemental_nodal
+    )
+    with field_to_local.as_local_field() as f:
+        f.data = [[0.1, 0.2, 0.3], [0.1, 0.2, 0.3]]
+        f.scoping = dpf.core.Scoping(ids=[3, 4])
+        assert np.allclose(f.data, [[0.1, 0.2, 0.3], [0.1, 0.2, 0.3]])
+        assert np.allclose(f.scoping_ids, [3, 4])
+        assert np.allclose(f.scoping.ids, [3, 4])
+    assert np.allclose(field_to_local.data, [[0.1, 0.2, 0.3], [0.1, 0.2, 0.3]])
+    assert np.allclose(field_to_local.scoping.ids, [3, 4])
+
+
 def test_empty_data_field():
     field_to_local = dpf.core.fields_factory.create_3d_vector_field(100)
     data = [1.0, 2.0, 3.0]

tests/test_scoping.py

@@ -202,13 +202,17 @@ def test_as_local_scoping():
             loc.append(i + 1)
             assert loc.id(i) == i + 1
             assert loc.index(i + 1) == i
+        assert hasattr(loc, "_is_set") is True
+        assert loc._is_set is True
     assert scop.ids == list(range(1, 101))
     assert scop.location == "Nodal"
     with scop.as_local_scoping() as loc:
         assert loc.location == "Nodal"
         for i in range(0, 100):
             assert loc.id(i) == i + 1
             assert loc.index(i + 1) == i
+        assert hasattr(loc, "_is_set") is False
+
 
 def test_as_local_scoping2():
     scop = Scoping()
@@ -218,13 +222,16 @@ def test_as_local_scoping2():
         for i in range(0, 100):
             assert loc.id(i) == i + 1
             assert loc.index(i + 1) == i
+        assert hasattr(loc, "_is_set") is True
+        assert loc._is_set is True
     assert scop.ids == list(range(1, 101))
     assert scop.location == "Nodal"
     with scop.as_local_scoping() as loc:
         assert loc.location == "Nodal"
         for i in range(0, 100):
             assert loc.id(i) == i + 1
             assert loc.index(i + 1) == i
+        assert hasattr(loc, "_is_set") is False
 
 
 def test_auto_delete_scoping_local():