Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.ModeSolverMonitor

Type: class │ Base(s): AbstractModeMonitor

Description

Section titled “Description”

Monitor that stores the mode field profiles returned by the mode solver in the monitor plane.

Example(s)

Section titled “Example(s)”
mode_spec = ModeSpec(num_modes=3)
monitor = ModeSolverMonitor(
    center=(1,2,3),
    size=(2,2,0),
    freqs=[200e12, 210e12],
    mode_spec=mode_spec,
    name='mode_monitor')

Parameters

Section titled “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[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 [bool] = True

Toggle whether fields should be colocated to grid cell boundaries (i.e. primal grid nodes).
use_colocated_integration [bool] = True

Only takes effect when colocate=False. If True, dot products and overlap integrals still use fields interpolated to grid cell boundaries (colocated), even though the field data is stored at native Yee grid positions. Experimental feature that can give improved accuracy by avoiding interpolation of fields to Yee cell positions for integration.
apodization [ApodizationSpec] = factory: ApodizationSpec

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.
store_fields_direction [Direction | None] = None

Propagation direction for the mode field profiles stored from mode solving.
conjugated_dot_product [bool] = True

Use conjugated or non-conjugated dot product for mode decomposition.
mode_spec [ModeSpec] = factory: ModeSpec

Parameters to feed to mode solver which determine modes measured by monitor.
direction [Direction] = '+'

Direction of waveguide mode propagation along the axis defined by its normal dimension.
fields [tuple[EMField, ...]] = ('Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz')

Collection of field components to store in the monitor. Note that some methods like flux, dot require all tangential field components, while others like mode_area require all E-field components.

Methods

Section titled “Methods”
set_store_fields()

Ensure ‘store_fields_direction’ is compatible with ‘direction’.
storage_size(num_cells: int, tmesh: int)

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

Machine-Readable Export

Section titled “Machine-Readable Export”