tidy3d.FluxMonitor#

class FluxMonitor[source]#

Bases: AbstractFluxMonitor, FreqMonitor

Monitor that records power flux in the frequency domain.

Parameters:
  • center (Attribute: center) –

    Type

    Tuple[float, float, float]

    Default

    = (0.0, 0.0, 0.0)

    Units

    um

    Description

    Center of object in x, y, and z.

  • size (Attribute: size) –

    Type

    Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]

    Default

    Units

    um

    Description

    Size in x, y, and z directions.

  • name (Attribute: name) –

    Type

    ConstrainedStrValue

    Default

    Description

    Unique name for monitor.

  • interval_space (Attribute: interval_space) –

    Type

    Tuple[Literal[1], Literal[1], Literal[1]]

    Default

    = (1, 1, 1)

    Description

    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.

  • colocate (Attribute: colocate) –

    Type

    Literal[True]

    Default

    = True

    Description

    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.

  • freqs (Attribute: freqs) –

    Type

    Union[Tuple[float, …], ArrayLike[dtype=float, ndim=1]]

    Default

    Units

    Hz

    Description

    Array or list of frequencies stored by the field monitor.

  • apodization (Attribute: apodization) –

    Type

    ApodizationSpec

    Default

    = ApodizationSpec(startNone, endNone, widthNone, type’ApodizationSpec’)

    Description

    Sets parameters of (optional) apodization. Apodization applies a windowing function to the Fourier transform of the time-domain fields into frequency-domain ones, and can be used to truncate the beginning and/or end of the time signal, for example to eliminate the source pulse when studying the eigenmodes of a system. Note: apodization affects the normalization of the frequency-domain fields.

  • normal_dir (Attribute: normal_dir) –

    Type

    Optional[Literal[β€˜+’, β€˜-β€˜]]

    Default

    = None

    Description

    Direction of the surface monitor’s normal vector w.r.t. the positive x, y or z unit vectors. Must be one of '+' or '-'. Applies to surface monitors only, and defaults to '+' if not provided.

  • exclude_surfaces (Attribute: exclude_surfaces) –

    Type

    Optional[Tuple[Literal[β€˜x-’, β€˜x+’, β€˜y-’, β€˜y+’, β€˜z-’, β€˜z+’], …]]

    Default

    = None

    Description

    Surfaces to exclude in the integration, if a volume monitor.

Notes

If the monitor geometry is a 2D box, the total flux through this plane is returned, with a positive sign corresponding to power flow in the positive direction along the axis normal to the plane. If the geometry is a 3D box, the total power coming out of the box is returned by integrating the flux over all box surfaces (except the ones defined in exclude_surfaces).

Example

>>> monitor = FluxMonitor(
...     center=(1,2,3),
...     size=(2,2,0),
...     freqs=[200e12, 210e12],
...     name='flux_monitor')

Attributes

Methods

storage_size(num_cells,Β tmesh)

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

storage_size(num_cells, tmesh)[source]#

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

__hash__()#

Hash method.