tidy3d.PointDipole

class PointDipole

Bases: CurrentSource, ReverseInterpolatedSource

Uniform current source with a zero size.

Parameters:

• name (Attribute: name) –

  Type	Optional[str]
  Default	= None
  Description	Optional name for the source.

• center (Attribute: center) –

  Type	Tuple[float, float, float]
  Default	= (0.0, 0.0, 0.0)
  Units	um
  Description	Center of object in x, y, and z.

• size (Attribute: size) –

  Type	Tuple[Literal[0], Literal[0], Literal[0]]
  Default	= (0, 0, 0)
  Units	um
  Description	Size in x, y, and z directions, constrained to (0, 0, 0).

• source_time (Attribute: source_time) –

  Type	Union[GaussianPulse, ContinuousWave, CustomSourceTime]
  Default
  Description	Specification of the source time-dependence.

• interpolate (Attribute: interpolate) –

  Type	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.

• polarization (Attribute: polarization) –

  Type	Literal[‘Ex’, ‘Ey’, ‘Ez’, ‘Hx’, ‘Hy’, ‘Hz’]
  Default
  Description	Specifies the direction and type of current component.

Example

>>> pulse = GaussianPulse(freq0=200e12, fwidth=20e12)
>>> pt_dipole = PointDipole(center=(1,2,3), source_time=pulse, polarization='Ex')

See also

Lectures:

• Prelude to Integrated Photonics Simulation: Mode Injection

Attributes

Methods

size

__hash__()

Hash method.