flex_rf.tidy3d.PermittivityMonitor

Type: class │ Base(s): AbstractMediumPropertyMonitor

Description

Monitor that records the diagonal components of the complex-valued relative permittivity tensor in the frequency domain. The recorded data has the same shape as a FieldMonitor of the same geometry: the permittivity values are saved at the Yee grid locations, and can be interpolated to any point inside the monitor.

Notes

If 2D materials are present, then the permittivity values correspond to the volumetric equivalent of the 2D materials.

.. TODO add links to relevant areas

Example(s)

monitor = PermittivityMonitor(
    center=(1,2,3),
    size=(2,2,2),
    freqs=[250e12, 300e12],
    name='eps_monitor')

Parameters

size [TracedSize]

Size in x, y, and z directions.

name [str]

Unique name for monitor.

freqs [FreqArray]

Array or list of frequencies stored by the field monitor.

center [TracedCoordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.

interval_space [tuple[PositiveInt, PositiveInt, PositiveInt]] = (1, 1, 1)

Number of grid step intervals between monitor recordings. If equal to 1, there will be no downsampling. If greater than 1, the step will be applied, but the first and last point of the monitor grid are always included.

colocate [Literal[False]] = False

Colocation turned off, since colocated medium property values do not have a physical meaning - they do not correspond to the subpixel-averaged ones.

use_colocated_integration [Literal[True]] = True

Whether to use colocated fields for flux, dot products, and overlap integrals. Hard-coded to True for most monitor types. Can be toggled on field and overlap monitors.

apodization [ApodizationSpec] = factory: ApodizationSpec

This field is ignored in this monitor.

Methods

storage_size(num_cells: int, tmesh: ArrayFloat1D)

Size of monitor storage given the number of points after discretization.