WarpX
Classes | Public Member Functions | Public Attributes | Private Attributes | List of all members
ParticleExtrema Class Reference

#include <ParticleExtrema.H>

Inheritance diagram for ParticleExtrema:
ReducedDiags

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
 
ReducedDiagsoperator= (const ReducedDiags &)=default
 
 ReducedDiags (ReducedDiags &&)=default
 
ReducedDiagsoperator= (ReducedDiags &&)=default
 
virtual void InitData ()
 
virtual void LoadBalance ()
 
virtual void WriteToFile (int step) const
 
void BackwardCompatibility () const
 

Public Attributes

std::string m_species_name
 name of 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...
 

Private Attributes

std::map< std::string, aux_header_indexm_headers_indices
 map to store header texts and indices of the reduced diagnostics More...
 

Detailed Description

This class mainly contains a function that computes the particle extrema of each species.

Constructor & Destructor Documentation

◆ ParticleExtrema()

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

constructor

Parameters
[in]rd_namereduced diags names

Member Function Documentation

◆ ComputeDiags()

void ParticleExtrema::ComputeDiags ( int  step)
finalvirtual

This function computes the particle extrema

Parameters
[in]stepcurrent time step

Implements ReducedDiags.

Member Data Documentation

◆ m_headers_indices

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

map to store header texts and indices of the reduced diagnostics

◆ m_species_name

std::string ParticleExtrema::m_species_name

name of species


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