{
  "title": "PointDipole",
  "public_path": "flex_rf.tidy3d.PointDipole",
  "lookup_path": "tidy3d.PointDipole",
  "slug": "flex_rf/tidy3d/PointDipole",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/pointdipole/",
  "object_kind": "class",
  "introduction": "Uniform current source with a zero size. The source corresponds to an infinitesimal antenna\nwith a fixed current density, and is slightly different from a related definition that is used\nin some contexts, namely an oscillating electric or magnetic dipole. The two are related through\na factor of `omega ** 2` in the power normalization, where `omega` is the angular frequency\nof the oscillation. This is discussed further in our\n[source normalization](https://docs.flexcompute.com/projects/tidy3d/en/latest/faq/docs/faq/How-are-results-normalized.html) FAQ page.\n\n..\n    TODO add image of how it looks like based on sim 1.",
  "notes": "",
  "examples": "```python\nfrom tidy3d import GaussianPulse\npulse = GaussianPulse(freq0=200e12, fwidth=20e12)\npt_dipole = PointDipole(center=(1,2,3), source_time=pulse, polarization='Ex')\n```",
  "references": "",
  "signature": "class PointDipole(CurrentSource, ReverseInterpolatedSource)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/components/source/current.py",
    "url": "",
    "lineno": 139,
    "endlineno": 225
  },
  "bases": [
    "CurrentSource",
    "ReverseInterpolatedSource"
  ],
  "parameter_rows": [
    {
      "name": "size",
      "annotation": "tuple[Literal[0], Literal[0], Literal[0]]",
      "default": "(0, 0, 0)",
      "description": "Size in x, y, and z directions, constrained to `(0, 0, 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": "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": "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": [
    {
      "name": "sources_from_angles",
      "kind": "function",
      "signature": "sources_from_angles(source_time: SourceTimeType, angle_theta: float, angle_phi: float, component: Literal['electric', 'magnetic'] = 'electric', **kwargs: Any)",
      "description": "Returns a list of `PointDipole` objects used to emulate a single dipole polarized in an arbitrary direction. The direction is specificed using a polar and azimuthal angle."
    }
  ],
  "group": "flex_rf.tidy3d"
}