tidy3d.VolumeMeshMonitor

class VolumeMeshMonitor

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:

• attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

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

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

• name (ConstrainedStrValue) – 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.

Attributes

attrs

Methods

Inherited Common Usage

unstructured

__hash__()

Hash method.