tidy3d.UniformCurrentSource

class UniformCurrentSource

Bases: CurrentSource, ReverseInterpolatedSource

Source in a rectangular volume with uniform time dependence.

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[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]
  Default
  Units	um
  Description	Size in x, y, and z directions.

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

Notes

Inputting the parameter size=(0,0,0) defines the equivalent of a point source.

Example

>>> pulse = GaussianPulse(freq0=200e12, fwidth=20e12)
>>> pt_source = UniformCurrentSource(size=(0,0,0), source_time=pulse, polarization='Ex')

Attributes

Methods

__hash__()

Hash method.