tidy3d.PermittivityMonitor#

class PermittivityMonitor[source]#

Bases: FreqMonitor

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.

Parameters:
  • center (Tuple[float, float, float] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

  • size (Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]) – [units = um]. Size in x, y, and z directions.

  • name (ConstrainedStrValue) – Unique name for monitor.

  • 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 permittivity values do not have a physical meaning - they do not correspond to the subpixel-averaged ones.

  • freqs (Union[Tuple[float, ...], ArrayLike[dtype=float, ndim=1]]) – [units = Hz]. Array or list of frequencies stored by the field monitor.

  • apodization (ApodizationSpec = ApodizationSpec(start=None, end=None, width=None, type='ApodizationSpec')) – This field is ignored in this monitor.

Notes

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

Example

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

Attributes

Methods

storage_size(num_cells, tmesh)

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

Inherited Common Usage

colocate#
interval_space#
apodization#
storage_size(num_cells, tmesh)[source]#

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

__hash__()#

Hash method.