Adding support for current density monitor

Author: marc-flex

schemas/HeatChargeSimulation.json

@@ -257,6 +257,10 @@ def monitors():
 
     electric_field_mnt = td.SteadyElectricFieldMonitor(size=(1.6, 2, 3), name="electric_field_test")
 
+    current_density_mnt = td.SteadyCurrentDensityMonitor(
+        size=(1.6, 2, 3), name="current_density_mnt"
+    )
+
     return [
         temp_mnt1,  # 0
         temp_mnt2,  # 1
@@ -271,6 +275,7 @@ def monitors():
         energy_band_mnt1,  # 10
         mesh_mnt,  # 11
         electric_field_mnt,  # 12
+        current_density_mnt,  # 13
     ]
 
 
@@ -756,6 +761,19 @@ def electric_field_monitor_data(monitors):
     return (mnt_data1, mnt_data2, mnt_data3)
 
 
+@pytest.fixture(scope="module")
+def current_density_monitor_data(monitors, electric_field_monitor_data):
+    """Creates different current density monitor data."""
+    monitor = monitors[13]
+    e_data1, e_data2, e_data3 = electric_field_monitor_data
+
+    mnt_data1 = td.SteadyCurrentDensityData(monitor=monitor, J=e_data1.E)
+    mnt_data2 = td.SteadyCurrentDensityData(monitor=monitor, J=e_data2.E)
+    mnt_data3 = td.SteadyCurrentDensityData(monitor=monitor, J=e_data3.E)
+
+    return (mnt_data1, mnt_data2, mnt_data3)
+
+
 @pytest.fixture(scope="module")
 def simulation_data(
     heat_simulation,
@@ -930,52 +948,68 @@ def test_monitor_crosses_medium(mediums, structures, heat_simulation, conduction
 
 
 def test_heat_charge_mnt_data(
-    temperature_monitor_data, voltage_monitor_data, electric_field_monitor_data
+    temperature_monitor_data,
+    voltage_monitor_data,
+    electric_field_monitor_data,
+    current_density_monitor_data,
 ):
     """Tests whether different heat-charge monitor data can be created."""
     assert len(temperature_monitor_data) == 4, "Expected 4 temperature monitor data entries."
     assert len(voltage_monitor_data) == 4, "Expected 4 voltage monitor data entries."
     assert len(electric_field_monitor_data) == 3, "Expected 3 electric field monitor data entries."
+    assert len(current_density_monitor_data) == 3, (
+        "Expected 3 current density monitor data entries."
+    )
+
+    for var, mnt_data_lists in [
+        ("E", electric_field_monitor_data),
+        ("J", current_density_monitor_data),
+    ]:
+        for mnt_data in mnt_data_lists:
+            assert var in mnt_data.field_components.keys()
+
+            symm_data = mnt_data.symmetry_expanded_copy
+            if var == "E":
+                assert symm_data.E == mnt_data.E
+            elif var == "J":
+                assert symm_data.J == mnt_data.J
+
+            names = mnt_data.field_name("abs^2")
+            assert names == var + "²"
+            names = mnt_data.field_name()
+            assert names == var
+
+            # make sure an error is raised if we don't use a field data array
+            # TriangularGridDataset
+            tri_grid_points = td.PointDataArray(
+                [[0.0, 0.0], [1.0, 0.0], [0.0, 1.0], [1.0, 1.0]],
+                dims=("index", "axis"),
+            )
 
-    for mnt_data in electric_field_monitor_data:
-        assert "E" in mnt_data.field_components.keys()
-
-        symm_data = mnt_data.symmetry_expanded_copy
-        assert symm_data.E == mnt_data.E
-
-        names = mnt_data.field_name("abs^2")
-        assert names == "E²"
-        names = mnt_data.field_name()
-        assert names == "E"
-
-        # make sure an error is raised if we don't use a field data array
-        # TriangularGridDataset
-        tri_grid_points = td.PointDataArray(
-            [[0.0, 0.0], [1.0, 0.0], [0.0, 1.0], [1.0, 1.0]],
-            dims=("index", "axis"),
-        )
-
-        tri_grid_cells = td.CellDataArray(
-            [[0, 1, 2], [1, 2, 3]],
-            dims=("cell_index", "vertex_index"),
-        )
+            tri_grid_cells = td.CellDataArray(
+                [[0, 1, 2], [1, 2, 3]],
+                dims=("cell_index", "vertex_index"),
+            )
 
-        tri_grid_values = td.IndexedDataArray(
-            [1.0, 2.0, 3.0, 4.0],
-            dims=("index",),
-            name="T",
-        )
+            tri_grid_values = td.IndexedDataArray(
+                [1.0, 2.0, 3.0, 4.0],
+                dims=("index",),
+                name="T",
+            )
 
-        tri_grid = td.TriangularGridDataset(
-            normal_axis=1,
-            normal_pos=0,
-            points=tri_grid_points,
-            cells=tri_grid_cells,
-            values=tri_grid_values,
-        )
+            tri_grid = td.TriangularGridDataset(
+                normal_axis=1,
+                normal_pos=0,
+                points=tri_grid_points,
+                cells=tri_grid_cells,
+                values=tri_grid_values,
+            )
 
-        with pytest.raises(pd.ValidationError):
-            _ = mnt_data.updated_copy(E=tri_grid)
+            with pytest.raises(pd.ValidationError):
+                if var == "E":
+                    _ = mnt_data.updated_copy(E=tri_grid)
+                elif var == "J":
+                    _ = mnt_data.updated_copy(J=tri_grid)
 
 
 def test_grid_spec_validation(grid_specs):

schemas/HeatSimulation.json

@@ -37,6 +37,7 @@
 )
 from tidy3d.components.tcad.data.types import (
     SteadyCapacitanceData,
+    SteadyCurrentDensityData,
     SteadyElectricFieldData,
     SteadyEnergyBandData,
     SteadyFreeCarrierData,
@@ -54,6 +55,7 @@
 from tidy3d.components.tcad.mesher import VolumeMesher
 from tidy3d.components.tcad.monitors.charge import (
     SteadyCapacitanceMonitor,
+    SteadyCurrentDensityMonitor,
     SteadyElectricFieldMonitor,
     SteadyEnergyBandMonitor,
     SteadyFreeCarrierMonitor,
@@ -673,6 +675,8 @@ def set_logging_level(level: str) -> None:
     "Staircasing",
     "SteadyCapacitanceData",
     "SteadyCapacitanceMonitor",
+    "SteadyCurrentDensityData",
+    "SteadyCurrentDensityMonitor",
     "SteadyElectricFieldData",
     "SteadyElectricFieldMonitor",
     "SteadyEnergyBandData",

schemas/TerminalComponentModeler.json

@@ -18,6 +18,7 @@
     HeatChargeMonitorType,
 )
 from tidy3d.components.types import Coordinate, ScalarSymmetry, annotate_type
+from tidy3d.log import log
 
 FieldDataset = Union[
     SpatialDataArray, annotate_type(Union[TriangularGridDataset, TetrahedralGridDataset])
@@ -47,15 +48,31 @@ class HeatChargeMonitorData(AbstractMonitorData, ABC):
     )
 
     @abstractmethod
+    def field_components(self) -> dict:
+        """Maps the field components to their associated data."""
+
+    def field_name(self, val: str = "") -> str:
+        """Gets the name of the fields to be plot."""
+        fields = self.field_components.keys()
+        name = ""
+        for field in fields:
+            if val == "abs^2":
+                name = f"{field}²"
+            else:
+                name = f"{field}"
+        return name
+
+    @property
     def symmetry_expanded_copy(self) -> HeatChargeMonitorData:
         """Return copy of self with symmetry applied."""
 
-    @abstractmethod
-    def field_name(self, val: str) -> str:
-        """Gets the name of the fields to be plot."""
+        new_field_components = {}
+        for field, val in self.field_components.items():
+            new_field_components[field] = self._symmetry_expanded_copy_base(property=val)
 
-    # def _symmetry_expanded_copy(self, property):
-    def _symmetry_expanded_copy(self, property: FieldDataset) -> FieldDataset:
+        return self.updated_copy(symmetry=(0, 0, 0), **new_field_components)
+
+    def _symmetry_expanded_copy_base(self, property: FieldDataset) -> FieldDataset:
         """Return the property with symmetry applied."""
 
         # no symmetry
@@ -118,3 +135,13 @@ def _symmetry_expanded_copy(self, property: FieldDataset) -> FieldDataset:
                 new_property = new_property.box_clip(bounds=clip_bounds)
 
         return new_property
+
+    def _post_init_validators(self):
+        """Call validators taking ``self`` that get run after init."""
+        # validate that data exists for all fields
+        for field_name, field in self.field_components.items():
+            if field is None:
+                log.warning(
+                    f"No data is available for monitor '{self.monitor.name}' field '{field_name}'. "
+                    "This is typically caused by monitor not intersecting any solid medium."
+                )