{
  "title": "LumpedResistor",
  "public_path": "flex_rf.tidy3d.LumpedResistor",
  "lookup_path": "tidy3d.rf.LumpedResistor",
  "slug": "flex_rf/tidy3d/LumpedResistor",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/lumpedresistor/",
  "object_kind": "class",
  "introduction": "Class representing a rectangular lumped resistor. Lumped resistors are appended to the list\nof structures in the simulation as `Medium2D` with the appropriate conductivity given\ntheir size and voltage axis.",
  "notes": "",
  "examples": "",
  "references": "",
  "signature": "class LumpedResistor(RectangularLumpedElement)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/lumped_element.py",
    "url": "",
    "lineno": 423,
    "endlineno": 457
  },
  "bases": [
    "RectangularLumpedElement"
  ],
  "parameter_rows": [
    {
      "name": "resistance",
      "annotation": "PositiveFloat",
      "default": "",
      "description": "Resistance value in ohms.",
      "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": "center",
      "annotation": "TracedCoordinate",
      "default": "(0.0, 0.0, 0.0)",
      "description": "Center of object in x, y, and z.",
      "origin": "inherited"
    },
    {
      "name": "size",
      "annotation": "TracedSize",
      "default": "",
      "description": "Size in x, y, and z directions.",
      "origin": "inherited"
    },
    {
      "name": "name",
      "annotation": "str",
      "default": "",
      "description": "Unique name for the lumped element.",
      "origin": "inherited"
    },
    {
      "name": "num_grid_cells",
      "annotation": "PositiveInt | None",
      "default": "DEFAULT_LUMPED_ELEMENT_NUM_CELLS",
      "description": "Number of mesh grid cells associated with the lumped element along each direction. Used in generating the suggested list of `MeshOverrideStructure` objects. A value of `None` will turn off mesh refinement suggestions.",
      "origin": "inherited"
    },
    {
      "name": "enable_snapping_points",
      "annotation": "bool",
      "default": "True",
      "description": "When enabled, snapping points are automatically generated to snap grids to key geometric features of the lumped element for more accurate modelling.",
      "origin": "inherited"
    },
    {
      "name": "voltage_axis",
      "annotation": "Axis",
      "default": "",
      "description": "Specifies the axis along which the component is oriented and along which the associated voltage drop will occur. Must be in the plane of the element.",
      "origin": "inherited"
    },
    {
      "name": "snap_perimeter_to_grid",
      "annotation": "bool",
      "default": "True",
      "description": "When enabled, the perimeter of the lumped element is snapped to the simulation grid, which improves accuracy when the number of grid cells is low within the element. Sides of the element perpendicular to the `voltage_axis` are snapped to grid boundaries, while the sides parallel to the `voltage_axis` are snapped to grid centers. Lumped elements are always snapped to the nearest grid boundary along their `normal_axis`, regardless of this option.",
      "origin": "inherited"
    }
  ],
  "members": [
    {
      "name": "to_structure",
      "kind": "function",
      "signature": "to_structure(grid: Grid | None = None, frequency_range: FreqBound | None = None)",
      "description": "Converts the `LumpedResistor` object to a `Structure` ready to be added to the `Simulation`"
    }
  ],
  "group": "flex_rf.tidy3d"
}