tidy3d.plugins.adjoint.JaxStructure

tidy3d.plugins.adjoint.JaxStructure#

class JaxStructure[source]#

Bases: AbstractJaxStructure, JaxObject

A Structure registered with jax.

Parameters:

  • attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

  • geometry (Union[JaxBox, JaxPolySlab, JaxGeometryGroup]) – Geometry of the structure, which is jax-compatible.

  • name (Optional[str] = None) – Optional name for the structure.

  • background_permittivity (Optional[ConstrainedFloatValue] = None) – Relative permittivity used for the background of this structure when performing shape optimization with autograd.

  • medium (Union[JaxMedium, JaxAnisotropicMedium, JaxCustomMedium]) – Medium of the structure, which is jax-compatible.

Attributes

attrs

Methods

Inherited Common Usage

geometry#
medium#
__hash__()#

Hash method.