tidy3d.UniformCurrentSource

tidy3d.UniformCurrentSource#

class UniformCurrentSource[source]#

Bases: CurrentSource, ReverseInterpolatedSource

Source in a rectangular volume with uniform time dependence.

Parameters:
  • name (Optional[str] = None) – Optional name for the source.

  • center (Tuple[float, float, float] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

  • size (Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]) – [units = um]. Size in x, y, and z directions.

  • source_time (Union[GaussianPulse, ContinuousWave, CustomSourceTime]) – Specification of the source time-dependence.

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

  • polarization (Literal['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz']) – 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

Inherited Common Usage

__hash__()#

Hash method.