tidy3d.PermittivityDataset

class tidy3d.PermittivityDataset

Dataset storing the diagonal components of the permittivity tensor.

Parameters

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

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

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

Example

>>> x = [-1,1]
>>> y = [-2,0,2]
>>> z = [-3,-1,1,3]
>>> f = [2e14, 3e14]
>>> coords = dict(x=x, y=y, z=z, f=f)
>>> sclr_fld = ScalarFieldDataArray((1+1j) * np.random.random((2,3,4,2)), coords=coords)
>>> data = PermittivityDataset(eps_xx=sclr_fld, eps_yy=sclr_fld, eps_zz=sclr_fld)

Show JSON schema

{
   "title": "PermittivityDataset",
   "description": "Dataset storing the diagonal components of the permittivity tensor.\n\nParameters\n----------\neps_xx : ScalarFieldDataArray\n    Spatial distribution of the xx-component of the relative permittivity.\neps_yy : ScalarFieldDataArray\n    Spatial distribution of the yy-component of the relative permittivity.\neps_zz : ScalarFieldDataArray\n    Spatial distribution of the zz-component of the relative permittivity.\n\nExample\n-------\n>>> x = [-1,1]\n>>> y = [-2,0,2]\n>>> z = [-3,-1,1,3]\n>>> f = [2e14, 3e14]\n>>> coords = dict(x=x, y=y, z=z, f=f)\n>>> sclr_fld = ScalarFieldDataArray((1+1j) * np.random.random((2,3,4,2)), coords=coords)\n>>> data = PermittivityDataset(eps_xx=sclr_fld, eps_yy=sclr_fld, eps_zz=sclr_fld)",
   "type": "object",
   "properties": {
      "type": {
         "title": "Type",
         "default": "PermittivityDataset",
         "enum": [
            "PermittivityDataset"
         ],
         "type": "string"
      },
      "eps_xx": {
         "title": "DataArray",
         "description": "Spatial distribution of the xx-component of the relative permittivity.",
         "type": "xr.DataArray",
         "properties": {
            "_dims": {
               "title": "_dims",
               "type": "Tuple[str, ...]"
            }
         },
         "required": [
            "_dims"
         ]
      },
      "eps_yy": {
         "title": "DataArray",
         "description": "Spatial distribution of the yy-component of the relative permittivity.",
         "type": "xr.DataArray",
         "properties": {
            "_dims": {
               "title": "_dims",
               "type": "Tuple[str, ...]"
            }
         },
         "required": [
            "_dims"
         ]
      },
      "eps_zz": {
         "title": "DataArray",
         "description": "Spatial distribution of the zz-component of the relative permittivity.",
         "type": "xr.DataArray",
         "properties": {
            "_dims": {
               "title": "_dims",
               "type": "Tuple[str, ...]"
            }
         },
         "required": [
            "_dims"
         ]
      }
   },
   "required": [
      "eps_xx",
      "eps_yy",
      "eps_zz"
   ],
   "additionalProperties": false
}

attribute eps_xx: tidy3d.components.data.data_array.ScalarFieldDataArray [Required]

Spatial distribution of the xx-component of the relative permittivity.

Constraints

• title = DataArray

• type = xr.DataArray

• properties = {‘_dims’: {‘title’: ‘_dims’, ‘type’: ‘Tuple[str, …]’}}

• required = [‘_dims’]

attribute eps_yy: tidy3d.components.data.data_array.ScalarFieldDataArray [Required]

Spatial distribution of the yy-component of the relative permittivity.

Constraints

• title = DataArray

• type = xr.DataArray

• properties = {‘_dims’: {‘title’: ‘_dims’, ‘type’: ‘Tuple[str, …]’}}

• required = [‘_dims’]

attribute eps_zz: tidy3d.components.data.data_array.ScalarFieldDataArray [Required]

Spatial distribution of the zz-component of the relative permittivity.

Constraints

• title = DataArray

• type = xr.DataArray

• properties = {‘_dims’: {‘title’: ‘_dims’, ‘type’: ‘Tuple[str, …]’}}

• required = [‘_dims’]

property field_components: Dict[str, tidy3d.components.data.data_array.ScalarFieldDataArray]

Maps the field components to thier associated data.

property grid_locations: Dict[str, str]

Maps field components to the string key of their grid locations on the yee lattice.

property symmetry_eigenvalues: Dict[str, Callable[[Literal[0, 1, 2]], float]]

Maps field components to their (positive) symmetry eigenvalues.