{
  "title": "ABCBoundary",
  "public_path": "flex_rf.tidy3d.ABCBoundary",
  "lookup_path": "tidy3d.ABCBoundary",
  "slug": "flex_rf/tidy3d/ABCBoundary",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/abcboundary/",
  "object_kind": "class",
  "introduction": "One-way wave equation absorbing boundary conditions.\nSee, for example, John B. Schneider, Understanding the Finite-Difference Time-Domain Method, Chapter 6.",
  "notes": "",
  "examples": "",
  "references": "",
  "signature": "class ABCBoundary(AbstractABCBoundary)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/boundary.py",
    "url": "",
    "lineno": 122,
    "endlineno": 154
  },
  "bases": [
    "AbstractABCBoundary"
  ],
  "parameter_rows": [
    {
      "name": "permittivity",
      "annotation": "float | None",
      "default": "None",
      "description": "Effective permittivity for determining propagation constant. If `None`, this value will be automatically inferred from the medium at the domain boundary and the central frequency of the source.",
      "origin": "declared"
    },
    {
      "name": "conductivity",
      "annotation": "NonNegativeFloat | None",
      "default": "None",
      "description": "Effective conductivity for determining propagation constant. If `None`, this value will be automatically inferred from the medium at the domain boundary and the central frequency of the source.",
      "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"
    },
    {
      "name": "name",
      "annotation": "str | None",
      "default": "None",
      "description": "Optional unique name for boundary.",
      "origin": "inherited"
    }
  ],
  "members": [],
  "group": "flex_rf.tidy3d"
}