Inheritance diagram for BeamRelevant:

Public Member Functions
	BeamRelevant (const std::string &rd_name)
void	ComputeDiags (int step) final
Public Member Functions inherited from ReducedDiags
	ReducedDiags (const std::string &rd_name)
virtual	~ReducedDiags ()=default
	ReducedDiags (const ReducedDiags &)=default
ReducedDiags &	operator= (const ReducedDiags &)=default
	ReducedDiags (ReducedDiags &&)=default
ReducedDiags &	operator= (ReducedDiags &&)=default
virtual void	InitData ()
virtual void	LoadBalance ()
virtual void	ComputeDiagsMidStep (int step)
virtual void	WriteToFile (int step) const
bool	DoDiags (int step) const
virtual void	WriteCheckpointData (std::string const &dir)
	Write out checkpoint related data.
virtual void	ReadCheckpointData (std::string const &dir)
	Read in checkpoint related data.
void	BackwardCompatibility () const

Public Attributes
std::string	m_beam_name
	name of beam species
Public Attributes inherited from ReducedDiags
std::string	m_path = "./diags/reducedfiles/"
	output path (default)
std::string	m_extension = "txt"
	output extension (default)
std::string	m_rd_name
	diags name
ablastr::utils::text::IntervalsParser	m_intervals
	output intervals
bool	m_write_header = false
	check if header should be written
std::string	m_sep = " "
	separator in the output file
int	m_precision = 14
	precision for data in the output file
std::vector< amrex::Real >	m_data
	output data

Detailed Description

This class contains diagnostics that are relevant to beam.

Constructor & Destructor Documentation

BeamRelevant::BeamRelevant ( const std::string & rd_name )

explicit

constructor

Parameters

[in] rd_name reduced diags names

void BeamRelevant::ComputeDiags ( int step )

finalvirtual

This function computes beam relevant quantities.

Parameters

[in] step current time step

std::string BeamRelevant::m_beam_name

name of beam species

The documentation for this class was generated from the following files:

/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.07/Source/Diagnostics/ReducedDiags/BeamRelevant.H
/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.07/Source/Diagnostics/ReducedDiags/BeamRelevant.cpp