Inheritance diagram for BeamRelevant:

Public Member Functions
	BeamRelevant (std::string rd_name)

void	ComputeDiags (int step) final

Public Member Functions inherited from ReducedDiags
	ReducedDiags (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	WriteToFile (int step) const

void	BackwardCompatibility ()

Public Attributes
std::string	m_beam_name
	name of beam species More...

Public Attributes inherited from ReducedDiags
std::string	m_path = "./diags/reducedfiles/"
	output path (default) More...

std::string	m_extension = "txt"
	output extension (default) More...

std::string	m_rd_name
	diags name More...

utils::parser::IntervalsParser	m_intervals
	output intervals More...

bool	m_write_header = false
	check if header should be written More...

std::string	m_sep = " "
	separator in the output file More...

int	m_precision = 14
	precision for data in the output file More...

std::vector< amrex::Real >	m_data
	output data More...

Detailed Description

This class contains diagnostics that are relevant to beam.

Constructor & Destructor Documentation

BeamRelevant::BeamRelevant ( std::string rd_name )

constructor

Parameters

[in] rd_name reduced diags names

void BeamRelevant::ComputeDiags ( int step )

finalvirtual

This function computes beam relevant quantites.

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/23.11/Source/Diagnostics/ReducedDiags/BeamRelevant.H
/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/23.11/Source/Diagnostics/ReducedDiags/BeamRelevant.cpp