tidy3d.components.monitor.AbstractFluxMonitor

class AbstractFluxMonitor

Bases: SurfaceIntegrationMonitor, ABC

Monitor that records flux during the solver run.

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.

• normal_dir (Attribute: normal_dir) –

  Type	Optional[Literal[‘+’, ‘-‘]]
  Default	= None
  Description	Direction of the surface monitor’s normal vector w.r.t. the positive x, y or z unit vectors. Must be one of '+' or '-'. Applies to surface monitors only, and defaults to '+' if not provided.

• exclude_surfaces (Attribute: exclude_surfaces) –

  Type	Optional[Tuple[Literal[‘x-’, ‘x+’, ‘y-’, ‘y+’, ‘z-’, ‘z+’], …]]
  Default	= None
  Description	Surfaces to exclude in the integration, if a volume monitor.

Attributes

Methods

__hash__()

Hash method.