ImpactX
Public Member Functions | List of all members
impactx::distribution::None Struct Reference

#include <None.H>

Public Member Functions

 None ()
 
void initialize ([[maybe_unused]] amrex::ParticleReal bunch_charge, [[maybe_unused]] RefPart const &ref)
 
void finalize ()
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void operator() (amrex::ParticleReal &x, amrex::ParticleReal &y, amrex::ParticleReal &t, amrex::ParticleReal &px, amrex::ParticleReal &py, amrex::ParticleReal &pt, [[maybe_unused]] amrex::RandomEngine const &engine) const
 

Constructor & Destructor Documentation

◆ None()

impactx::distribution::None::None ( )
inline

This distribution sets all values to zero.

Member Function Documentation

◆ finalize()

void impactx::distribution::None::finalize ( )
inline

Close and deallocate all data and handles.

Nothing to do here.

◆ initialize()

void impactx::distribution::None::initialize ( [[maybe_unused] ] amrex::ParticleReal  bunch_charge,
[[maybe_unused] ] RefPart const &  ref 
)
inline

Initialize the distribution.

Nothing to do here.

Parameters
bunch_chargecharge of the beam in C
refthe reference particle

◆ operator()()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void impactx::distribution::None::operator() ( amrex::ParticleReal &  x,
amrex::ParticleReal &  y,
amrex::ParticleReal &  t,
amrex::ParticleReal &  px,
amrex::ParticleReal &  py,
amrex::ParticleReal &  pt,
[[maybe_unused] ] amrex::RandomEngine const &  engine 
) const
inline

Return 1 6D particle coordinate

Sets all values to zero.

Parameters
xparticle position in x
yparticle position in y
tparticle position in t
pxparticle momentum in x
pyparticle momentum in y
ptparticle momentum in t
enginea random number engine (with associated state)

The documentation for this struct was generated from the following file: