# Surface Field Time Monitor

A Surface Field Time Monitor records electromagnetic fields in the time domain on perfect electric conductor (PEC) and non-penetrable lossy-metal surfaces inside a three-dimensional monitor region. Selecting E records the electric field normal to each surface, while selecting H records the magnetic field tangential to each surface. Use this monitor to analyze the time dependence of surface fields or create animations of field-pattern evolution.

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

The monitor region must have a nonzero size along all three axes.

WARNING

Surface monitors are currently a beta feature. Verify surface monitor results carefully.

# Name

name: Unique name for the monitor.

  • Required field

# Geometry

Specification of the three-dimensional 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 0 along every axis
  • 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.

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

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

NOTE

Surface monitors require a 3D volume. The minimum and maximum bounds must differ along every axis; 1D and 2D regions are not supported.

# Settings

# Fields

fields: Surface field groups stored by the monitor.

  • Options:
    • E: Electric field normal to each supported metal surface.
    • H: Magnetic field tangential to each supported metal surface.
  • Default: E and H
  • Constraint: select at least one field group

NOTE

Selecting only E records the normal electric field, but derived surface current density Js is unavailable. Selecting only H records the tangential magnetic field and supports derived Js. Poynting-vector data requires both E and H. Selecting neither E nor H is invalid.

# 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 samples. Set the interval to 1 for the highest available time resolution; higher values downsample the data and reduce the number of recorded samples.

  • Type: positive integer
  • Default: 1

NOTE

Recording surface fields at every time step and grid point can produce a large dataset. Increase interval when full time resolution is not required.

# Advanced

colocate: Colocate the recorded fields on each supported metal surface. This setting is labeled Colocate fields in the GUI.

  • Type: boolean
  • Default: True
  • Constraint: fixed to True for surface monitors

use_colocated_integration: Use colocated fields for flux, dot-product, and overlap integrations. This setting is labeled Use colocated integration in the GUI.

  • Type: boolean
  • Default: True
  • Constraint: fixed to True for surface monitors

interval_space: Number of grid-step intervals between recorded points in the x, y, and z-directions. This setting is labeled Subsample spatial grid in the GUI.

  • Type: three positive integers
  • Default: (1, 1, 1)
  • Constraint: fixed to (1, 1, 1); spatial downsampling is not currently supported