tidy3d.components.monitor.TimeMonitor

tidy3d.components.monitor.TimeMonitor#

class TimeMonitor[source]#

Bases: Monitor, ABC

Monitor that records data in the time-domain.

Parameters:

  • center (Optional[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]]] = None) – [units = um]. Center of object in x, y, and z.

  • size (tuple[Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box]]) – [units = um]. Size in x, y, and z directions.

  • name (str) – Unique name for monitor.

  • 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 (Literal[True] = True) – Defines whether fields are colocated to grid cell boundaries (i.e. to the primal grid). Can be toggled for field recording monitors and is hard-coded for other monitors depending on their specific function.

  • use_colocated_integration (Literal[True] = True) – Whether to use colocated fields for flux, dot products, and overlap integrals. Hard-coded to True for most monitor types. Can be toggled on field and overlap monitors.

  • start (NonNegativeFloat = 0.0) – [units = sec]. Time at which to start monitor recording.

  • stop (Optional[NonNegativeFloat] = None) – [units = sec]. Time at which to stop monitor recording. If not specified, record until end of simulation.

  • interval (Optional[PositiveInt] = None) – Sampling rate of the monitor: number of time steps between each measurement. Set interval to 1 for the highest possible resolution in time. Higher integer values downsample the data by measuring every interval time steps. This can be useful for reducing data storage as needed by the application.

Attributes

start

stop

interval

interval_space

colocate

use_colocated_integration

name

size

center

Methods

num_steps(tmesh)

Compute number of time steps for a time monitor.

stop_greater_than_start()

Ensure sure stop is greater than or equal to start.

time_inds(tmesh)

Compute the starting and stopping index of the monitor in a given discrete time mesh.
start#
stop#
interval#
stop_greater_than_start()[source]#

Ensure sure stop is greater than or equal to start.

time_inds(tmesh)[source]#

Compute the starting and stopping index of the monitor in a given discrete time mesh.

num_steps(tmesh)[source]#

Compute number of time steps for a time monitor.