ImpactX
Namespaces | Classes | Enumerations | Functions
impactx::diagnostics Namespace Reference

Namespaces

 detail
 

Classes

struct  NonlinearLensInvariants
 
struct  BeamMonitor
 

Enumerations

enum class  OutputType { PrintNonlinearLensInvariants , PrintRefParticle , PrintReducedBeamCharacteristics }
 

Functions

void DiagnosticOutput (ImpactXParticleContainer const &pc, OutputType const otype, std::string file_name, int step, bool append)
 
std::unordered_map< std::string, amrex::ParticleReal > reduced_beam_characteristics (ImpactXParticleContainer const &pc)
 

Enumeration Type Documentation

◆ OutputType

Type of beam diagnostic output

Enumerator
PrintNonlinearLensInvariants 

ASCII diagnostics for the IOTA nonlinear lens, for small tests only.

PrintRefParticle 

ASCII diagnostics.

PrintReducedBeamCharacteristics 

ASCII diagnostics, for beam momenta and Twiss parameters.

Function Documentation

◆ DiagnosticOutput()

void impactx::diagnostics::DiagnosticOutput ( ImpactXParticleContainer const &  pc,
OutputType  otype,
std::string  file_name,
int  step = 0,
bool  append = false 
)

ASCII output diagnostics associated with the beam.

This temporary implementation uses ASCII output. It is intended only for small tests where IO performance is not a concern. The implementation here serializes IO.

Parameters
pccontainer of the particles use for diagnostics
otypethe type of output to produce
file_namethe file name to write to
stepthe global step
appendopen a new file with a fresh header (false) or append data to an existing file (true)

◆ reduced_beam_characteristics()

std::unordered_map< std::string, amrex::ParticleReal > impactx::diagnostics::reduced_beam_characteristics ( ImpactXParticleContainer const &  pc)

Compute momenta of the beam distribution