tidy3d.PermittivityDataset#

class PermittivityDataset[source]#

Bases: AbstractFieldDataset

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)

Attributes

field_components

Maps the field components to their associated data.

grid_locations

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

symmetry_eigenvalues

Maps field components to their (positive) symmetry eigenvalues.

Methods

Inherited Common Usage

property field_components#

Maps the field components to their associated data.

property grid_locations#

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

property symmetry_eigenvalues#

Maps field components to their (positive) symmetry eigenvalues.

eps_xx#
eps_yy#
eps_zz#
__hash__()#

Hash method.