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

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

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

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

Public Member Functions
	Checkpointing (Interface::Simulation< dim, Number > &simulation, const std::string &subsection="/Checkpointing")
Task
void	start (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	initialize (TaskContext< Number > &)
virtual void	prepare (TaskContext< Number > &)
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::Checkpointing< dim, Number >

The task "checkpointing" that writes checkpoints of the computation whenever its trigger fires (by default every hour of wall time) and at the end, and that resumes an interrupted computation from the last checkpoint.

A checkpoint consists of the mesh with the attached state vector of the Simulation, the current time and timer cycle, and the internal state of all active tasks (see Interface::Task::save()).

Definition at line 31 of file checkpointing.h.

Constructor & Destructor Documentation

Checkpointing()

template<int dim, typename Number = double>

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

Constructor.

Member Function Documentation

start()

template<int dim, typename Number = double>

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

overridevirtual

Resume from the last checkpoint (if "resume" is set): load the mesh with the attached state vector, restore the current time and timer cycle, and the internal state of all active tasks.

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

execute()

template<int dim, typename Number = double>

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

overridevirtual

Write a checkpoint whenever the trigger fires.

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

finalize()

template<int dim, typename Number = double>

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

overridevirtual

Write a final checkpoint.

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

---

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

• include/ryujin/driver/checkpointing.h