tidy3d.plugins.adjoint.JaxAnisotropicMedium

class JaxAnisotropicMedium

Bases: AnisotropicMedium, 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	Optional[bool]
  Default	= None
  Description	This field is ignored. Please set allow_gain in each component

• 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.

• xx (Attribute: xx) –

  Type	JaxMedium
  Default
  Description	Medium describing the xx-component of the diagonal permittivity tensor.

• yy (Attribute: yy) –

  Type	JaxMedium
  Default
  Description	Medium describing the yy-component of the diagonal permittivity tensor.

• zz (Attribute: zz) –

  Type	JaxMedium
  Default
  Description	Medium describing the zz-component of the diagonal permittivity tensor.

Attributes

Methods

store_vjp(grad_data_fwd, grad_data_adj, ...)

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

xx

yy

zz

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.