tidy3d.VolumeMeshMonitor

tidy3d.VolumeMeshMonitor#

class VolumeMeshMonitor[source]#

Bases: HeatChargeMonitor

Monitor recording the volume mesh. The monitor size must be either 2D or 3D. If a 2D monitor is used in a 3D simulation, the sliced volumetric mesh on the plane of the monitor will be stored as a TriangularGridDataset.

Parameters:

  • center (Optional[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]]] = None) – [units = um]. Center of object in x, y, and z.

  • size (tuple[Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box]]) – [units = um]. Size in x, y, and z directions.

  • name (str) – Unique name for monitor.

  • unstructured (Literal[True] = True) – Return the original unstructured grid.

  • conformal (bool = False) – If True the simulation mesh will conform to the monitor’s geometry. While this can be set for both Cartesian and unstructured monitors, it bears higher significance for the latter ones. Effectively, setting conformal = True for unstructured monitors (unstructured = True) ensures that returned values will not be obtained by interpolation during postprocessing but rather directly transferred from the computational grid. Note: if the simulation mesh uses remove_fragments=True, this option is ignored (treated as False). Deprecated: this field will be removed in version 2.12.

Attributes

unstructured

conformal

name

size

center

unstructured#