{
  "title": "CoaxialLumpedResistor",
  "public_path": "flex_rf.tidy3d.CoaxialLumpedResistor",
  "lookup_path": "tidy3d.rf.CoaxialLumpedResistor",
  "slug": "flex_rf/tidy3d/CoaxialLumpedResistor",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/coaxiallumpedresistor/",
  "object_kind": "class",
  "introduction": "Class representing a coaxial lumped resistor. Lumped resistors are appended to the list of\nstructures in the simulation as `Medium2D` with the appropriate conductivity given their\nsize and geometry.",
  "notes": "",
  "examples": "",
  "references": "",
  "signature": "class CoaxialLumpedResistor(LumpedElement)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/lumped_element.py",
    "url": "",
    "lineno": 460,
    "endlineno": 596
  },
  "bases": [
    "LumpedElement"
  ],
  "parameter_rows": [
    {
      "name": "resistance",
      "annotation": "PositiveFloat",
      "default": "",
      "description": "Resistance value in ohms.",
      "origin": "declared"
    },
    {
      "name": "center",
      "annotation": "Coordinate",
      "default": "(0.0, 0.0, 0.0)",
      "description": "Center of object in x, y, and z.",
      "origin": "declared"
    },
    {
      "name": "outer_diameter",
      "annotation": "PositiveFloat",
      "default": "",
      "description": "Diameter of the outer concentric circle.",
      "origin": "declared"
    },
    {
      "name": "inner_diameter",
      "annotation": "PositiveFloat",
      "default": "",
      "description": "Diameter of the inner concentric circle.",
      "origin": "declared"
    },
    {
      "name": "normal_axis",
      "annotation": "Axis",
      "default": "",
      "description": "Specifies the normal axis, which defines the orientation of the circles making up the coaxial lumped element.",
      "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",
      "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"
    }
  ],
  "members": [
    {
      "name": "geometry",
      "kind": "function",
      "signature": "geometry()",
      "description": "Alias for `to_geometry` that ignores the grid and allows `CoaxialLumpedResistor` to behave like a `Structure`."
    },
    {
      "name": "to_geometry",
      "kind": "function",
      "signature": "to_geometry(grid: Grid | None = None)",
      "description": "Converts the `CoaxialLumpedResistor` object to a `Geometry`."
    },
    {
      "name": "to_mesh_overrides",
      "kind": "function",
      "signature": "to_mesh_overrides()",
      "description": "Creates a suggested `MeshOverrideStructure` list for mesh refinement both on the plane of lumped element, and along normal axis. In the normal direction, we'll make sure there are at least 2 cell layers above and below whose size is half of the in-plane cell size in the override region."
    },
    {
      "name": "to_snapping_points",
      "kind": "function",
      "signature": "to_snapping_points()",
      "description": "Creates a suggested snapping point list to ensure that the element is aligned with a grid boundary in the normal direction."
    },
    {
      "name": "to_structure",
      "kind": "function",
      "signature": "to_structure(grid: Grid | None = None, frequency_range: FreqBound | None = None)",
      "description": "Converts the `CoaxialLumpedResistor` object to a `Structure` ready to be added to the `Simulation`"
    }
  ],
  "group": "flex_rf.tidy3d"
}