tidy3d.components.monitor.TimeMonitor

class TimeMonitor

Bases: Monitor, ABC

Monitor that records data in the time-domain.

Parameters:

• center (Attribute: center) –

  Type	Tuple[float, float, float]
  Default	= (0.0, 0.0, 0.0)
  Units	um
  Description	Center of object in x, y, and z.

• size (Attribute: size) –

  Type	Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]
  Default
  Units	um
  Description	Size in x, y, and z directions.

• name (Attribute: name) –

  Type	ConstrainedStrValue
  Default
  Description	Unique name for monitor.

• interval_space (Attribute: interval_space) –

  Type	Tuple[Literal[1], Literal[1], Literal[1]]
  Default	= (1, 1, 1)
  Description	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 (Attribute: colocate) –

  Type	Literal[True]
  Default	= True
  Description	Defines whether fields are colocated to grid cell boundaries (i.e. to the primal grid) on-the-fly during a solver run. Can be toggled for field recording monitors and is hard-coded for other monitors depending on their specific function.

• start (Attribute: start) –

  Type	NonNegativeFloat
  Default	= 0.0
  Units	sec
  Description	Time at which to start monitor recording.

• stop (Attribute: stop) –

  Type	Optional[NonNegativeFloat]
  Default	= None
  Units	sec
  Description	Time at which to stop monitor recording. If not specified, record until end of simulation.

• interval (Attribute: interval) –

  Type	Optional[PositiveInt]
  Default	= None
  Description	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

Methods

num_steps(tmesh)	Compute number of time steps for a time monitor.
stop_greater_than_start(val, values)	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

classmethod stop_greater_than_start(val, values)

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.

num_steps(tmesh)

Compute number of time steps for a time monitor.

__hash__()

Hash method.