ReducedDiags Class Reference

#include <ReducedDiags.H>

Inheritance diagram for ReducedDiags:

Public Member Functions
	ReducedDiags (std::string rd_name)
virtual	~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...
int	m_IsNotRestart = 1
	check if it is a restart run More...
std::string	m_sep = " "
	separator 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()

ReducedDiags::ReducedDiags

(

std::string

rd_name

)

constructor

Parameters

[in]

rd_name

reduced diags names

~ReducedDiags()

virtual ReducedDiags::~ReducedDiags ( )

virtualdefault

Virtual destructor for polymorphism

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, RawEFieldReduction, RawBFieldReduction, ParticleNumber, ParticleMomentum, ParticleHistogram, ParticleExtrema, ParticleEnergy, LoadBalanceEfficiency, LoadBalanceCosts, FieldReduction, FieldProbe, FieldMomentum, FieldMaximum, FieldEnergy, BeamRelevant, and ChargeOnEB.

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.

WriteToFile()

void ReducedDiags::WriteToFile ( int  step ) const

virtual

write to file function

Parameters

[in]

step

current time step

Reimplemented in LoadBalanceCosts, and FieldProbe.

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_IsNotRestart

int ReducedDiags::m_IsNotRestart = 1

check if it is a restart run

m_path

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

output path (default)

m_rd_name

std::string ReducedDiags::m_rd_name

diags name

m_sep

std::string ReducedDiags::m_sep = " "

separator in the output file

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/artemis-em/checkouts/latest/Source/Diagnostics/ReducedDiags/ReducedDiags.H
• /home/docs/checkouts/readthedocs.org/user_builds/artemis-em/checkouts/latest/Source/Diagnostics/ReducedDiags/ReducedDiags.cpp