{
  "title": "StablePML",
  "public_path": "flex_rf.tidy3d.StablePML",
  "lookup_path": "tidy3d.StablePML",
  "slug": "flex_rf/tidy3d/StablePML",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/stablepml/",
  "object_kind": "class",
  "introduction": "Specifies a 'stable' PML along a single dimension.\nThis PML deals handles possibly divergent simulations better, but at the expense of more layers.",
  "notes": "",
  "examples": "```python\npml = StablePML(num_layers=40)\n```",
  "references": "",
  "signature": "class StablePML(AbsorberSpec)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/boundary.py",
    "url": "",
    "lineno": 867,
    "endlineno": 917
  },
  "bases": [
    "AbsorberSpec"
  ],
  "parameter_rows": [
    {
      "name": "num_layers",
      "annotation": "int",
      "default": "40",
      "description": "Number of layers of 'stable' PML.",
      "origin": "declared"
    },
    {
      "name": "parameters",
      "annotation": "PMLParams",
      "default": "DefaultStablePMLParameters",
      "description": "'Stable' parameters of the complex frequency-shifted absorption poles.",
      "origin": "declared"
    },
    {
      "name": "extrude_structures",
      "annotation": "bool",
      "default": "True",
      "description": "Automatically extrude structures into the absorbing region (e.g., PML or adiabatic absorber). Any structure located within 2 cells of a simulation boundary will be extended through the full thickness of the PML/absorber. The extruded region is assigned the material properties of the structure 2 cells from the simulation boundary. Extrusion is performed along the direction normal to the PML/absorber surface.",
      "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"
}