ryujin::Logger< dim, Number > Class Template Reference

#include <include/ryujin/driver/logger.h>

Inheritance diagram for ryujin::Logger< dim, Number >:

Collaboration diagram for ryujin::Logger< dim, Number >:

Public Member Functions
	Logger (const Interface::Simulation< dim, Number > &simulation, const std::string &subsection="/Logger")
Task
void	initialize (TaskContext< Number > &context) override
void	start (TaskContext< Number > &context) override
void	prepare (TaskContext< Number > &context) override
void	execute (TaskContext< Number > &context) override
void	finalize (TaskContext< Number > &context) override
Public Member Functions inherited from ryujin::Interface::Task< Number >
virtual	~Task ()=default
virtual void	save (boost::archive::binary_oarchive &) const
virtual void	load (boost::archive::binary_iarchive &)

Additional Inherited Members
Protected Member Functions inherited from ryujin::Interface::Task< Number >
	Task (const std::string &name, TaskPhase phase)

Detailed Description

template<int dim, typename Number = double>
class ryujin::Logger< dim, Number >

The task "logger" that records the run time parameters, the MPI partition, and the device information in the log file "<basename>.log", and prints cycle statistics to the terminal and the log file.

Definition at line 30 of file logger.h.

Constructor & Destructor Documentation

Logger()

template<int dim, typename Number = double>

ryujin::Logger< dim, Number >::Logger	(	const Interface::Simulation< dim, Number > &	simulation,
		const std::string &	subsection = "/Logger< dim, Number >"
	)

Constructor.

Member Function Documentation

initialize()

template<int dim, typename Number = double>

void ryujin::Logger< dim, Number >::initialize ( TaskContext< Number > &  context )

overridevirtual

Open the log file and record the run time parameters.

Reimplemented from ryujin::Interface::Task< Number >.

start()

template<int dim, typename Number = double>

void ryujin::Logger< dim, Number >::start ( TaskContext< Number > &  context )

overridevirtual

Record the device information.

Reimplemented from ryujin::Interface::Task< Number >.

prepare()

template<int dim, typename Number = double>

void ryujin::Logger< dim, Number >::prepare ( TaskContext< Number > &  context )

overridevirtual

Record the MPI partition of the current mesh.

Reimplemented from ryujin::Interface::Task< Number >.

execute()

template<int dim, typename Number = double>

void ryujin::Logger< dim, Number >::execute ( TaskContext< Number > &  context )

overridevirtual

Print cycle statistics to the terminal (every "terminal update interval" seconds) and the log file (at every timer tick).

Implements ryujin::Interface::Task< Number >.

finalize()

template<int dim, typename Number = double>

void ryujin::Logger< dim, Number >::finalize ( TaskContext< Number > &  context )

overridevirtual

Print the final cycle statistics and the debug output.

Reimplemented from ryujin::Interface::Task< Number >.

---

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

• include/ryujin/driver/logger.h