Add VolumeMesher and VOLUME_MESH task type

Author: momchil-flex

docs/faq

@@ -252,6 +252,8 @@ def monitors():
 
     energy_band_mnt1 = td.SteadyEnergyBandMonitor(size=(1.6, 2, 3), name="bandgap_test")
 
+    mesh_mnt = td.VolumeMeshMonitor(size=(1.6, 2, 3), name="mesh_test")
+
     return [
         temp_mnt1,
         temp_mnt2,
@@ -264,6 +266,7 @@ def monitors():
         capacitance_mnt1,
         free_carrier_mnt1,
         energy_band_mnt1,
+        mesh_mnt,
     ]
 
 
@@ -516,7 +519,7 @@ def temperature_monitor_data(monitors):
 @pytest.fixture(scope="module")
 def voltage_monitor_data(monitors):
     """Creates different voltage monitor data."""
-    _, _, _, _, volt_mnt1, volt_mnt2, volt_mnt3, volt_mnt4, _, _, _ = monitors
+    _, _, _, _, volt_mnt1, volt_mnt2, volt_mnt3, volt_mnt4, _, _, _, _ = monitors
 
     # SpatialDataArray
     nx, ny, nz = 9, 6, 5
@@ -598,6 +601,40 @@ def capacitance_monitor_data(monitors):
     return (cap_data1,)
 
 
+@pytest.fixture(scope="module")
+def mesh_monitor_data(monitors):
+    """Creates different voltage monitor data."""
+    mesh_mnt = monitors[11]
+
+    # TetrahedralGridDataset
+    tet_grid_points = td.PointDataArray(
+        [[0.0, 0.0, 0.0], [1.0, 0.0, 0.0], [0.0, 1.0, 0.0], [1.0, 1.0, 0.0], [0.0, 0.0, 1.0]],
+        dims=("index", "axis"),
+    )
+
+    tet_grid_cells = td.CellDataArray(
+        [[0, 1, 2, 4], [1, 2, 3, 4]],
+        dims=("cell_index", "vertex_index"),
+    )
+
+    tet_grid_values = td.IndexedDataArray(
+        np.zeros((tet_grid_points.shape[0],)),
+        dims=("index",),
+        name="Mesh",
+    )
+
+    tet_grid = td.TetrahedralGridDataset(
+        points=tet_grid_points,
+        cells=tet_grid_cells,
+        values=tet_grid_values,
+    )
+
+    # SpatialDataArray
+    mesh_data = td.VolumeMeshData(monitor=mesh_mnt, mesh=tet_grid)
+
+    return (mesh_data,)
+
+
 @pytest.fixture(scope="module")
 def free_carrier_monitor_data(monitors):
     """Creates different voltage monitor data."""
@@ -653,6 +690,7 @@ def simulation_data(
     capacitance_monitor_data,
     free_carrier_monitor_data,
     energy_band_monitor_data,
+    mesh_monitor_data,
 ):
     """Creates 'HeatChargeSimulationData' for both Heat and Conduction simulations."""
     heat_sim_data = td.HeatChargeSimulationData(
@@ -675,7 +713,20 @@ def simulation_data(
         data=(voltage_monitor_data[0], free_carrier_monitor_data[0]),
     )
 
-    return [heat_sim_data, cond_sim_data, voltage_capacitance_sim_data, current_voltage_sim_data]
+    mesh_monitor = mesh_monitor_data[0].monitor
+    mesh_data = td.VolumeMesherData(
+        simulation=conduction_simulation,
+        data=mesh_monitor_data,
+        monitors=[mesh_monitor],
+    )
+
+    return [
+        heat_sim_data,
+        cond_sim_data,
+        voltage_capacitance_sim_data,
+        current_voltage_sim_data,
+        mesh_data,
+    ]
 
 
 # --------------------------
@@ -854,9 +905,13 @@ def test_heat_charge_sources(structures):
 
 def test_heat_charge_simulation(simulation_data):
     """Tests 'HeatChargeSimulation' and 'ConductionSimulation' objects."""
-    heat_sim_data, cond_sim_data, voltage_capacitance_sim_data, current_voltage_simulation_data = (
-        simulation_data
-    )
+    (
+        heat_sim_data,
+        cond_sim_data,
+        voltage_capacitance_sim_data,
+        current_voltage_simulation_data,
+        mesh_data,
+    ) = simulation_data
 
     # Test Heat Simulation
     heat_sim = heat_sim_data.simulation
@@ -876,10 +931,13 @@ def test_heat_charge_simulation(simulation_data):
         "Current-Voltage simulation should be created successfully."
     )
 
+    mesher = mesh_data.mesher
+    assert mesher is not None, "VolumeMesher should be created successfully."
+
 
 def test_sim_data_plotting(simulation_data):
     """Tests whether simulation data can be plotted and appropriate errors are raised."""
-    heat_sim_data, cond_sim_data, cap_sim_data, fc_sim_data = simulation_data
+    heat_sim_data, cond_sim_data, cap_sim_data, fc_sim_data, mesh_data = simulation_data
 
     # Plotting temperature data
     heat_sim_data.plot_field("test", z=0)
@@ -1415,7 +1473,7 @@ def test_dynamic_simulation_updates(heat_simulation):
 
 def test_plotting_functions(simulation_data):
     """Test plotting functions with various data."""
-    heat_sim_data, cond_sim_data, cap_sim_data, fc_sim_data = simulation_data
+    heat_sim_data, cond_sim_data, cap_sim_data, fc_sim_data, mesh_data = simulation_data
 
     # Valid plotting
     try:

docs/notebooks

@@ -28,10 +28,12 @@
     HeatBoundarySpec,
     HeatChargeBoundarySpec,
 )
+from tidy3d.components.tcad.data.monitor_data.mesh import VolumeMeshData
 from tidy3d.components.tcad.data.sim_data import (
     DeviceCharacteristics,
     HeatChargeSimulationData,
     HeatSimulationData,
+    VolumeMesherData,
 )
 from tidy3d.components.tcad.data.types import (
     SteadyCapacitanceData,
@@ -48,15 +50,15 @@
     GridRefinementRegion,
     UniformUnstructuredGrid,
 )
+from tidy3d.components.tcad.mesher import VolumeMesher
 from tidy3d.components.tcad.monitors.charge import (
     SteadyCapacitanceMonitor,
     SteadyEnergyBandMonitor,
     SteadyFreeCarrierMonitor,
     SteadyPotentialMonitor,
 )
-from tidy3d.components.tcad.monitors.heat import (
-    TemperatureMonitor,
-)
+from tidy3d.components.tcad.monitors.heat import TemperatureMonitor
+from tidy3d.components.tcad.monitors.mesh import VolumeMeshMonitor
 from tidy3d.components.tcad.simulation.heat import HeatSimulation
 from tidy3d.components.tcad.simulation.heat_charge import HeatChargeSimulation
 from tidy3d.components.tcad.types import (
@@ -683,6 +685,10 @@ def set_logging_level(level: str) -> None:
     "VisualizationSpec",
     "VoltageBC",
     "VoltageSourceType",
+    "VolumeMesher",
+    "VolumeMesherData",
+    "VolumeMeshData",
+    "VolumeMeshMonitor",
     "VolumetricAveraging",
     "YeeGrid",
     "__version__",

tests/test_components/test_heat_charge.py

@@ -14,8 +14,8 @@
 from tidy3d.components.data.utils import UnstructuredGridDatasetType
 from tidy3d.components.types import FieldVal
 from tidy3d.exceptions import DataError, Tidy3dKeyError, ValidationError
-
-from .monitor_data import AbstractMonitorData
+from tidy3d.components.monitor import AbstractMonitor
+from tidy3d.components.base_sim.data.monitor_data import AbstractMonitorData
 
 
 class AbstractSimulationData(Tidy3dBaseModel, ABC):
@@ -128,3 +128,7 @@ def _field_component_value(
             )
 
         return field_value
+
+    def get_monitor_by_name(self, name: str) -> AbstractMonitor:
+        """Return monitor named 'name'."""
+        return self.simulation.get_monitor_by_name(name)

tidy3d/__init__.py

@@ -0,0 +1,43 @@
+"""Monitor data for unstructured volume mesh monitors."""
+
+from __future__ import annotations
+
+from typing import Dict, Union
+
+import pydantic.v1 as pd
+
+from tidy3d.components.data.utils import TetrahedralGridDataset, TriangularGridDataset
+from tidy3d.components.tcad.data.monitor_data.abstract import HeatChargeMonitorData
+from tidy3d.components.tcad.monitors.mesh import VolumeMeshMonitor
+
+UnstructuredFieldType = Union[TriangularGridDataset, TetrahedralGridDataset]
+
+
+class VolumeMeshData(HeatChargeMonitorData):
+    """Data associated with a :class:`VolumeMeshMonitor`: stores the unstructured mesh."""
+
+    monitor: VolumeMeshMonitor = pd.Field(
+        ..., title="Monitor", description="Mesh monitor associated with the data."
+    )
+
+    mesh: UnstructuredFieldType = pd.Field(
+        ...,
+        title="Mesh",
+        description="Dataset storing the mesh.",
+    )
+
+    @property
+    def field_components(self) -> Dict[str, UnstructuredFieldType]:
+        """Maps the field components to their associated data."""
+        return dict(mesh=self.mesh)
+
+    def field_name(self, val: str) -> str:
+        """Gets the name of the fields to be plot."""
+        return "Mesh"
+
+    @property
+    def symmetry_expanded_copy(self) -> VolumeMeshData:
+        """Return copy of self with symmetry applied."""
+
+        new_temp = self._symmetry_expanded_copy(property=self.temperature)
+        return self.updated_copy(temperature=new_temp, symmetry=(0, 0, 0))

tidy3d/components/base_sim/data/sim_data.py

@@ -2,12 +2,13 @@
 
 from __future__ import annotations
 
-from typing import Literal, Optional
+from typing import Literal, Optional, Tuple
+from abc import ABC
 
 import numpy as np
 import pydantic.v1 as pd
 
-from tidy3d.components.base import Tidy3dBaseModel
+from tidy3d.components.base import Tidy3dBaseModel, skip_if_fields_missing
 from tidy3d.components.base_sim.data.sim_data import AbstractSimulationData
 from tidy3d.components.data.data_array import (
     SpatialDataArray,
@@ -18,16 +19,19 @@
     TriangularGridDataset,
     UnstructuredGridDataset,
 )
+from tidy3d.components.tcad.data.monitor_data.mesh import VolumeMeshData
 from tidy3d.components.tcad.data.types import (
     SteadyPotentialData,
     TCADMonitorDataType,
     TemperatureData,
 )
+from tidy3d.components.tcad.mesher import VolumeMesher
+from tidy3d.components.tcad.monitors.mesh import VolumeMeshMonitor
 from tidy3d.components.tcad.simulation.heat import HeatSimulation
 from tidy3d.components.tcad.simulation.heat_charge import HeatChargeSimulation
 from tidy3d.components.types import Ax, RealFieldVal, annotate_type
 from tidy3d.components.viz import add_ax_if_none, equal_aspect
-from tidy3d.exceptions import DataError
+from tidy3d.exceptions import DataError, Tidy3dKeyError
 from tidy3d.log import log
 
 
@@ -81,7 +85,16 @@ class DeviceCharacteristics(Tidy3dBaseModel):
     )
 
 
-class HeatChargeSimulationData(AbstractSimulationData):
+class AbstractHeatChargeSimulationData(AbstractSimulationData, ABC):
+    data: Tuple[annotate_type(TCADMonitorDataType), ...] = pd.Field(
+        ...,
+        title="Monitor Data",
+        description="List of :class:`.MonitorData` instances "
+        "associated with the monitors of the original :class:`.Simulation`.",
+    )
+
+
+class HeatChargeSimulationData(AbstractHeatChargeSimulationData):
     """Stores results of a :class:`HeatChargeSimulation`.
 
     Example
@@ -376,3 +389,58 @@ def issue_warning_deprecated(cls, values):
             "'HeatChargeSimulationData' instead"
         )
         return values
+
+
+class VolumeMesherData(AbstractHeatChargeSimulationData):
+    """Stores results of a :class:`VolumeMesher`."""
+
+    simulation: HeatChargeSimulation = pd.Field(
+        title="Volume mesher",
+        description="Original :class:`VolumeMesher` associated with the data.",
+    )
+
+    data: Tuple[VolumeMeshData, ...] = pd.Field(
+        ...,
+        title="Monitor Data",
+        description="List of :class:`.MonitorData` instances "
+        "associated with the monitors of the original :class:`.VolumeMesher`.",
+    )
+
+    monitors: tuple[VolumeMeshMonitor, ...] = pd.Field(
+        ...,
+        title="Monitors",
+        description="List of monitors to be used for the mesher.",
+    )
+
+    @property
+    def mesher(self) -> VolumeMesher:
+        """Get the mesher associated with this mesher data."""
+        return VolumeMesher(
+            simulation=self.simulation,
+            monitors=self.monitors,
+        )
+
+    @pd.validator("data", always=True)
+    @skip_if_fields_missing(["monitors"])
+    def data_monitors_match_sim(cls, val, values):
+        """Ensure each :class:`AbstractMonitorData` in ``.data`` corresponds to a monitor in
+        ``.simulation``.
+        """
+        monitors = values.get("monitors")
+        mnt_names = {mnt.name for mnt in monitors}
+
+        for mnt_data in val:
+            monitor_name = mnt_data.monitor.name
+            if monitor_name not in mnt_names:
+                raise DataError(
+                    f"Data with monitor name '{monitor_name}' supplied "
+                    f"but not found in the list of monitors."
+                )
+        return val
+
+    def get_monitor_by_name(self, name: str) -> VolumeMeshMonitor:
+        """Return monitor named 'name'."""
+        for monitor in self.monitors:
+            if monitor.name == name:
+                return monitor
+        raise Tidy3dKeyError(f"No monitor named '{name}'")

tidy3d/components/tcad/data/monitor_data/mesh.py

@@ -0,0 +1,19 @@
+import pydantic as pd
+
+from tidy3d.components.base import Tidy3dBaseModel
+from tidy3d.components.tcad.monitors.mesh import VolumeMeshMonitor
+from tidy3d.components.tcad.simulation.heat_charge import HeatChargeSimulation
+
+
+class VolumeMesher(Tidy3dBaseModel):
+    """Specification for a standalone volume mesher."""
+
+    simulation: HeatChargeSimulation = pd.Field(
+        ..., description="HeatCharge simulation instance for the mesh specification."
+    )
+
+    monitors: tuple[VolumeMeshMonitor, ...] = pd.Field(
+        (),
+        title="Monitors",
+        description="List of monitors to be used for the mesher.",
+    )