ParticleHistogram2D Class Reference

#include <ParticleHistogram2D.H>

Inheritance diagram for ParticleHistogram2D:

Public Member Functions
	ParticleHistogram2D (const std::string &rd_name)
void	ComputeDiags (int step) final
void	WriteToFile (int step) const 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)
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_openpmd_backend {"default"}
	File type.
int	m_file_min_digits = 6
	minimum number of digits for file suffix (file-based only supported now for now) *‍/
int	m_bin_num_abs
	number of bins on the abscissa and ordinate
int	m_bin_num_ord
amrex::TableData< amrex::ParticleReal, 2 >	m_h_data_2D
	output data
int	m_selected_species_id = -1
	selected species index
amrex::Real	m_bin_max_abs
	max and min bin values
amrex::Real	m_bin_min_abs
amrex::Real	m_bin_max_ord
amrex::Real	m_bin_min_ord
amrex::Real	m_bin_size_abs
	bin sizes
amrex::Real	m_bin_size_ord
std::string	function_string_abs
	functions
std::string	function_string_ord
std::string	filter_string
std::string	value_string
std::unique_ptr< amrex::Parser >	m_parser_abs
std::unique_ptr< amrex::Parser >	m_parser_ord
std::unique_ptr< amrex::Parser >	m_parser_filter
	Optional parser to filter particles before doing the histogram.
bool	m_do_parser_filter = false
	Whether the filter is activated.
std::unique_ptr< amrex::Parser >	m_parser_value
	Optional parser to filter particles before doing the histogram.
bool	m_do_parser_value
	Whether the filter is activated.
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

Static Public Attributes
static constexpr int	m_nvars = 8
	7 elements are t, x, y, z, ux, uy, uz, w

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

ParticleHistogram2D()

ParticleHistogram2D::ParticleHistogram2D

(

const std::string &

rd_name

)

constructor

Parameters

[in]

rd_name

reduced diags names

Member Function Documentation

ComputeDiags()

void ParticleHistogram2D::ComputeDiags ( int step )

finalvirtual

This function computes a histogram of user defined quantity.

Parameters

[in]

step

current time step

Implements ReducedDiags.

WriteToFile()

void ParticleHistogram2D::WriteToFile ( int step ) const

finalvirtual

write to file function

Parameters

[in]

step

current time step

Reimplemented from ReducedDiags.

Member Data Documentation

filter_string

std::string ParticleHistogram2D::filter_string

function_string_abs

std::string ParticleHistogram2D::function_string_abs

functions

function_string_ord

std::string ParticleHistogram2D::function_string_ord

m_bin_max_abs

amrex::Real ParticleHistogram2D::m_bin_max_abs

max and min bin values

m_bin_max_ord

amrex::Real ParticleHistogram2D::m_bin_max_ord

m_bin_min_abs

amrex::Real ParticleHistogram2D::m_bin_min_abs

m_bin_min_ord

amrex::Real ParticleHistogram2D::m_bin_min_ord

m_bin_num_abs

int ParticleHistogram2D::m_bin_num_abs

number of bins on the abscissa and ordinate

m_bin_num_ord

int ParticleHistogram2D::m_bin_num_ord

m_bin_size_abs

amrex::Real ParticleHistogram2D::m_bin_size_abs

bin sizes

m_bin_size_ord

amrex::Real ParticleHistogram2D::m_bin_size_ord

m_do_parser_filter

bool ParticleHistogram2D::m_do_parser_filter = false

Whether the filter is activated.

m_do_parser_value

bool ParticleHistogram2D::m_do_parser_value

Whether the filter is activated.

m_file_min_digits

int ParticleHistogram2D::m_file_min_digits = 6

minimum number of digits for file suffix (file-based only supported now for now) *‍/

m_h_data_2D

amrex::TableData<amrex::ParticleReal,2> ParticleHistogram2D::m_h_data_2D

output data

m_nvars

int ParticleHistogram2D::m_nvars = 8

staticconstexpr

7 elements are t, x, y, z, ux, uy, uz, w

Parser to read expression for particle quantity from the input file.

m_openpmd_backend

std::string ParticleHistogram2D::m_openpmd_backend {"default"}

File type.

m_parser_abs

std::unique_ptr<amrex::Parser> ParticleHistogram2D::m_parser_abs

m_parser_filter

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

Optional parser to filter particles before doing the histogram.

m_parser_ord

std::unique_ptr<amrex::Parser> ParticleHistogram2D::m_parser_ord

m_parser_value

std::unique_ptr<amrex::Parser> ParticleHistogram2D::m_parser_value

Optional parser to filter particles before doing the histogram.

m_selected_species_id

int ParticleHistogram2D::m_selected_species_id = -1

selected species index

value_string

std::string ParticleHistogram2D::value_string

---

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

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