WarpX
Public Member Functions | List of all members
ParticleNumber Class Reference

#include <ParticleNumber.H>

Inheritance diagram for ParticleNumber:
ReducedDiags

Public Member Functions

 ParticleNumber (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
 

Additional Inherited Members

- 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 mainly contains a function that computes the total number of macroparticles and of physical particles (i.e. the sum of the weights) of each species.

Constructor & Destructor Documentation

◆ ParticleNumber()

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

constructor

Parameters
[in]rd_namereduced diags names

Member Function Documentation

◆ ComputeDiags()

void ParticleNumber::ComputeDiags ( int  step)
finalvirtual

This function computes the total number of macroparticles and physical particles of each species.

Parameters
[in]stepcurrent time step

Implements ReducedDiags.


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