# ModeSolverMonitor
Monitor that stores the mode field profiles returned by the mode solver in the monitor plane.
# Name
name: Unique name for monitor.
Required field
# Size and Position
Specification of the monitor size and position.
# Center + size
Object definition through a center position and size.
center: Center of the object in x, y, and z-directions.
Type: floating-point number
- Unit: m, μm (default), or nm
- Default: (0, 0, 0)
size: Size of the object in x, y, and z-directions.
Use Infinity to define a geometry extending to infinity in both directions along an axis.
Type: floating-point number
- Unit: m, μm (default), or nm
- Constraint: greater than or equal to 0
- Required field
# Bounds
Object definition through minimum and maximum coordinate bounds.
min: Values of the x, y, and z coordinates defining the object lower corner.
Type: floating-point number
- Unit: m, μm (default), or nm
- Required field
max: Values of the x, y, and z coordinates defining the object upper corner.
Type: floating-point number
- Unit: m, μm (default), or nm
- Required field
# Frequencies
Definition of the monitor wavelengths/frequencies.
Options:
- Wavelengths: Specify monitor wavelengths in units of m, μm (default), or nm.
- Frequencies: Specify monitor frequencies in units of Hz (default) or THz.
Default: Wavelengths
# Enter wavelength/frequency range
Create an evenly spaced list of wavelength/frequency points between a minimum and a maximum value.
min: Minimum wavelength/frequency value.
- Required field Default: None
max: Maximum wavelength/frequency value.
- Required field Default: None
number of points: Number of wavelength/frequency points.
- Required field Default: None
# Custom wavelength/frequency list
Create a custom list of wavelength/frequency points. Click the Edit list button to include, edit, or exclude wavelength/frequency values from the list.
# Direction
direction: Specifies propagation in the positive or negative direction of the injection axis.
Options:
- +: Propogate in the positive direction of the injection axis.
- -: Propogate in the negative direction of the injection axis.
# Field Components
fields: 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.
Options: select one or more of
- Ex
- Ey
- Ez
- Hx
- Hy
- Hz
Default: [Ex, Ey, Ez, Hx, Hy, Hz]
# Downsampling
interval_space: Number of grid step intervals between monitor recordings.
- If equal to 1, there will be no downsampling.
- If greater than 1, fields will be downsampled and automatically colocated.
Type: integer
- Unit: unitless
- Constraint: greater than 0
- Default: (1, 1, 1)
# Colocate Fields
colocate: Toggle whether fields should be colocated to grid cell boundaries (i.e. primal grid nodes).
Options:
- False: Fields will NOT be colocated to grid cell boundaries.
- True: Fields will be colocated to grid cell boundaries.
Default: True
# Mode Specification
mode_spec: Parameters to feed to mode solver which determine modes measured by monitor.
See: ModeSpec
# Apodization
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.
start: Defines the time at which the start apodization ends.
Type: floating-point number
- Unit: s (default), ps, or fs
- Constraint: greater than or equal to 0
Default: None
end: Defines the time at which the end apodization begins.
Type: floating-point number
- Unit: s (default), ps, or fs
- Constraint: greater than or equal to 0
Default: None
width: Characteristic decay length of the apodization function.
Type: floating-point number
- Unit: s (default), ps, or fs
- Constraint: greater than or equal to 0
Default: None