Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.PointDipole

Type: class │ Base(s): CurrentSource, ReverseInterpolatedSource

Description

Section titled “Description”

Uniform current source with a zero size. The source corresponds to an infinitesimal antenna with a fixed current density, and is slightly different from a related definition that is used in some contexts, namely an oscillating electric or magnetic dipole. The two are related through a factor of omega ** 2 in the power normalization, where omega is the angular frequency of the oscillation. This is discussed further in our source normalization FAQ page.

.. TODO add image of how it looks like based on sim 1.

Example(s)

Section titled “Example(s)”
from tidy3d import GaussianPulse
pulse = GaussianPulse(freq0=200e12, fwidth=20e12)
pt_dipole = PointDipole(center=(1,2,3), source_time=pulse, polarization='Ex')

Parameters

Section titled “Parameters”
source_time [SourceTimeType]

Specification of the source time-dependence.
polarization [Polarization]

Specifies the direction and type of current component.
name [str | None] = None

Optional name for the source.
center [TracedCoordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.
interpolate [bool] = True

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.
confine_to_bounds [bool] = False

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.
size [tuple[Literal[0], Literal[0], Literal[0]]] = (0, 0, 0)

Size in x, y, and z directions, constrained to (0, 0, 0).

Methods

Section titled “Methods”
sources_from_angles(source_time: SourceTimeType, angle_theta: float, angle_phi: float, component: Literal['electric', 'magnetic'] = 'electric', **kwargs: Any)

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.

Machine-Readable Export

Section titled “Machine-Readable Export”