tidy3d.EMECoefficientMonitor

class EMECoefficientMonitor

Bases: EMEMonitor

EME monitor for mode coefficients. Records the amplitudes of the forward and backward modes in each cell intersecting the monitor geometry.

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 (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.

• freqs (Optional[List[PositiveFloat]] = None) – Frequencies at which the monitor will record. Must be a subset of the simulation ‘freqs’.

• num_modes (Optional[NonNegativeInt] = None) – Maximum number of modes for the monitor to record. Cannot exceed the greatest number of modes in any EME cell.

• interval_space (Tuple[Literal[1], Literal[1], Literal[1]] = (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. Not all monitors support values different from 1. Note: This field is not used for ‘EMECoefficientMonitor’.

• eme_cell_interval_space (PositiveInt = 1) – Number of eme cells 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 cells are always included. Not used in all monitors. Not all monitors support values different from 1.

• colocate (Literal[True] = True) – Defines whether fields are colocated to grid cell boundaries (i.e. to the primal grid) on-the-fly during a solver run. Can be toggled for field recording monitors and is hard-coded for other monitors depending on their specific function.

Example

>>> monitor = EMECoefficientMonitor(
...     center=(1,2,3),
...     size=(2,2,2),
...     freqs=[300e12],
...     num_modes=2,
...     name="eme_coeffs"
... )

Attributes

attrs

Methods

storage_size(num_cells, num_eme_cells, ...)

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

Inherited Common Usage

interval_space

eme_cell_interval_space

storage_size(num_cells, num_eme_cells, num_freqs, num_modes)

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

__hash__()

Hash method.