{
  "title": "UniformCurrentSource",
  "public_path": "flex_rf.tidy3d.UniformCurrentSource",
  "lookup_path": "tidy3d.UniformCurrentSource",
  "slug": "flex_rf/tidy3d/UniformCurrentSource",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/uniformcurrentsource/",
  "object_kind": "class",
  "introduction": "Source in a rectangular volume with uniform time dependence.",
  "notes": "Inputting the parameter `size=(0,0,0)` defines the equivalent of a point source.",
  "examples": "```python\nfrom tidy3d import GaussianPulse\npulse = GaussianPulse(freq0=200e12, fwidth=20e12)\npt_source = UniformCurrentSource(\n    size=(0,0,0), source_time=pulse, polarization='Ex', current_amplitude_definition='total',\n)\n```",
  "references": "",
  "signature": "class UniformCurrentSource(CurrentSource, ReverseInterpolatedSource)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/source/current.py",
    "url": "",
    "lineno": 95,
    "endlineno": 136
  },
  "bases": [
    "CurrentSource",
    "ReverseInterpolatedSource"
  ],
  "parameter_rows": [
    {
      "name": "current_amplitude_definition",
      "annotation": "Literal['density', 'total']",
      "default": "'density'",
      "description": "Defines how the `source_time` amplitude is interpreted. If `'total'`, the `source_time` parameter is interpreted as the total current in Amperes (A) / Volts (V) when an electric / magnetic current polarization is chosen. The solver automatically scales the current density by the source cross-sectional area to ensure the integrated current equals the specified amplitude, regardless of mesh resolution. If `'density'` (default), `source_time` represents the current density (e.g., A/m²), meaning the total injected current will scale with the source geometry size.",
      "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 | None",
      "default": "None",
      "description": "Optional name for the source.",
      "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": "source_time",
      "annotation": "SourceTimeType",
      "default": "",
      "description": "Specification of the source time-dependence.",
      "origin": "inherited"
    },
    {
      "name": "interpolate",
      "annotation": "bool",
      "default": "True",
      "description": "Handles reverse-interpolation of zero-size dimensions of the source. If `False`, the source data is snapped to the nearest Yee grid point. If `True`, equivalent source data is applied on the surrounding Yee grid points to emulate placement at the specified location using linear interpolation.",
      "origin": "inherited"
    },
    {
      "name": "confine_to_bounds",
      "annotation": "bool",
      "default": "False",
      "description": "If `True`, any source amplitudes which, after discretization, fall beyond the bounding box of the source are zeroed out, but only along directions where the source has a non-zero extent. The bounding box is inclusive. Should be set ```True`` when the current source is being used to excite a current in a conductive material.",
      "origin": "inherited"
    },
    {
      "name": "polarization",
      "annotation": "Polarization",
      "default": "",
      "description": "Specifies the direction and type of current component.",
      "origin": "inherited"
    }
  ],
  "members": [],
  "group": "flex_rf.tidy3d"
}