Merge branch 'develop' into latest

Author: momchil-flex

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.7.9] - 2025-01-22
+
+### Fixed
+- Potential task name mismatches between forward and adjoint simulations in batch tasks.
+- Magnitude of gradient computation in `CustomMedium` by accounting properly for full volume element when permittivity data is defined over fewer dimensions than the medium.
+
 ## [2.7.8] - 2024-11-27
 
 ### Changed
@@ -1395,8 +1401,9 @@ which fields are to be projected is now determined automatically based on the me
 - Job and Batch classes for better simulation handling (eventually to fully replace webapi functions).
 - A large number of small improvements and bug fixes.
 
-[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v2.7.8...develop
-[2.7.8]: https://github.com/flexcompute/tidy3d/compare/v2.7.6...v2.7.7
+[Unreleased]: https://github.com/flexcompute/tidy3d/compare/v2.7.9...develop
+[2.7.9]: https://github.com/flexcompute/tidy3d/compare/v2.7.8...v2.7.9
+[2.7.8]: https://github.com/flexcompute/tidy3d/compare/v2.7.7...v2.7.8
 [2.7.7]: https://github.com/flexcompute/tidy3d/compare/v2.7.6...v2.7.7
 [2.7.6]: https://github.com/flexcompute/tidy3d/compare/v2.7.5...v2.7.6
 [2.7.5]: https://github.com/flexcompute/tidy3d/compare/v2.7.4...v2.7.5

docs/faq

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tidy3d"
-version = "2.7.8"
+version = "2.7.9"
 description = "A fast FDTD solver"
 authors = ["Tyler Hughes <[email protected]>"]
 license = "LGPLv2+"
@@ -68,8 +68,8 @@ gdspy = { version = "*", optional = true }
 gdstk = { version = ">=0.9.49", optional = true }
 
 # jax
-jaxlib = { version = ">=0.4.25", source = "jaxsource", optional = true }
-jax = { version = ">=0.4.25", extras = [
+jaxlib = { version = ">=0.4.26", source = "jaxsource", optional = true }
+jax = { version = ">=0.4.26", extras = [
   "cpu",
 ], source = "jaxsource", optional = true }
 
@@ -273,7 +273,7 @@ testpaths = ["tidy3d", "tests", "docs"]
 python_files = "*.py"
 
 [tool.bumpversion]
-current_version = "2.7.8"
+current_version = "2.7.9"
 parse = """(?x)
     (?P<major>0|[1-9]\\d*)\\.
     (?P<minor>0|[1-9]\\d*)\\.

docs/notebooks

@@ -2897,7 +2897,7 @@
         "snapping_points": [],
         "type": "GridSpec"
     },
-    "version": "2.7.8",
+    "version": "2.7.9",
     "lumped_elements": [],
     "subpixel": false,
     "simulation_type": "tidy3d",

poetry.lock

@@ -755,7 +755,7 @@ def test_autograd_async(use_emulated_run, structure_key, monitor_key):
     make_sim = fn_dict["sim"]
     postprocess = fn_dict["postprocess"]
 
-    task_names = {"1", "2", "3", "4"}
+    task_names = {"test_a", "adjoint", "task1", "_test"}
 
     def objective(*args):
         sims = {task_name: make_sim(*args) for task_name in task_names}

pyproject.toml

@@ -223,7 +223,7 @@ class UniformGrid(GridSpec1d):
         Specification for non-uniform grid along a given dimension.
 
     **Notebooks:**
-        * `Photonic crystal waveguide polarization filter <../../../notebooks/PhotonicCrystalWaveguidePolarizationFilter.html>`_
+        * `Photonic crystal waveguide polarization filter <../../notebooks/PhotonicCrystalWaveguidePolarizationFilter.html>`_
         * `Using automatic nonuniform meshing <../../notebooks/AutoGrid.html>`_
     """
 

tests/sims/simulation_sample.h5

@@ -2582,7 +2582,17 @@ def _derivative_field_cmp(
 
         coords_interp = {key: eps_data.coords[key] for key in "xyz"}
         coords_interp = {key: val for key, val in coords_interp.items() if len(val) > 1}
-        dims_sum = [dim for dim in "xyz" if dim not in coords_interp]
+
+        E_der_dim_interp = E_der_map[f"E{dim}"]
+
+        for dim_ in "xyz":
+            if dim_ not in coords_interp:
+                bound_max = np.max(E_der_dim_interp.coords[dim_])
+                bound_min = np.min(E_der_dim_interp.coords[dim_])
+                dimension_size = bound_max - bound_min
+
+                if dimension_size > 0.0:
+                    E_der_dim_interp = E_der_dim_interp.integrate(dim_)
 
         # compute sizes along each of the interpolation dimensions
         sizes_list = []
@@ -2610,28 +2620,24 @@ def _derivative_field_cmp(
             d_vol = np.array(1.0)
 
         # TODO: probably this could be more robust. eg if the DataArray has weird edge cases
-        E_der_dim = E_der_map[f"E{dim}"]
         E_der_dim_interp = (
-            E_der_dim.interp(**coords_interp, assume_sorted=True).fillna(0.0).sum(dims_sum).real
+            E_der_dim_interp.interp(**coords_interp, assume_sorted=True).fillna(0.0).real.sum("f")
         )
-        E_der_dim_interp = E_der_dim_interp.sum("f")
-
-        vjp_array = np.array(E_der_dim_interp.values, dtype=float)
-
-        vjp_array = vjp_array.reshape(eps_data.shape)
 
-        # multiply by volume elements (if possible, being defensive here..)
         try:
-            vjp_array *= d_vol.reshape(vjp_array.shape)
+            E_der_dim_interp = E_der_dim_interp * d_vol.reshape(E_der_dim_interp.shape)
         except ValueError:
             log.warning(
                 "Skipping volume element normalization of 'CustomMedium' gradients. "
                 f"Could not reshape the volume elements of shape {d_vol.shape} "
-                f"to the shape of the gradient {vjp_array.shape}. "
+                f"to the shape of the fields {E_der_dim_interp.shape}. "
                 "If you encounter this warning, gradient direction will be accurate but the norm "
                 "will be inaccurate. Please raise an issue on the tidy3d front end with this "
                 "message and some information about your simulation setup and we will investigate. "
             )
+        vjp_array = E_der_dim_interp.values
+        vjp_array = vjp_array.reshape(eps_data.shape)
+
         return vjp_array