tidy3d.components.monitor.AbstractFieldMonitor

class AbstractFieldMonitor

Bases: Monitor, ABC

Monitor that records electromagnetic field data as a function of x,y,z.

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[PositiveInt, PositiveInt, PositiveInt]
  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.

• colocate (Attribute: colocate) –

  Type	bool
  Default	= True
  Description	Toggle whether fields should be colocated to grid cell boundaries (i.e. primal grid nodes).

• fields (Attribute: fields) –

  Type	Tuple[Literal[‘Ex’, ‘Ey’, ‘Ez’, ‘Hx’, ‘Hy’, ‘Hz’], …]
  Default	= [‘Ex’, ‘Ey’, ‘Ez’, ‘Hx’, ‘Hy’, ‘Hz’]
  Description	Collection of field components to store in the monitor.

Attributes

Methods

fields

interval_space

colocate

__hash__()

Hash method.