tidy3d.YeeGrid#

class YeeGrid[source]#

Bases: Tidy3dBaseModel

Holds the yee grid coordinates for each of the E and H positions.

Parameters:
  • E (Attribute: E) –

    Type

    FieldGrid

    Default

    Description

    Coordinates of the locations of all three components of the electric field.

  • H (Attribute: H) –

    Type

    FieldGrid

    Default

    Description

    Coordinates of the locations of all three components of the magnetic field.

Example

>>> x = np.linspace(-1, 1, 10)
>>> y = np.linspace(-1, 1, 11)
>>> z = np.linspace(-1, 1, 12)
>>> coords = Coords(x=x, y=y, z=z)
>>> field_grid = FieldGrid(x=coords, y=coords, z=coords)
>>> yee_grid = YeeGrid(E=field_grid, H=field_grid)
>>> Ex_coords = yee_grid.E.x

Attributes

grid_dict

The Yee grid coordinates associated to various field components as a dictionary.

Methods

E#
H#
property grid_dict#

The Yee grid coordinates associated to various field components as a dictionary.

__hash__()#

Hash method.