version 3.11-dev
Loading...
Searching...
No Matches
Dumux::Experimental::IndependentVariableLevel< Scalar > Class Template Reference

Represents a level of the independent variable during ODE integration.

#include <dumux/experimental/ode/odesolver.hh>

Public Member Functions

 IndependentVariableLevel (const Scalar current)
 Constructs a level at a given value of the independent variable.
 IndependentVariableLevel (const Scalar current, const Scalar previous, const Scalar stepFraction)
 Constructs a level occurring within an integration step.
Scalar current () const
 Returns the current value of the independent variable.
Scalar previous () const
 Returns the value at the beginning of the integration step.
Scalar stepFraction () const
 Returns the fraction of the integration step represented by this level.

Constructor & Destructor Documentation

◆ IndependentVariableLevel() [1/2]

template<class Scalar>
Dumux::Experimental::IndependentVariableLevel< Scalar >::IndependentVariableLevel ( const Scalar current)
inlineexplicit
Parameters
currentthe current value of the independent variable

◆ IndependentVariableLevel() [2/2]

template<class Scalar>
Dumux::Experimental::IndependentVariableLevel< Scalar >::IndependentVariableLevel ( const Scalar current,
const Scalar previous,
const Scalar stepFraction )
inline
Parameters
currentthe current value of the independent variable
previousthe value at the beginning of the integration step
stepFractionthe fraction of the integration step represented by this level

Member Function Documentation

◆ current()

template<class Scalar>
Scalar Dumux::Experimental::IndependentVariableLevel< Scalar >::current ( ) const
inline
Returns
the current value of the independent variable

◆ previous()

template<class Scalar>
Scalar Dumux::Experimental::IndependentVariableLevel< Scalar >::previous ( ) const
inline
Returns
the previous value of the independent variable

◆ stepFraction()

template<class Scalar>
Scalar Dumux::Experimental::IndependentVariableLevel< Scalar >::stepFraction ( ) const
inline
Returns
the integration-step fraction

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