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

Namespaces

 detail
 

Classes

struct  BeamMonitor
 
struct  NonlinearLensInvariants
 

Enumerations

enum  OutputType { OutputType::PrintParticles, OutputType::PrintNonlinearLensInvariants, OutputType::PrintRefParticle }
 

Functions

void DiagnosticOutput (ImpactXParticleContainer const &pc, OutputType const otype, std::string file_name, int const step, bool const append)
 

Enumeration Type Documentation

◆ OutputType

Type of beam diagnostic output

Enumerator
PrintParticles 

ASCII diagnostics, for small tests only.

PrintNonlinearLensInvariants 

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

PrintRefParticle 

ASCII diagnostics, for small tests only.

Function Documentation

◆ DiagnosticOutput()

void impactx::diagnostics::DiagnosticOutput ( ImpactXParticleContainer const &  pc,
OutputType const  otype,
std::string  file_name,
int const  step = 0,
bool const  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)