ColliderRelevant Class Reference

#include <ColliderRelevant.H>

Inheritance diagram for ColliderRelevant:

Classes
struct	aux_header_index
	auxiliary structure to store headers and indices of the reduced diagnostics More...

Public Member Functions
	ColliderRelevant (const std::string &rd_name)
void	ComputeDiags (int step) final
	This function computes collider-relevant diagnostics.
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::vector< std::string >	m_beam_name
	name of the two colliding 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
utils::parser::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

Private Attributes
std::map< std::string, aux_header_index >	m_headers_indices
	map to store header texts and indices of the reduced diagnostics

Detailed Description

This class contains diagnostics that are relevant to colliders.

Constructor & Destructor Documentation

ColliderRelevant()

ColliderRelevant::ColliderRelevant

(

const std::string &

rd_name

)

constructor

Parameters

[in]

rd_name

reduced diags names

Member Function Documentation

ComputeDiags()

void ColliderRelevant::ComputeDiags ( int step )

finalvirtual

This function computes collider-relevant diagnostics.

Parameters

[in]

step

current time step

[0]step, [1]time, [2]dL/dt, for first species: [3]chi_min, [4]chi_ave, [5] chi_max, [6]x_ave, [7]x_std, [8]y_ave, [9]y_std, [10]thetax_min, [11]thetax_ave, [12]thetax_max, [13]thetax_std, [14]thetay_min, [15]thetay_ave, [16]thetay_max, [17]thetay_std same for second species follows.

Implements ReducedDiags.

Member Data Documentation

m_beam_name

std::vector<std::string> ColliderRelevant::m_beam_name

name of the two colliding species

m_headers_indices

std::map<std::string, aux_header_index> ColliderRelevant::m_headers_indices

private

map to store header texts and indices of the reduced diagnostics

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/Diagnostics/ReducedDiags/ColliderRelevant.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/Diagnostics/ReducedDiags/ColliderRelevant.cpp