ParticleDiag Class Reference

#include <ParticleDiag.H>

Public Member Functions
	ParticleDiag (const std::string &diag_name, const std::string &name, WarpXParticleContainer *pc, WarpXParticleContainer::Base *pinned_pc=nullptr)
WarpXParticleContainer *	getParticleContainer () const
WarpXParticleContainer::Base *	getPinnedParticleContainer () const
std::string	getSpeciesName () const

Public Attributes
amrex::Vector< int >	m_plot_flags
bool	m_plot_phi = false
bool	m_plot_Ex = false
bool	m_plot_Ey = false
bool	m_plot_Ez = false
bool	m_plot_Bx = false
bool	m_plot_By = false
bool	m_plot_Bz = false
bool	m_do_random_filter = false
bool	m_do_uniform_filter = false
bool	m_do_parser_filter = false
bool	m_do_geom_filter = false
amrex::Real	m_random_fraction = 1.0
int	m_uniform_stride = 1
std::unique_ptr< amrex::Parser >	m_particle_filter_parser
amrex::RealBox	m_diag_domain

Static Public Attributes
static constexpr int	m_nvars = 7

Private Attributes
std::string	m_diag_name
std::string	m_name
WarpXParticleContainer *	m_pc
WarpXParticleContainer::Base *	m_pinned_pc

Constructor & Destructor Documentation

ParticleDiag()

ParticleDiag::ParticleDiag	(	const std::string &	diag_name,
		const std::string &	name,
		WarpXParticleContainer *	pc,
		WarpXParticleContainer::Base *	pinned_pc = nullptr )

Member Function Documentation

getParticleContainer()

WarpXParticleContainer * ParticleDiag::getParticleContainer ( ) const

inlinenodiscard

getPinnedParticleContainer()

WarpXParticleContainer::Base * ParticleDiag::getPinnedParticleContainer ( ) const

inlinenodiscard

getSpeciesName()

std::string ParticleDiag::getSpeciesName ( ) const

inlinenodiscard

Member Data Documentation

m_diag_domain

amrex::RealBox ParticleDiag::m_diag_domain

m_diag_name

std::string ParticleDiag::m_diag_name

private

m_do_geom_filter

bool ParticleDiag::m_do_geom_filter = false

m_do_parser_filter

bool ParticleDiag::m_do_parser_filter = false

m_do_random_filter

bool ParticleDiag::m_do_random_filter = false

m_do_uniform_filter

bool ParticleDiag::m_do_uniform_filter = false

m_name

std::string ParticleDiag::m_name

private

m_nvars

int ParticleDiag::m_nvars = 7

staticconstexpr

m_particle_filter_parser

std::unique_ptr<amrex::Parser> ParticleDiag::m_particle_filter_parser

m_pc

WarpXParticleContainer* ParticleDiag::m_pc

private

m_pinned_pc

WarpXParticleContainer::Base* ParticleDiag::m_pinned_pc

private

m_plot_Bx

bool ParticleDiag::m_plot_Bx = false

m_plot_By

bool ParticleDiag::m_plot_By = false

m_plot_Bz

bool ParticleDiag::m_plot_Bz = false

m_plot_Ex

bool ParticleDiag::m_plot_Ex = false

m_plot_Ey

bool ParticleDiag::m_plot_Ey = false

m_plot_Ez

bool ParticleDiag::m_plot_Ez = false

m_plot_flags

amrex::Vector<int> ParticleDiag::m_plot_flags

m_plot_phi

bool ParticleDiag::m_plot_phi = false

m_random_fraction

amrex::Real ParticleDiag::m_random_fraction = 1.0

m_uniform_stride

int ParticleDiag::m_uniform_stride = 1

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.07/Source/Diagnostics/ParticleDiag/ParticleDiag.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/26.07/Source/Diagnostics/ParticleDiag/ParticleDiag.cpp