Diagnostic Class Reference

#include <diagnostic.hpp>

Inheritance diagram for Diagnostic:

Collaboration diagram for Diagnostic:

Public Member Functions
bool	is_triggered (int step)
bool	has_been_triggered (int step)
int	get_period () const
	Diagnostic ()
void	init (const std::string &name, int period, int first_step=-1)
void	open_stream (const std::string &filename, const XGC_IO_Mode &mode)
void	close_stream ()
void	write (const XGC_IO &xgc_io)
void	start_write_step ()
bool	is_first_step ()
void	end_write_step ()

Public Attributes
bool	is_on

Protected Attributes
StepTrigger	step_trigger

Private Attributes
HostArray< XGC_IO_Stream >	stream

Constructor & Destructor Documentation

Diagnostic::Diagnostic ( )

inline

Member Function Documentation

void Diagnostic::close_stream ( )

inline

Closes the ADIOS2 stream for writing diagnostics.

Returns

void

Here is the caller graph for this function:

void Diagnostic::end_write_step ( )

inline

Here is the caller graph for this function:

int Diagnostic::get_period ( ) const

inline

Here is the call graph for this function:

Here is the caller graph for this function:

bool Diagnostic::has_been_triggered ( int  step )

inline

Here is the call graph for this function:

void Diagnostic::init ( const std::string &  name, int  period, int  first_step = -1  )

inline

Here is the caller graph for this function:

bool Diagnostic::is_first_step ( )

inline

Here is the caller graph for this function:

bool Diagnostic::is_triggered ( int  step )

inline

Here is the call graph for this function:

Here is the caller graph for this function:

void Diagnostic::open_stream ( const std::string &  filename, const XGC_IO_Mode &  mode  )

inline

Opens the ADIOS2 stream to write diagnostics.

Parameters

[in]	filename	Name of the file to be written to by this stream
[in]	mode	Write mode (new or append)

Returns

void

Here is the caller graph for this function:

void Diagnostic::start_write_step ( )

inline

Here is the caller graph for this function:

void Diagnostic::write ( const XGC_IO &  xgc_io )

inline

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bool Diagnostic::is_on

StepTrigger Diagnostic::step_trigger

protected

HostArray<XGC_IO_Stream> Diagnostic::stream

private

---

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

• /u/gitlab-xgc/builds/YGMz2TJ8/0/xgc/XGC-Devel/XGC_core/cpp/diagnostic.hpp