tidy3d.components.monitor.Monitor#

class Monitor[source]#

Bases: AbstractMonitor

Abstract base class for monitors.

Parameters:
  • center (Tuple[float, float, float] = (0.0, 0.0, 0.0)) โ€“ [units = um]. Center of object in x, y, and z.

  • size (Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]) โ€“ [units = um]. Size in x, y, and z directions.

  • name (ConstrainedStrValue) โ€“ 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) 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.

Attributes

Methods

storage_size(num_cells,ย tmesh)

Size of monitor storage given the number of points after discretization.

Inherited Common Usage

interval_space#
colocate#
abstract storage_size(num_cells, tmesh)[source]#

Size of monitor storage given the number of points after discretization.

__hash__()#

Hash method.