# CustomSourceTime

CustomSourceTime (opens new window) uses a user-supplied envelope modulated by a carrier frequency.

CustomSourceTime time and frequency response

# Formula

Let E(t)E(t) be the envelope stored in source_time_dataset. The source is:

s(t)=Aeiϕei2πf0tE(toffset2πfwidth) s(t) = A e^{i\phi} e^{-i2\pi f_0 t} E\left(t - \frac{\mathrm{offset}}{2\pi f_\mathrm{width}}\right)

The envelope is interpolated to simulation time steps. It should be sampled finely enough to avoid interpolation artifacts and should start smoothly from zero.

# Parameters

source_time_dataset: Dataset defining the custom envelope E(t)E(t).

  • Required field

freq0: Carrier frequency used to modulate the custom envelope.

  • Unit: Hz
  • Constraint: greater than 0
  • Required field

fwidth: Estimated frequency width of the custom source.

  • Unit: Hz
  • Constraint: greater than 0
  • Required field

offset: Time delay of the envelope in units of 1/(2πfwidth)1 / (2\pi f_\mathrm{width}).

  • Default: 0

amplitude: Real-valued maximum amplitude scaling factor.

  • Default: 1

phase: Phase shift of the time dependence.

  • Unit: rad
  • Default: 0