feat: fix ExportCallback example case

Author: skim0119

elastica/callback_functions.py

@@ -43,7 +43,12 @@ def make_callback(self, system: T, time: np.float64, current_step: int) -> None:
             Simulation step.
 
         """
-        pass
+
+    def on_close(self) -> None:
+        """
+        This method is called collectively when when .close() is
+        called by the system collection.
+        """
 
 
 class MyCallBack(CallBackBaseClass):
@@ -264,15 +269,10 @@ def get_last_saved_path(self) -> Optional[str]:
         else:
             return self.save_path.format(self.file_count - 1, self._ext)
 
-    def close(self) -> None:
+    def on_close(self) -> None:
         """
-        Save residual buffer
+        Save residual buffer.
+        Can be called using `simulator.close()`.
         """
         if self.buffer_size:
             self._dump()
-
-    def clear(self) -> None:
-        """
-        Alias to `close`
-        """
-        self.close()

elastica/modules/memory_block.py

@@ -3,6 +3,7 @@
 Cosserat Rods, Rigid Body etc.
 """
 from typing import cast
+
 from elastica.typing import (
     RodType,
     RigidBodyType,

tests/test_callback_functions.py

@@ -171,22 +171,22 @@ def test_export_call_back_step_skip_param(self, step_skip):
             callback = ExportCallBack(step_skip, "rod", temp_dir_path, "npz")
             callback.make_callback(mock_rod, 1, step_skip - 1)
             # Check empty
-            callback.clear()
+            callback.on_close()
             saved_path_name = callback.get_last_saved_path()
             assert saved_path_name is None, "No file should be saved."
 
             # Check saved
             callback.make_callback(mock_rod, 1, step_skip)
-            callback.clear()
+            callback.on_close()
             saved_path_name = callback.get_last_saved_path()
             assert saved_path_name is not None, "File should be saved."
             assert os.path.exists(saved_path_name), "File should be saved"
 
             # Check saved file number
             callback.make_callback(mock_rod, 1, step_skip * 2)
-            callback.clear()
+            callback.on_close()
             callback.make_callback(mock_rod, 1, step_skip * 5)
-            callback.clear()
+            callback.on_close()
             saved_path_name = callback.get_last_saved_path()
             assert (
                 str(2) in saved_path_name
@@ -222,19 +222,7 @@ def test_export_call_back_close_test(self, rng):
             )
             for step in range(10):
                 callback.make_callback(mock_rod, 1, step)
-            callback.close()
-            saved_path_name = callback.get_last_saved_path()
-            assert os.path.exists(saved_path_name), "File is not saved."
-
-    def test_export_call_back_clear_test(self, rng):
-        mock_rod = MockRodWithElements(5)
-        with tempfile.TemporaryDirectory() as temp_dir_path:
-            callback = ExportCallBack(
-                1, "rod", temp_dir_path, "npz", file_save_interval=50
-            )
-            for step in range(10):
-                callback.make_callback(mock_rod, 1, step)
-            callback.clear()
+            callback.on_close()
             saved_path_name = callback.get_last_saved_path()
             assert os.path.exists(saved_path_name), "File is not saved."