{
  "title": "UniformGrid",
  "public_path": "flex_rf.tidy3d.UniformGrid",
  "lookup_path": "tidy3d.UniformGrid",
  "slug": "flex_rf/tidy3d/UniformGrid",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/uniformgrid/",
  "object_kind": "class",
  "introduction": "Uniform 1D grid. The most standard way to define a simulation is to use a constant grid size in each of the three directions.",
  "notes": "",
  "examples": "```python\ngrid_1d = UniformGrid(dl=0.1)\n```",
  "references": "",
  "signature": "class UniformGrid(GridSpec1d)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/grid/grid_spec.py",
    "url": "",
    "lineno": 401,
    "endlineno": 496
  },
  "bases": [
    "GridSpec1d"
  ],
  "parameter_rows": [
    {
      "name": "dl",
      "annotation": "PositiveFloat",
      "default": "",
      "description": "Grid size for uniform grid generation.",
      "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": "estimated_min_dl",
      "kind": "function",
      "signature": "estimated_min_dl(wavelength: float, structure_list: list[Structure], sim_size: tuple[float, 3])",
      "description": "Minimal grid size, which equals grid size here."
    }
  ],
  "group": "flex_rf.tidy3d"
}