# Flux Monitor

A Flux Monitor is a flux monitor that records electromagnetic power flow in the frequency domain.

This object corresponds to tidy3d.FluxMonitor (opens new window).

# Name

name: Unique name for the monitor.

  • Required field

# Geometry

Specification of the monitor region.

# Center + Size

Object definition through a center position and size.

center: Center of the monitor in x, y, and z-directions.

  • Type: floating-point number
  • Unit: m, mm (default unit), um

size: Size of the monitor in x, y, and z-directions.

  • Type: floating-point number
  • Unit: m, mm (default unit), um
  • 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 lower corner of the monitor.

max: Values of the x, y, and z coordinates defining the upper corner of the monitor.

  • Type: floating-point number
  • Unit: m, mm (default unit), um
  • Required field

# Settings

# Frequency Points

freqs: Frequencies recorded by the monitor.

Frequency points can be entered by range or as a custom list in the frequency settings panel.

See Frequency Settings.

# Advanced

colocate: Toggle whether fields used for flux integration are colocated to grid cell boundaries.

  • Options:
    • True: Use colocated fields for integration.
    • False: Use native Yee-grid field positions where applicable.
  • Default: True

normal_dir: Direction of the monitor normal.

  • Options: +/-
  • Default: + for surface monitors

exclude_surfaces: Surfaces excluded from the integration when the monitor is a volume.

  • Options: x-/x+/y-/y+/z-/z+
  • Default: None

interval_space: Number of grid step intervals between monitor recordings in x, y, and z-directions.

  • Type: three positive integers
  • Default: (1, 1, 1)

apodization: Optional apodization window applied to frequency-domain flux data.

See Apodization Specification.