Add VolumeMeshSpec and VOLUME_MESH task type

Author: momchil-flex

tidy3d/__init__.py

@@ -45,6 +45,7 @@
     GridRefinementRegion,
     UniformUnstructuredGrid,
 )
+from tidy3d.components.tcad.mesher import VolumeMeshSpec
 from tidy3d.components.tcad.monitors.charge import (
     SteadyCapacitanceMonitor,
     SteadyEnergyBandMonitor,
@@ -610,6 +611,7 @@ def set_logging_level(level: str) -> None:
     "TemperatureData",
     "TemperatureMonitor",
     "HeatChargeSimulation",
+    "VolumeMeshSpec",
     "SteadyPotentialData",
     "SteadyFreeCarrierData",
     "SteadyEnergyBandData",

tidy3d/components/tcad/mesher.py

@@ -0,0 +1,12 @@
+import pydantic as pd
+
+from tidy3d.components.base import Tidy3dBaseModel
+from tidy3d.components.tcad.simulation.heat_charge import HeatChargeSimulation
+
+
+class VolumeMeshSpec(Tidy3dBaseModel):
+    """Specification for a standalone volume mesher."""
+
+    simulation: HeatChargeSimulation = pd.Field(
+        ..., description="HeatCharge simulation instance for the mesh specification."
+    )

tidy3d/web/api/tidy3d_stub.py

@@ -9,6 +9,7 @@
 from pydantic.v1 import BaseModel
 
 from tidy3d.components.tcad.data.sim_data import HeatChargeSimulationData, HeatSimulationData
+from tidy3d.components.tcad.mesher import VolumeMeshSpec
 from tidy3d.components.tcad.simulation.heat import HeatSimulation
 from tidy3d.components.tcad.simulation.heat_charge import HeatChargeSimulation
 
@@ -88,6 +89,8 @@ def from_file(cls, file_path: str) -> SimulationType:
             sim = EMESimulation.from_file(file_path)
         elif "ModeSimulation" == type_:
             sim = ModeSimulation.from_file(file_path)
+        elif "VolumeMeshSpec" == type_:
+            sim = VolumeMeshSpec.from_file(file_path)
 
         return sim
 
@@ -148,6 +151,8 @@ def get_type(self) -> str:
             return TaskType.EME.name
         elif isinstance(self.simulation, ModeSimulation):
             return TaskType.MODE.name
+        elif isinstance(self.simulation, VolumeMeshSpec):
+            return TaskType.VOLUME_MESH.name
 
     def validate_pre_upload(self, source_required) -> None:
         """Perform some pre-checks on instances of component"""

tidy3d/web/api/webapi.py

@@ -48,7 +48,7 @@
 GUI_SUPPORTED_TASK_TYPES = ["FDTD", "MODE_SOLVER", "HEAT"]
 
 # if a solver is in beta stage, cost is subject to change
-BETA_TASK_TYPES = ["HEAT", "EME", "HEAT_CHARGE"]
+BETA_TASK_TYPES = ["HEAT", "EME", "HEAT_CHARGE", "VOLUME_MESH"]
 
 # map task_type to solver name for display
 SOLVER_NAME = {
@@ -58,6 +58,7 @@
     "EME": "EME",
     "HEAT": "Heat",
     "HEAT_CHARGE": "HeatCharge",
+    "VOLUME_MESH": "VolumeMesh",
 }
 
 

tidy3d/web/core/types.py

@@ -54,6 +54,7 @@ class TaskType(str, Enum):
     HEAT_CHARGE = "HEAT_CHARGE"
     EME = "EME"
     MODE = "MODE"
+    VOLUME_MESH = "VOLUME_MESH"
 
 
 class PayType(str, Enum):