{
  "title": "SurfaceImpedance",
  "public_path": "flex_rf.tidy3d.SurfaceImpedance",
  "lookup_path": "tidy3d.rf.SurfaceImpedance",
  "slug": "flex_rf/tidy3d/SurfaceImpedance",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/surfaceimpedance/",
  "object_kind": "class",
  "introduction": "Apply 1st order (Leontovich) surface impedance boundary condition to\nstructure made of `LossyMetalMedium`.",
  "notes": "",
  "examples": "",
  "references": "",
  "signature": "class SurfaceImpedance(PECConformal)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/subpixel_spec.py",
    "url": "",
    "lineno": 148,
    "endlineno": 161
  },
  "bases": [
    "PECConformal"
  ],
  "parameter_rows": [
    {
      "name": "timestep_reduction",
      "annotation": "float",
      "default": "DEFAULT_COURANT_REDUCTION_SIBC_CONFORMAL",
      "description": "Reduction factor between 0 and 1 such that the simulation's time step size is `1 - timestep_reduction` times its default value. Accuracy can be improved with a smaller time step size, but the simulation time will be increased.",
      "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": "edge_singularity_correction",
      "annotation": "bool",
      "default": "True",
      "description": "Apply field correction model at metallic edges where field singularity occurs. The edges should be straight, and aligned with the primal grids; and the wedge angle is either 0 or 90 degree.",
      "origin": "inherited"
    }
  ],
  "members": [],
  "group": "flex_rf.tidy3d"
}