{
  "title": "AxisAlignedCurrentIntegralSpec",
  "public_path": "flex_rf.tidy3d.AxisAlignedCurrentIntegralSpec",
  "lookup_path": "tidy3d.rf.AxisAlignedCurrentIntegralSpec",
  "slug": "flex_rf/tidy3d/AxisAlignedCurrentIntegralSpec",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/axisalignedcurrentintegralspec/",
  "object_kind": "class",
  "introduction": "Class for specifying the computation of conduction current via Ampère's circuital law on an axis-aligned loop.",
  "notes": "",
  "examples": "```python\ncurrent_spec = AxisAlignedCurrentIntegralSpec(\n    center=(0, 0, 0),\n    size=(1, 1, 0),\n    sign=\"+\",\n    snap_contour_to_grid=True\n)\n```",
  "references": "",
  "signature": "class AxisAlignedCurrentIntegralSpec(AbstractAxesRH, Box)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/microwave/path_integrals/specs/current.py",
    "url": "",
    "lineno": 33,
    "endlineno": 235
  },
  "bases": [
    "AbstractAxesRH",
    "Box"
  ],
  "parameter_rows": [
    {
      "name": "sign",
      "annotation": "Direction",
      "default": "",
      "description": "Positive indicates current flowing in the positive normal axis direction.",
      "origin": "declared"
    },
    {
      "name": "extrapolate_to_endpoints",
      "annotation": "bool",
      "default": "False",
      "description": "This parameter is passed to `AxisAlignedPathIntegral` objects when computing the contour integral.",
      "origin": "declared"
    },
    {
      "name": "snap_contour_to_grid",
      "annotation": "bool",
      "default": "False",
      "description": "This parameter is passed to `AxisAlignedPathIntegral` objects when computing the contour integral.",
      "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"
    }
  ],
  "members": [
    {
      "name": "main_axis",
      "kind": "function",
      "signature": "main_axis()",
      "description": "Axis normal to loop"
    },
    {
      "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"
}