hyperdeal::TimeLoop< Number, VectorType > Class Template Reference

#include <time_loop.h>

Public Member Functions
void	reinit (const TimeLoopParamters< Number > &parameters)
int	loop (VectorType &solution, const std::function< void(VectorType &, const Number, const Number, const std::function< void(const VectorType &, VectorType &, const Number)> &)> &time_integrator, const std::function< void(const VectorType &, VectorType &, const Number)> &runnable, const std::function< void(const Number)> &diagnostics)

Public Attributes
Number	time_step
Number	start_time
Number	final_time
unsigned int	max_time_step_number

Detailed Description

template<typename Number, typename VectorType>
class hyperdeal::TimeLoop< Number, VectorType >

Time loop class.

Member Function Documentation

loop()

template<typename Number , typename VectorType >

int hyperdeal::TimeLoop< Number, VectorType >::loop	(	VectorType &	solution,
		const std::function< void(VectorType &, const Number, const Number, const std::function< void(const VectorType &, VectorType &, const Number)> &)> &	time_integrator,
		const std::function< void(const VectorType &, VectorType &, const Number)> &	runnable,
		const std::function< void(const Number)> &	diagnostics )

Run time loop. For each time step, a time_integrator, which evaluates the right-hand side function @runnable, and a postprocessor diagnostics is called.

reinit()

template<typename Number , typename VectorType >

void hyperdeal::TimeLoop< Number, VectorType >::reinit

(

const TimeLoopParamters< Number > &

parameters

)

Configure time loop.

Member Data Documentation

final_time

template<typename Number , typename VectorType >

Number hyperdeal::TimeLoop< Number, VectorType >::final_time

Final time.

max_time_step_number

template<typename Number , typename VectorType >

unsigned int hyperdeal::TimeLoop< Number, VectorType >::max_time_step_number

Maximal number of time steps, after which the simulation terminates even if the final time has not been reached.

start_time

template<typename Number , typename VectorType >

Number hyperdeal::TimeLoop< Number, VectorType >::start_time

Start time. The default is zero, however, in the case of restarts one might specify a different value.

time_step

template<typename Number , typename VectorType >

Number hyperdeal::TimeLoop< Number, VectorType >::time_step

Constant time step size.

---

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

• include/hyper.deal/base/time_loop.h