{
  "title": "Custom2DCurrentIntegralSpec",
  "public_path": "flex_rf.tidy3d.Custom2DCurrentIntegralSpec",
  "lookup_path": "tidy3d.rf.Custom2DCurrentIntegralSpec",
  "slug": "flex_rf/tidy3d/Custom2DCurrentIntegralSpec",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/custom2dcurrentintegralspec/",
  "object_kind": "class",
  "introduction": "Class for specifying the computation of conduction current via Ampère's circuital law on a custom path.\nTo compute the current flowing in the positive `axis` direction, the vertices should be\nordered in a counterclockwise direction.",
  "notes": "",
  "examples": "```python\nimport numpy as np\nvertices = np.array([[0, 0], [2, 0], [2, 1], [0, 1], [0, 0]])\ncurrent_spec = Custom2DCurrentIntegralSpec(\n    axis=2,\n    position=0,\n    vertices=vertices\n)\n```",
  "references": "",
  "signature": "class Custom2DCurrentIntegralSpec(Custom2DPathIntegralSpec)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/microwave/path_integrals/specs/current.py",
    "url": "",
    "lineno": 238,
    "endlineno": 315
  },
  "bases": [
    "Custom2DPathIntegralSpec"
  ],
  "parameter_rows": [
    {
      "name": "vertices",
      "annotation": "ArrayFloat2D",
      "default": "",
      "description": "List of (d1, d2) defining the 2 dimensional positions of the path. The index of dimension should be in the ascending order, which means if the axis corresponds with `y`, the coordinates of the vertices should be (x, z). The path must form a closed contour, i.e., `vertices[-1] == vertices[0]`.",
      "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": "axis",
      "annotation": "Axis",
      "default": "",
      "description": "Specifies dimension of the planar axis (0,1,2) -> (x,y,z).",
      "origin": "inherited"
    },
    {
      "name": "position",
      "annotation": "float",
      "default": "",
      "description": "Position of the plane along the `axis`.",
      "origin": "inherited"
    }
  ],
  "members": [
    {
      "name": "plot",
      "kind": "function",
      "signature": "plot(x: float | None = None, y: float | None = None, z: float | None = None, ax: Ax = None, plot_arrow: bool = True, **path_kwargs: Any)",
      "description": "Plot path integral at single (x,y,z) coordinate."
    }
  ],
  "group": "flex_rf.tidy3d"
}