Ctrl+K

tidy3d.components.monitor.PlanarMonitor

tidy3d.components.monitor.PlanarMonitor#

class PlanarMonitor[source]#

Bases: Monitor, ABC

Monitor that has a planar geometry.

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

normal_axis

Axis normal to the monitor's plane.

Methods

property normal_axis#

Axis normal to the monitor’s plane.

__hash__()#

Hash method.