tidy3d.plugins.adjoint.JaxPermittivityDataset#

class tidy3d.plugins.adjoint.JaxPermittivityDataset#

A PermittivityDataset registered with jax.

Parameters

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.

Show JSON schema

{
   "title": "JaxPermittivityDataset",
   "description": "A :class:`.PermittivityDataset` registered with jax.\n\nParameters\n----------\neps_xx : JaxDataArray\n    Spatial distribution of the xx-component of the relative permittivity.\neps_yy : JaxDataArray\n    Spatial distribution of the yy-component of the relative permittivity.\neps_zz : JaxDataArray\n    Spatial distribution of the zz-component of the relative permittivity.",
   "type": "object",
   "properties": {
      "type": {
         "title": "Type",
         "default": "JaxPermittivityDataset",
         "enum": [
            "JaxPermittivityDataset"
         ],
         "type": "string"
      },
      "eps_xx": {
         "title": "Epsilon xx",
         "description": "Spatial distribution of the xx-component of the relative permittivity.",
         "jax_field": true,
         "allOf": [
            {
               "$ref": "#/definitions/JaxDataArray"
            }
         ]
      },
      "eps_yy": {
         "title": "Epsilon yy",
         "description": "Spatial distribution of the yy-component of the relative permittivity.",
         "jax_field": true,
         "allOf": [
            {
               "$ref": "#/definitions/JaxDataArray"
            }
         ]
      },
      "eps_zz": {
         "title": "Epsilon zz",
         "description": "Spatial distribution of the zz-component of the relative permittivity.",
         "jax_field": true,
         "allOf": [
            {
               "$ref": "#/definitions/JaxDataArray"
            }
         ]
      }
   },
   "required": [
      "eps_xx",
      "eps_yy",
      "eps_zz"
   ],
   "additionalProperties": false,
   "definitions": {
      "JaxDataArray": {
         "title": "JaxDataArray",
         "description": "A :class:`.DataArray`-like class that only wraps xarray for jax compability.\n\nParameters\n----------\nvalues : Optional[Any]\n    Nested list containing the raw values, which can be tracked by jax.\ncoords : Mapping[str, list]\n    Dictionary storing the coordinates, namely ``(direction, f, mode_index)``.",
         "type": "object",
         "properties": {
            "values": {
               "title": "Values",
               "description": "Nested list containing the raw values, which can be tracked by jax.",
               "jax_field": true
            },
            "coords": {
               "title": "Coords",
               "description": "Dictionary storing the coordinates, namely ``(direction, f, mode_index)``.",
               "type": "object",
               "additionalProperties": {
                  "type": "array",
                  "items": {}
               }
            },
            "type": {
               "title": "Type",
               "default": "JaxDataArray",
               "enum": [
                  "JaxDataArray"
               ],
               "type": "string"
            }
         },
         "required": [
            "values",
            "coords"
         ],
         "additionalProperties": false
      }
   }
}

attribute eps_xx: tidy3d.plugins.adjoint.components.data.data_array.JaxDataArray [Required]#: Spatial distribution of the xx-component of the relative permittivity.

attribute eps_yy: tidy3d.plugins.adjoint.components.data.data_array.JaxDataArray [Required]#: Spatial distribution of the yy-component of the relative permittivity.

attribute eps_zz: tidy3d.plugins.adjoint.components.data.data_array.JaxDataArray [Required]#: Spatial distribution of the zz-component of the relative permittivity.