tidy3d.plugins.adjoint.JaxMedium

class JaxMedium

Bases: Medium, AbstractJaxMedium

A Medium registered with jax.

Parameters:

• name (Attribute: name) –

  Type	Optional[str]
  Default	= None
  Description	Optional unique name for medium.

• frequency_range (Attribute: frequency_range) –

  Type	Optional[Tuple[float, float]]
  Default	= None
  Units	(Hz, Hz)
  Description	Optional range of validity for the medium.

• allow_gain (Attribute: allow_gain) –

  Type	bool
  Default	= False
  Description	Allow the medium to be active. Caution: simulations with a gain medium are unstable, and are likely to diverge.Simulations where ‘allow_gain’ is set to ‘True’ will still be charged even if diverged. Monitor data up to the divergence point will still be returned and can be useful in some cases.

• nonlinear_spec (Attribute: nonlinear_spec) –

  Type	Union[NonlinearSpec, NonlinearSusceptibility]
  Default	= None
  Description	Nonlinear spec applied on top of the base medium properties.

• modulation_spec (Attribute: modulation_spec) –

  Type	Optional[ModulationSpec]
  Default	= None
  Description	Modulation spec applied on top of the base medium properties.

• heat_spec (Attribute: heat_spec) –

  Type	Union[FluidSpec, SolidSpec, NoneType]
  Default	= None
  Description	Specification of the medium heat properties. They are used for solving the heat equation via the HeatSimulation interface. Such simulations can be used for investigating the influence of heat propagation on the properties of optical systems. Once the temperature distribution in the system is found using HeatSimulation object, Simulation.perturbed_mediums_copy() can be used to convert mediums with perturbation models defined into spatially dependent custom mediums. Otherwise, the heat_spec does not directly affect the running of an optical Simulation.

• permittivity (Attribute: permittivity) –

  Type	ConstrainedFloatValue
  Default	= 1.0
  Units	None (relative permittivity)
  Description	Relative permittivity.

• conductivity (Attribute: conductivity) –

  Type	float
  Default	= 0.0
  Units	S/um
  Description	Electric conductivity. Defined such that the imaginary part of the complex permittivity at angular frequency omega is given by conductivity/omega.

• permittivity_jax (Attribute: permittivity_jax) –

  Type	Union[float, NumpyArrayType, Array, JVPTracer, object]
  Default	= 1.0
  Description	Relative permittivity of the medium. May be a jax Array.

• conductivity_jax (Attribute: conductivity_jax) –

  Type	Union[float, NumpyArrayType, Array, JVPTracer, object]
  Default	= 0.0
  Units	S/um
  Description	Electric conductivity. Defined such that the imaginary part of the complex permittivity at angular frequency omega is given by conductivity/omega.

Attributes

Methods

store_vjp(grad_data_fwd, grad_data_adj, ...)

Returns the gradient of the medium parameters given forward and adjoint field data.

permittivity_jax

conductivity_jax

store_vjp(grad_data_fwd, grad_data_adj, sim_bounds, wvl_mat, inside_fn)

Returns the gradient of the medium parameters given forward and adjoint field data.

__hash__()

Hash method.