Inheritance diagram for ParticleExtrema:

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

Public Member Functions
	ParticleExtrema (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_species_name
	name of 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 mainly contains a function that computes the particle extrema of each species.

Constructor & Destructor Documentation

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

constructor

Parameters

[in] rd_name reduced diags names

void ParticleExtrema::ComputeDiags ( int step )

finalvirtual

This function computes the particle extrema

Parameters

[in] step current time step

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

private

map to store header texts and indices of the reduced diagnostics

std::string ParticleExtrema::m_species_name

name of species

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

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