tidy3d.YeeGrid

class YeeGrid

Bases: Tidy3dBaseModel

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

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

• E (FieldGrid) – Coordinates of the locations of all three components of the electric field.

• H (FieldGrid) – 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.
attrs

Methods

Inherited Common Usage

E

H

property grid_dict

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

__hash__()

Hash method.