tidy3d.plugins.adjoint.JaxPermittivityDataset

tidy3d.plugins.adjoint.JaxPermittivityDataset#

class JaxPermittivityDataset[source]#

Bases: PermittivityDataset, JaxObject

A PermittivityDataset 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().

  • eps_xx (JaxDataArray) – Spatial distribution of the xx-component of the relative permittivity.

  • eps_yy (JaxDataArray) – Spatial distribution of the yy-component of the relative permittivity.

  • eps_zz (JaxDataArray) – Spatial distribution of the zz-component of the relative permittivity.

Attributes

attrs

Methods

Inherited Common Usage

eps_xx#
eps_yy#
eps_zz#
__hash__()#

Hash method.