# Flux Time Monitor

A Flux Time Monitor records electromagnetic power flux in the time domain.

This object corresponds to tidy3d.FluxTimeMonitor (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

# Time

start: Time at which to start monitor recording.

  • Type: non-negative floating-point number
  • Unit: s, ms, us, ns (default unit), ps, fs
  • Default: 0

stop: Time at which to stop monitor recording. If no value is specified, recording continues until the end of the simulation.

  • Type: non-negative floating-point number
  • Unit: s, ms, us, ns (default unit), ps, fs
  • Default: end of simulation

interval: Number of simulation time steps between recorded measurements. Set the interval to 1 for the highest available time resolution; higher values reduce the number of recorded samples.

  • Type: positive integer
  • Default: 1

# Advanced

colocate: Toggle whether fields used for flux integration are colocated to grid cell boundaries. This field is labeled Colocate fields in the GUI.

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

normal_dir: Direction of the monitor normal for a 2D surface.

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

exclude_surfaces: Surfaces excluded from the integration for a 3D volume monitor.

  • Options: X+ (x+), X- (x-), Y+ (y+), Y- (y-), Z+ (z+), Z- (z-)
  • Default: None

NOTE

For a 2D monitor, the result is the total flux through the plane. Positive flux corresponds to power flow in the direction selected by normal_dir.

For a 3D box, the result is the total outward power integrated over the box surfaces. Use exclude_surfaces to omit selected surfaces from this integration.

← Directivity Monitor →