{
  "title": "VolumetricAveraging",
  "public_path": "flex_rf.tidy3d.VolumetricAveraging",
  "lookup_path": "tidy3d.VolumetricAveraging",
  "slug": "flex_rf/tidy3d/VolumetricAveraging",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/volumetricaveraging/",
  "object_kind": "class",
  "introduction": "Apply volumetric averaging scheme to material properties of Yee grids on structure boundaries.\nThe material property is averaged in the volume surrounding the Yee grid.",
  "notes": "",
  "examples": "",
  "references": "",
  "signature": "class VolumetricAveraging(AbstractSubpixelAveragingMethod)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/subpixel_spec.py",
    "url": "",
    "lineno": 76,
    "endlineno": 88
  },
  "bases": [
    "AbstractSubpixelAveragingMethod"
  ],
  "parameter_rows": [
    {
      "name": "staircase_normal_component",
      "annotation": "bool",
      "default": "True",
      "description": "Volumetric averaging works accurately if the electric field component is substantially tangential to the interface. If `True`, apply volumetric averaging only if the field component is largely tangential to the interface; if `False`, apply volumetric averaging regardless of how field component orients with the interface.",
      "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": [],
  "group": "flex_rf.tidy3d"
}