MultiReducedDiags Class Reference

#include <MultiReducedDiags.H>

Public Member Functions
	MultiReducedDiags ()
	constructor
void	InitData ()
void	LoadBalance ()
void	ComputeDiags (int step)
void	ComputeDiagsMidStep (int step)
void	WriteToFile (int step)
bool	DoDiags (int step)
void	WriteCheckpointData (std::string const &dir)
	Loop over all ReducedDiags and call their WriteCheckpointData.
void	ReadCheckpointData (std::string const &dir)
	Loop over all ReducedDiags and call their ReadCheckpointData.

Public Attributes
int	m_plot_rd = 0
	Bool: whether or not reduced diagnostics are activated.
std::vector< std::string >	m_rd_names
	names of reduced diagnostics
std::vector< std::unique_ptr< ReducedDiags > >	m_multi_rd
	m_multi_rd stores a pointer to each reduced diagnostics

Detailed Description

This class holds multiple instances of ReducedDiagnostics, and contains general functions to initialize, compute, and write these diagnostics to file.

Constructor & Destructor Documentation

MultiReducedDiags()

MultiReducedDiags::MultiReducedDiags

(

)

constructor

Member Function Documentation

ComputeDiags()

void MultiReducedDiags::ComputeDiags

(

int

step

)

Loop over all ReducedDiags and call their ComputeDiags

Parameters

[in]

step

current iteration time

ComputeDiagsMidStep()

void MultiReducedDiags::ComputeDiagsMidStep

(

int

step

)

Loop over all ReducedDiags and call their ComputeDiagsMidStep

Parameters

[in]

step

current iteration time

DoDiags()

bool MultiReducedDiags::DoDiags

(

int

step

)

Check if any diagnostics will be done

InitData()

void MultiReducedDiags::InitData

(

)

Loop over all ReducedDiags and call their InitData

LoadBalance()

void MultiReducedDiags::LoadBalance

(

)

Redistribute parallel data structures during load balance

ReadCheckpointData()

void MultiReducedDiags::ReadCheckpointData

(

std::string const &

dir

)

Loop over all ReducedDiags and call their ReadCheckpointData.

Parameters

[in]

dir

checkpoint directory

WriteCheckpointData()

void MultiReducedDiags::WriteCheckpointData

(

std::string const &

dir

)

Loop over all ReducedDiags and call their WriteCheckpointData.

Parameters

[in]

dir

checkpoint directory

WriteToFile()

void MultiReducedDiags::WriteToFile

(

int

step

)

Loop over all ReducedDiags and call their WriteToFile

Parameters

[in]

step

current iteration time

Member Data Documentation

m_multi_rd

std::vector<std::unique_ptr<ReducedDiags> > MultiReducedDiags::m_multi_rd

m_multi_rd stores a pointer to each reduced diagnostics

m_plot_rd

int MultiReducedDiags::m_plot_rd = 0

Bool: whether or not reduced diagnostics are activated.

m_rd_names

std::vector<std::string> MultiReducedDiags::m_rd_names

names of reduced diagnostics

---

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

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