tidy3d.plugins.adjoint.JaxBox

class JaxBox

Bases: JaxGeometry, Box, JaxObject

A Box registered with jax.

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.

• center_jax (Attribute: center_jax) –

  Type	Tuple[Union[float, NumpyArrayType, Array, JVPTracer, object], Union[float, NumpyArrayType, Array, JVPTracer, object], Union[float, NumpyArrayType, Array, JVPTracer, object]]
  Default	= (0.0, 0.0, 0.0)
  Units	um
  Description	Jax traced value for the center of the box in (x, y, z).

• size_jax (Attribute: size_jax) –

  Type	Tuple[Union[float, NumpyArrayType, Array, JVPTracer, object], Union[float, NumpyArrayType, Array, JVPTracer, object], Union[float, NumpyArrayType, Array, JVPTracer, object]]
  Default
  Units	um
  Description	Jax-traced value for the size of the box in (x, y, z).

Attributes

Methods

store_vjp(grad_data_fwd, grad_data_adj, ...)

Stores the gradient of the box parameters given forward and adjoint field data.

center_jax

size_jax

store_vjp(grad_data_fwd, grad_data_adj, grad_data_eps, sim_bounds, wvl_mat, eps_out, eps_in, num_proc=1)

Stores the gradient of the box parameters given forward and adjoint field data.

__hash__()

Hash method.