WarpX
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ParticleHistogram Class Reference

#include <ParticleHistogram.H>

Inheritance diagram for ParticleHistogram:
ReducedDiags

Public Member Functions

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

int m_norm
 normalization type More...
 
int m_bin_num
 number of bins More...
 
int m_selected_species_id = -1
 selected species index More...
 
amrex::Real m_bin_max
 max and min bin values More...
 
amrex::Real m_bin_min
 
amrex::Real m_bin_size
 bin size More...
 
std::unique_ptr< amrex::Parserm_parser
 
std::unique_ptr< amrex::Parserm_parser_filter
 Optional parser to filter particles before doing the histogram. More...
 
bool m_do_parser_filter = false
 Whether the filter is activated. 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...
 

Static Public Attributes

static constexpr int m_nvars = 7
 

Detailed Description

Reduced diagnostics that computes a histogram over particles for a quantity specified by the user in the input file using the parser.

Constructor & Destructor Documentation

◆ ParticleHistogram()

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

constructor

Parameters
[in]rd_namereduced diags names

Member Function Documentation

◆ ComputeDiags()

void ParticleHistogram::ComputeDiags ( int  step)
finalvirtual

This function computes a histogram of user defined quantity.

Parameters
[in]stepcurrent time step
Todo:
performance: on CPU, we are probably faster by

Implements ReducedDiags.

Member Data Documentation

◆ m_bin_max

amrex::Real ParticleHistogram::m_bin_max

max and min bin values

◆ m_bin_min

amrex::Real ParticleHistogram::m_bin_min

◆ m_bin_num

int ParticleHistogram::m_bin_num

number of bins

◆ m_bin_size

amrex::Real ParticleHistogram::m_bin_size

bin size

◆ m_do_parser_filter

bool ParticleHistogram::m_do_parser_filter = false

Whether the filter is activated.

◆ m_norm

int ParticleHistogram::m_norm

normalization type

◆ m_nvars

constexpr int ParticleHistogram::m_nvars = 7
staticconstexpr

Parser to read expression for particle quantity from the input file. 7 elements are t, x, y, z, ux, uy, uz

◆ m_parser

std::unique_ptr<amrex::Parser> ParticleHistogram::m_parser

◆ m_parser_filter

std::unique_ptr<amrex::Parser> ParticleHistogram::m_parser_filter

Optional parser to filter particles before doing the histogram.

◆ m_selected_species_id

int ParticleHistogram::m_selected_species_id = -1

selected species index


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