{
  "title": "YeeGrid",
  "public_path": "flex_rf.tidy3d.YeeGrid",
  "lookup_path": "tidy3d.YeeGrid",
  "slug": "flex_rf/tidy3d/YeeGrid",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/yeegrid/",
  "object_kind": "class",
  "introduction": "Holds the yee grid coordinates for each of the E and H positions.",
  "notes": "",
  "examples": "```python\nx = np.linspace(-1, 1, 10)\ny = np.linspace(-1, 1, 11)\nz = np.linspace(-1, 1, 12)\ncoords = Coords(x=x, y=y, z=z)\nfield_grid = FieldGrid(x=coords, y=coords, z=coords)\nyee_grid = YeeGrid(E=field_grid, H=field_grid)\nEx_coords = yee_grid.E.x\n```",
  "references": "",
  "signature": "class YeeGrid(Tidy3dBaseModel)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/grid/grid.py",
    "url": "",
    "lineno": 361,
    "endlineno": 395
  },
  "bases": [
    "Tidy3dBaseModel"
  ],
  "parameter_rows": [
    {
      "name": "E",
      "annotation": "FieldGrid",
      "default": "",
      "description": "Coordinates of the locations of all three components of the electric field.",
      "origin": "declared"
    },
    {
      "name": "H",
      "annotation": "FieldGrid",
      "default": "",
      "description": "Coordinates of the locations of all three components of the magnetic field.",
      "origin": "declared"
    },
    {
      "name": "attrs",
      "annotation": "dict",
      "default": "factory: dict",
      "description": "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.model_dump_json()`.",
      "origin": "inherited"
    }
  ],
  "members": [
    {
      "name": "grid_dict",
      "kind": "attribute",
      "signature": "grid_dict: dict[str, Coords]",
      "description": "The Yee grid coordinates associated to various field components as a dictionary."
    }
  ],
  "group": "flex_rf.tidy3d"
}