ImpactX
Loading...
Searching...
No Matches
impactx::distribution::Empty Struct Reference

#include <Empty.H>

Public Member Functions

 Empty ()
 
void initialize (amrex::ParticleReal bunch_charge, 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, amrex::RandomEngine const &engine) const
 

Constructor & Destructor Documentation

◆ Empty()

impactx::distribution::Empty::Empty ( )
inline

This distribution sets all values to zero.

Member Function Documentation

◆ finalize()

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

Close and deallocate all data and handles.

Nothing to do here.

◆ initialize()

void impactx::distribution::Empty::initialize ( amrex::ParticleReal bunch_charge,
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::Empty::operator() ( amrex::ParticleReal & x,
amrex::ParticleReal & y,
amrex::ParticleReal & t,
amrex::ParticleReal & px,
amrex::ParticleReal & py,
amrex::ParticleReal & pt,
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: