Rename global_min_dl to dl_min in AutoGrid

Author: weiliangjin2021

CHANGELOG.md

@@ -25,7 +25,7 @@ method for computing the overlap integral over two sets of frequency-domain fiel
 - `sidewall_angle` option for `Cylinder` that allows a `Cylinder` to be tuned into a conical frustum or a cone.
 - `reference_plane` for `PolySlab` that provides options to define the vertices at the bottom, middle, or top of the `PolySlab`.
 - Automesh generation: `MeshOverrideStructure` that allows for a direct grid size specification in override structures,
- and `global_min_dl` that bounds the minimal grid size.
+ and `dl_min` that bounds the minimal grid size.
 - More material models to the material database such as gold from Olman2012.
 - In `AdvancedFitterParam` for `StableDispersionFitter`, `random_seed` option to set the random seed,
  and `bound_f_lower` to set the lower bound of pole frequency.

tests/sims/simulation_1_8_0.json

@@ -538,7 +538,7 @@ def test_mesh_multiple_direct_override_and_global_min():
     Let's consider three override structures: enforced + default + enforced;
     The two enforced structure overlap.
 
-    We also test global_min_dl here.
+    We also test dl_min here.
     """
 
     override_enforce1 = td.MeshOverrideStructure(
@@ -570,13 +570,13 @@ def test_mesh_multiple_direct_override_and_global_min():
     assert min(sizes) <= 0.05
     assert sizes[-1] > 0.12
 
-    # now let's set a global_min_dl
+    # now let's set a dl_min
     sim = td.Simulation(
         size=(3, 3, 3),
         grid_spec=td.GridSpec.auto(
             wavelength=WAVELENGTH,
             override_structures=[override_enforce1, override_default, override_enforce2],
-            global_min_dl=0.1,
+            dl_min=0.1,
         ),
         run_time=1e-13,
         structures=[BOX1],
@@ -660,5 +660,5 @@ def test_shapely_strtree_warnings(caplog):
             structures=[BOX1, BOX2],
             wavelength=1.0,
             min_steps_per_wvl=6,
-            global_min_dl=1.0,
+            dl_min=1.0,
         )

tests/test_components/test_meshgenerate.py

@@ -276,7 +276,7 @@ class AutoGrid(GridSpec1d):
         lt=2.0,
     )
 
-    global_min_dl: pd.NonNegativeFloat = pd.Field(
+    dl_min: pd.NonNegativeFloat = pd.Field(
         0,
         title="Lower bound of grid size",
         description="Lower bound of the grid size along this dimension regardless of "
@@ -341,7 +341,7 @@ def _make_coords_initial(  # pylint:disable=too-many-arguments,arguments-differ,
             struct_list,
             wavelength,
             self.min_steps_per_wvl,
-            self.global_min_dl,
+            self.dl_min,
         )
         # Put just a single pixel if 2D-like simulation
         if interval_coords.size == 1:
@@ -554,7 +554,7 @@ def auto(  # pylint:disable=too-many-arguments
         min_steps_per_wvl: pd.PositiveFloat = 10.0,
         max_scale: pd.PositiveFloat = 1.4,
         override_structures: List[StructureType] = (),
-        global_min_dl: pd.NonNegativeFloat = 0.0,
+        dl_min: pd.NonNegativeFloat = 0.0,
         mesher: MesherType = GradedMesher(),
     ) -> GridSpec:
         """Use the same :class:`AutoGrid` along each of the three directions.
@@ -573,7 +573,7 @@ def auto(  # pylint:disable=too-many-arguments
             A list of structures that is added on top of the simulation structures in
             the process of generating the grid. This can be used to refine the grid or make it
             coarser depending than the expected need for higher/lower resolution regions.
-        global_min_dl: pd.NonNegativeFloat
+        dl_min: pd.NonNegativeFloat
             Lower bound of grid size.
         mesher : MesherType = GradedMesher()
             The type of mesher to use to generate the grid automatically.
@@ -587,7 +587,7 @@ def auto(  # pylint:disable=too-many-arguments
         grid_1d = AutoGrid(
             min_steps_per_wvl=min_steps_per_wvl,
             max_scale=max_scale,
-            global_min_dl=global_min_dl,
+            dl_min=dl_min,
             mesher=mesher,
         )
         return cls(

tidy3d/components/grid/grid_spec.py

@@ -33,7 +33,7 @@ def parse_structures(  # pylint:disable=too-many-arguments
         structures: List[StructureType],
         wavelength: pd.PositiveFloat,
         min_steps_per_wvl: pd.NonNegativeInt,
-        global_min_dl: pd.NonNegativeFloat,
+        dl_min: pd.NonNegativeFloat,
     ) -> Tuple[ArrayLike[float, 1], ArrayLike[float, 1]]:
         """Calculate the positions of all bounding box interfaces along a given axis."""
 
@@ -59,7 +59,7 @@ def parse_structures(
         structures: List[StructureType],
         wavelength: pd.PositiveFloat,
         min_steps_per_wvl: pd.NonNegativeInt,
-        global_min_dl: pd.NonNegativeFloat,
+        dl_min: pd.NonNegativeFloat,
     ) -> Tuple[ArrayLike[float, 1], ArrayLike[float, 1]]:
         """Calculate the positions of all bounding box interfaces along a given axis.
         In this implementation, in most cases the complexity should be O(len(structures)**2),
@@ -76,7 +76,7 @@ def parse_structures(
             Wavelength to use for the step size and for dispersive media epsilon.
         min_steps_per_wvl : pd.NonNegativeInt
             Minimum requested steps per wavelength.
-        global_min_dl: pd.NonNegativeFloat
+        dl_min: pd.NonNegativeFloat
             Lower bound of grid size.
 
         Returns
@@ -120,7 +120,7 @@ def parse_structures(
 
         # Required maximum steps in every structure
         structure_steps = self.structure_steps(
-            structures_ordered, wavelength, min_steps_per_wvl, global_min_dl, axis
+            structures_ordered, wavelength, min_steps_per_wvl, dl_min, axis
         )
         # Smallest of the maximum steps
         min_step = np.amin(structure_steps)
@@ -346,7 +346,7 @@ def structure_steps(
         structures: List[StructureType],
         wavelength: float,
         min_steps_per_wvl: float,
-        global_min_dl: pd.NonNegativeFloat,
+        dl_min: pd.NonNegativeFloat,
         axis: Axis,
     ) -> ArrayLike[float, 1]:
         """Get the minimum mesh required in each structure.
@@ -359,7 +359,7 @@ def structure_steps(
             Wavelength to use for the step size and for dispersive media epsilon.
         min_steps_per_wvl : float
             Minimum requested steps per wavelength.
-        global_min_dl: pd.NonNegativeFloat
+        dl_min: pd.NonNegativeFloat
             Lower bound of grid size.
         axis : Axis
             Axis index along which to operate.
@@ -371,9 +371,9 @@ def structure_steps(
                     structure.medium.eps_diagonal(C_0 / wavelength)[axis]
                 )
                 index = max(abs(n), abs(k))
-                min_steps.append(max(global_min_dl, wavelength / index / min_steps_per_wvl))
+                min_steps.append(max(dl_min, wavelength / index / min_steps_per_wvl))
             elif isinstance(structure, MeshOverrideStructure):
-                min_steps.append(max(global_min_dl, structure.dl[axis]))
+                min_steps.append(max(dl_min, structure.dl[axis]))
         return np.array(min_steps)
 
     @staticmethod