Dumux::Experimental::TimeLevel< Scalar > Class Template Reference

Class that represents a time level during time integration. More...

#include <dumux/experimental/timestepping/timelevel.hh>

Description

template<class Scalar>
class Dumux::Experimental::TimeLevel< Scalar >

Class that represents a time level during time integration.

Public Member Functions
	TimeLevel (Scalar curTime)
	Construct a time level with a time. More...
	TimeLevel (Scalar curTime, Scalar prevTime, Scalar dtFraction)
	Construct a time level with information on an ongoing time step. More...
Scalar	current () const
	Return the current time. More...
Scalar	previous () const
	Return the time at the beginning of time integration. More...
Scalar	timeStepFraction () const
	Return the fraction of the time step this level corresponds to. More...

Constructor & Destructor Documentation

TimeLevel() [1/2]

template<class Scalar >

Dumux::Experimental::TimeLevel< Scalar >::TimeLevel ( Scalar  curTime )

inlineexplicit

Construct a time level with a time.

Note

This can be used in contexts outside of time integration, where no information on a previous time or time step size is needed.

TimeLevel() [2/2]

template<class Scalar >

Dumux::Experimental::TimeLevel< Scalar >::TimeLevel ( Scalar  curTime, Scalar  prevTime, Scalar  dtFraction  )

inline

Construct a time level with information on an ongoing time step.

Parameters

curTime	The current time level
prevTime	The previous time level
dtFraction	The fraction of a time step this level corresponds to.

Note

Within a time integration step, several time levels might occur when multi-stage methods are used. The argument dtFraction allows for determining the time that will be reached at the end of the time integration step.

Member Function Documentation

current()

template<class Scalar >

Scalar Dumux::Experimental::TimeLevel< Scalar >::current ( ) const

inline

Return the current time.

previous()

template<class Scalar >

Scalar Dumux::Experimental::TimeLevel< Scalar >::previous ( ) const

inline

Return the time at the beginning of time integration.

timeStepFraction()

template<class Scalar >

Scalar Dumux::Experimental::TimeLevel< Scalar >::timeStepFraction ( ) const

inline

Return the fraction of the time step this level corresponds to.

---

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

• timelevel.hh