impactx::diagnostics Namespace Reference

Namespaces
	detail

Classes
struct	NonlinearLensInvariants
struct	BeamMonitor

Enumerations
enum class	OutputType { PrintParticles , PrintNonlinearLensInvariants , PrintRefParticle , PrintReducedBeamCharacteristics }

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

Enumeration Type Documentation

OutputType

enum impactx::diagnostics::OutputType

strong

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.
PrintReducedBeamCharacteristics	ASCII diagnostics, for beam momenta and Twiss parameters.

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

pc	container of the particles use for diagnostics
otype	the type of output to produce
file_name	the file name to write to
step	the global step
append	open 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