flex_rf.tidy3d.FluxTimeMonitor

Type: class │ Base(s): AbstractFluxMonitor, TimeMonitor

Description

Monitor that records power flux in the time domain.

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(s)

monitor = FluxTimeMonitor(
    center=(1,2,3),
    size=(2,2,0),
    start=1e-13,
    stop=5e-13,
    interval=2,
    name='flux_vs_time')

Parameters

size [TracedSize]

Size in x, y, and z directions.

name [str]

Unique name for monitor.

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

Center of object in x, y, and z.

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.

colocate [Literal[True]] = True

Defines whether fields are colocated to grid cell boundaries (i.e. to the primal grid). Can be toggled for field recording monitors and is hard-coded for other monitors depending on their specific function.

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.

start [NonNegativeFloat] = 0.0

Time at which to start monitor recording.

stop [NonNegativeFloat | None] = None

Time at which to stop monitor recording. If not specified, record until end of simulation.

interval [PositiveInt | None] = None

Sampling rate of the monitor: number of time steps between each measurement. Set interval to 1 for the highest possible resolution in time. Higher integer values downsample the data by measuring every interval time steps. This can be useful for reducing data storage as needed by the application.

normal_dir [Direction | None] = None

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 [tuple[BoxSurface, ...] | None] = None

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

Methods

storage_size(num_cells: int, tmesh: ArrayFloat1D)

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