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 (tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]] = (0.0, 0.0, 0.0)) – [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.

Attributes

unstructured

name

size

center

unstructured#