tidy3d.plugins.adjoint.JaxModeData

class JaxModeData

Bases: JaxMonitorData, ModeData

A ModeData registered with jax.

Parameters:

• monitor (Attribute: monitor) –

  Type	Union[FieldMonitor, FieldTimeMonitor, PermittivityMonitor, FluxMonitor, FluxTimeMonitor, ModeMonitor, ModeSolverMonitor, FieldProjectionAngleMonitor, FieldProjectionCartesianMonitor, FieldProjectionKSpaceMonitor, DiffractionMonitor]
  Default
  Description	Monitor associated with the data.

• amps (Attribute: amps) –

  Type	JaxDataArray
  Default
  Description	Jax-compatible modal amplitude data associated with an output monitor.

• n_complex (Attribute: n_complex) –

  Type	ModeIndexDataArray
  Default
  Description	Complex-valued effective propagation constants associated with the mode.

• n_group_raw (Attribute: n_group_raw) –

  Type	Optional[GroupIndexDataArray]
  Default	= None
  Description	Index associated with group velocity of the mode.

• dispersion_raw (Attribute: dispersion_raw) –

  Type	Optional[ModeDispersionDataArray]
  Default	= None
  Units	ps/(nm km)
  Description	Dispersion parameter for the mode.

Attributes

Methods

to_adjoint_sources(fwidth)

Converts a ModeData to a list of adjoint ModeSource.

amps

to_adjoint_sources(fwidth)

Converts a ModeData to a list of adjoint ModeSource.

__hash__()

Hash method.