GitHub

QEDfields

Documentation for QEDfields.

QEDfields.AbstractPulsedPlaneWaveField — Type

Abstract base type for pulsed plane-wave fields.

Pulsed field interface

For every subtype, the following functions need to be implemented.


reference_momentum(::AbstractPulsedPlaneWaveField)
domain(::AbstractPulsedPlaneWaveField)
pulse_length(::AbstractPulsedPlaneWaveField)
envelope(::AbstractPulsedPlaneWaveField,x::Real)
source
QEDfields.CosSquarePulse — Type
CosSquarePulse(mom::M,pulse_length::T) where {M<:QEDbase.AbstractFourMomentum,T<:Real}

Concrete implementation of an AbstractPulsedPlaneWaveField for cos-square pulses.

Pulse shape

The pulse envelope of a cos-square pulse is defined as

\[g(\phi) = \cos^2(\frac{\pi\phi}{2\Delta\phi})\]

for $\phi\in (-\Delta\phi,\Delta\phi)$, where $\Delta\phi$ denotes the pulse_length, and zero otherwise.

source
QEDfields._envelope — Function
_envelope(::AbstractPulsedPlaneWaveField, phi::Real)

Interface function for AbstractPulsedPlaneWaveField, which returns the value of the phase envelope function (also referred to as pulse envelope) for a given phase variable.

Single point implementation

The interface function can be implemented for just one phase point as input. With that, evaluation on a vector of inputs is generically implemented by broadcasting. However, if there is a better custom implementation for vectors in input values, consider implementing 


    _envelope(::AbstractPulsedPlaneWaveField, phi::AbstractVector{T<:Real})
unsafe implementation

This is the unsafe version of the phase envelope function, i.e. this should be implement without input checks like the domain check. In the safe version envelope, a domain check is performed, i.e. it returns the value of _envelope if the passed in phi is in the domain of the field, and zero otherwise.

source
QEDfields.amplitude — Method
amplitude(field::AbstractPulsedPlaneWaveField, pol::AbstractDefinitePolarization, phi)

Returns the value of the amplitude for a given polarization direction and phase variable phi.

Conventions

There are two directions supported:

pol::PolX # -> return envelope(phi)*cos(phi)
pol::PolY # -> return envelope(phi)*sin(phi)
Safe implementation

In this function, a domain check is performed, i.e. if phi is in the domain of the field, the value of the amplitude is returned, and zero otherwise.

source
QEDfields.envelope — Method
envelope(pulsed_field::AbstractPulsedPlaneWaveField, phi::Real)

Return the value of the phase envelope function (also referred to as pulse envelope or pulse shape) for given pulsed_field and phase phi. Performs domain check on phi before calling _envelope; returns zero if phi is not in the domain returned by [domain](@ref).

source
QEDfields.generic_spectrum — Method
generic_spectrum(field::AbstractPulsedPlaneWaveField, pol::AbstractDefinitePolarization, pnum)

Return the generic spectrum of the given field, for the given polarization direction pol and a given photon number parameter pnum.

Convention

The generic spectrum is defined as the Fourier transform of the respective amplitude function for the given polarization direction:

\[\begin{align*} x-\mathrm{pol} &\to \int_{-\infty}^{\infty} g(\phi) \cos(\phi) \exp(il\phi)\\ y-\mathrm{pol} &\to \int_{-\infty}^{\infty} g(\phi) \sin(\phi) \exp(il\phi) \end{align*}\]

where $g(\phi)$ is the envelope and $l$ the photon number parameter.

source
QEDfields.oscillator — Function
oscillator(pol::AbstractPolarizaion, phi::Real)

Return the value of the base oscillator associated with a given polarization pol at a given point phi.

Convention

The current default implementation are 

PolX() -> cos(phi)
PolY() -> sin(phi)
AllPol() -> (cos(phi), sin(phi))
source
QEDfields.polarization_vector — Method
polarization_vector(pol::AbstractPolarization, mom::QEDbase.AbstractFourMomentum)

Return the polarization vector for a given polarization and four-momentum mom. For a definite polarization, the respective LorentzVector is returned, where as for an indefinite polarization, a tuple of polarization vectors is returned.

Convention

In the current implementation, we use the base_state function for Photon provided by QEDcore.jl.

source
QEDfields.pulse_length — Function
pulse_length(::AbstractPulsedPlaneWaveField)

Interface function for AbstractPulsedPlaneWaveField, which returns a dimensionless representative number for the duration of the background field, i.e. a half-width or standard deviation in units of phase periods.

source