{
  "title": "RLCNetwork",
  "public_path": "flex_rf.tidy3d.RLCNetwork",
  "lookup_path": "tidy3d.rf.RLCNetwork",
  "slug": "flex_rf/tidy3d/RLCNetwork",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/rlcnetwork/",
  "object_kind": "class",
  "introduction": "Class for representing a simple network consisting of a resistor, capacitor, and inductor.\nProvides additional functionality for representing the network as an equivalent medium.",
  "notes": "Implementation is based on the equivalent medium introduced by [1].",
  "examples": "```python\nRL_series = RLCNetwork(resistance=75,\n                       inductance=1e-9,\n                       network_topology=\"series\")\n```",
  "references": "**[1]** J. A. Pereda, F. Alimenti, P. Mezzanotte, L. Roselli and R. Sorrentino, \"A new algorithm for the incorporation of arbitrary linear lumped networks into FDTD simulators,\" IEEE Trans. Microw. Theory Tech., vol. 47, no. 6, pp. 943-949, Jun. 1999.",
  "signature": "class RLCNetwork(MicrowaveBaseModel)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/lumped_element.py",
    "url": "",
    "lineno": 692,
    "endlineno": 942
  },
  "bases": [
    "MicrowaveBaseModel"
  ],
  "parameter_rows": [
    {
      "name": "resistance",
      "annotation": "PositiveFloat | None",
      "default": "None",
      "description": "Resistance value in ohms.",
      "origin": "declared"
    },
    {
      "name": "capacitance",
      "annotation": "PositiveFloat | None",
      "default": "None",
      "description": "Capacitance value in farads.",
      "origin": "declared"
    },
    {
      "name": "inductance",
      "annotation": "PositiveFloat | None",
      "default": "None",
      "description": "Inductance value in henrys.",
      "origin": "declared"
    },
    {
      "name": "network_topology",
      "annotation": "Literal['series', 'parallel']",
      "default": "'series'",
      "description": "Describes whether network elements are connected in `series` or `parallel`.",
      "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"
    }
  ],
  "members": [],
  "group": "flex_rf.tidy3d"
}