From 6c3ef005cb9b7ad640c09e237924878c095ab539 Mon Sep 17 00:00:00 2001
From: Hideousmon <mailtozyzhao@163.com>
Date: Thu, 5 Sep 2024 12:44:27 +0800
Subject: [PATCH] Version 0.5.10

* Added a caching mechanism to some functions that use Lumerical scripts in FDTDSimulation.
---
 history.md                          |   5 +-
 splayout/__init__.py                |   2 +-
 splayout/lumericalcommun/fdtdapi.py | 112 ++++++++++++++++++++++++++++
 3 files changed, 117 insertions(+), 2 deletions(-)

diff --git a/history.md b/history.md
index f22ae34..d0ddb7c 100644
--- a/history.md
+++ b/history.md
@@ -234,4 +234,7 @@
 * Defining material with float refractive index enabled for FDTDSimulation.add_structure_from_gdsii().
 
 ### Version 0.5.9 (Sep 4, 2024)
-* New pixelated region class: CirclePixelsRegionwithGroup.
\ No newline at end of file
+* New pixelated region class: CirclePixelsRegionwithGroup.
+
+### Version 0.5.10 (Sep 5, 2024)
+* Added a caching mechanism to some functions that use Lumerical scripts in FDTDSimulation.
\ No newline at end of file
diff --git a/splayout/__init__.py b/splayout/__init__.py
index fc040d2..6db0693 100644
--- a/splayout/__init__.py
+++ b/splayout/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.5.9"
+__version__ = "0.5.10"
 
 ## Submodules
 from . import utils
diff --git a/splayout/lumericalcommun/fdtdapi.py b/splayout/lumericalcommun/fdtdapi.py
index 04b4e72..2ec4131 100644
--- a/splayout/lumericalcommun/fdtdapi.py
+++ b/splayout/lumericalcommun/fdtdapi.py
@@ -53,6 +53,7 @@ def __init__(self, hide=0, fdtd_path=None, load_file = None):
             self.fdtd.eval("load(\"" + load_file + "\");")
         self.global_monitor_set_flag = 0
         self.global_source_set_flag = 0
+        self.__buffer = ""
 
     def add_structure_from_gdsii(self,filename,cellname,layer=1,datatype=0,material=Si, z_start = -0.11, z_end = 0.11,rename = None):
         """
@@ -1969,4 +1970,115 @@ def reset_imported_source(self, origin_x, origin_y, origin_z, E, H = None, sourc
 
 
 
+    def clear_data_in_CAD_with_buffer(self):
+        """
+        Save commands to buffer for clearing the pre-saved data in CAD.
+        """
+        self.__buffer += "clear;"
+
+
+    def switch_to_layout_with_buffer(self):
+        """
+        Save commands to buffer for switching the Lumerical FDTD simulation to "Layout" mode.
+        """
+        self.__buffer += "switchtolayout;"
+
+    def set_disable_with_buffer(self,item_name):
+        """
+        Save commands to buffer for setting an item of the simulation to "disable" state.
+
+        Parameters
+        ----------
+        item_name : String or list
+            Name of the item.
+
+        """
+        if (type(item_name) == list or type(item_name) == np.ndarray):
+            scripts = ""
+            for name in item_name:
+                scripts += "select(\"" + name + "\");"
+                scripts += "set(\"enabled\",0);"
+            self.__buffer += scripts
+        else:
+            self.__buffer += "select(\""+item_name+"\");"
+            self.__buffer += "set(\"enabled\",0);"
+
+    def set_enable_with_buffer(self,item_name):
+        """
+        Save commands to buffer for setting an item of the simulation to "enable" state.
+
+        Parameters
+        ----------
+        item_name : String or list
+            Name of the item.
+
+        Notes
+        -----
+        This function should be called in "Layout" mode for the Lumerical FDTD simulaiton.
+        """
+        if (type(item_name) == list or type(item_name) == np.ndarray):
+            scripts = ""
+            for name in item_name:
+                scripts += "select(\"" + name + "\");"
+                scripts += "set(\"enabled\",1);"
+            self.__buffer += scripts
+        else:
+            self.__buffer += "select(\"" + item_name + "\");"
+            self.__buffer += "set(\"enabled\",1);"
+
+    def reset_source_amplitude_with_buffer(self, source_name, amplitude):
+        """
+        Save commands to buffer for resetting amplitude for source.
+
+        Parameters
+        ----------
+        source_name : String
+            Name of the source in Lumerical FDTD.
+        amplitude : Float or Int
+            New amplitude for the source.
+
+        Notes
+        -----
+        This function should be called after setting a source.
+        """
+        self.__buffer += "select(\"" + source_name + "\");"
+        self.__buffer += "set(\"amplitude\"," + "%.6f"%(amplitude) + ");"
+
+    def reset_source_phase_with_buffer(self, source_name, phase):
+        """
+        Save commands to buffer for resetting amplitude for source.
+
+        Parameters
+        ----------
+        source_name : String
+            Name of the source in Lumerical FDTD.
+        phase : Float or Int
+            New phase for the source.
+
+        Notes
+        -----
+        This function should be called after setting a source.
+        """
+        self.__buffer += "select(\"" + source_name + "\");"
+        self.__buffer += "set(\"phase\"," + "%.6f"%(phase) + ");"
+
+    def print_buffer(self):
+        """
+        Print buffer.
+        """
+        print(self.__buffer)
+
+    def clear_buffer(self):
+        """
+        clear buffer.
+        """
+        self.__buffer = ""
+
+
+    def eval_buffer(self):
+        """
+        Eval all the buffer in FDTD and clear.
+        """
+        self.fdtd.eval(self.__buffer)
+        self.__buffer = ""