ReducedDiags Class Reference

#include <ReducedDiags.H>

Inheritance diagram for ReducedDiags:

Public Member Functions
	ReducedDiags (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	ComputeDiags (int step)=0
virtual void	WriteToFile (int step) const
void	BackwardCompatibility ()

Public Attributes
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

Base class for reduced diagnostics. Each type of reduced diagnostics is implemented in a derived class, and must override the (pure virtual) function ComputeDiags.

Constructor & Destructor Documentation

ReducedDiags() [1/3]

ReducedDiags::ReducedDiags

(

std::string

rd_name

)

constructor

Parameters

[in]

rd_name

reduced diags names

~ReducedDiags()

virtual ReducedDiags::~ReducedDiags ( )

virtualdefault

Virtual destructor for polymorphism

ReducedDiags() [2/3]

ReducedDiags::ReducedDiags ( const ReducedDiags &  )

default

ReducedDiags() [3/3]

ReducedDiags::ReducedDiags ( ReducedDiags &&  )

default

Member Function Documentation

BackwardCompatibility()

void ReducedDiags::BackwardCompatibility

(

)

This function queries deprecated input parameters and aborts the run if one of them is specified.

ComputeDiags()

virtual void ReducedDiags::ComputeDiags ( int  step )

pure virtual

function to compute diags

Parameters

[in]

step

current time step

Implemented in RhoMaximum, ParticleNumber, ParticleMomentum, ParticleHistogram2D, ParticleHistogram, ParticleExtrema, ParticleEnergy, LoadBalanceEfficiency, LoadBalanceCosts, FieldReduction, FieldProbe, FieldMomentum, FieldMaximum, FieldEnergy, ColliderRelevant, ChargeOnEB, and BeamRelevant.

InitData()

void ReducedDiags::InitData ( )

virtual

function to initialize data after amr levels are initialized.

Reimplemented in FieldProbe.

LoadBalance()

void ReducedDiags::LoadBalance ( )

virtual

Redistribute parallel data structures during load balance

Reimplemented in FieldProbe.

operator=() [1/2]

ReducedDiags& ReducedDiags::operator= ( const ReducedDiags &  )

default

operator=() [2/2]

ReducedDiags& ReducedDiags::operator= ( ReducedDiags &&  )

default

WriteToFile()

void ReducedDiags::WriteToFile ( int  step ) const

virtual

write to file function

Parameters

[in]

step

current time step

Reimplemented in FieldProbe, ParticleHistogram2D, and LoadBalanceCosts.

Member Data Documentation

m_data

std::vector<amrex::Real> ReducedDiags::m_data

output data

m_extension

std::string ReducedDiags::m_extension = "txt"

output extension (default)

m_intervals

utils::parser::IntervalsParser ReducedDiags::m_intervals

output intervals

m_path

std::string ReducedDiags::m_path = "./diags/reducedfiles/"

output path (default)

m_precision

int ReducedDiags::m_precision = 14

precision for data in the output file

m_rd_name

std::string ReducedDiags::m_rd_name

diags name

m_sep

std::string ReducedDiags::m_sep = " "

separator in the output file

m_write_header

bool ReducedDiags::m_write_header = false

check if header should be written

---

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

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