Dumux::Experimental::ODEVariables< X > Class Template Reference

Stores an ODE solution and its independent-variable level. Generalization of experimental/common/variables which are tailored to time as the independent variable.

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

Inheritance diagram for Dumux::Experimental::ODEVariables< X >:

Public Types
using	SolutionVector = X
using	Scalar = Detail::ODE::Scalar<X>
using	Level = IndependentVariableLevel<Scalar>

Public Member Functions
	ODEVariables ()
	Constructs default-initialized ODE variables.
	ODEVariables (const SolutionVector &solution, const Level &level=Level{0.0})
	Constructs ODE variables from a solution.
	ODEVariables (SolutionVector &&solution, const Level &level=Level{0.0})
	Constructs ODE variables by moving a solution.
const Level &	independentVariableLevel () const
	Returns the independent-variable level.
const SolutionVector &	dofs () const
	Returns the solution degrees of freedom.
SolutionVector &	dofs ()
	Returns the solution degrees of freedom.
void	update (const SolutionVector &solution)
	Updates the solution.
void	updateIndependentVariable (const Level &level)
	Updates the independent-variable level.
void	update (const SolutionVector &solution, const Level &level)
	Updates the solution and independent-variable level.

Member Typedef Documentation

Level

template<class X>

using Dumux::Experimental::ODEVariables< X >::Level = IndependentVariableLevel<Scalar>

Scalar

template<class X>

using Dumux::Experimental::ODEVariables< X >::Scalar = Detail::ODE::Scalar<X>

SolutionVector

template<class X>

using Dumux::Experimental::ODEVariables< X >::SolutionVector = X

Constructor & Destructor Documentation

ODEVariables() [1/3]

template<class X>

Dumux::Experimental::ODEVariables< X >::ODEVariables ( )

inline

ODEVariables() [2/3]

template<class X>

Dumux::Experimental::ODEVariables< X >::ODEVariables ( const SolutionVector & solution, const Level & level = Level{0.0} )

inlineexplicit

Parameters

solution	initial solution
level	initial independent-variable level

ODEVariables() [3/3]

template<class X>

Dumux::Experimental::ODEVariables< X >::ODEVariables ( SolutionVector && solution, const Level & level = Level{0.0} )

inlineexplicit

Parameters

solution	initial solution
level	initial independent-variable level

Member Function Documentation

dofs() [1/2]

template<class X>

SolutionVector & Dumux::Experimental::ODEVariables< X >::dofs ( )

inline

Returns

the solution degrees of freedom

dofs() [2/2]

template<class X>

const SolutionVector & Dumux::Experimental::ODEVariables< X >::dofs ( ) const

inline

Returns

the solution degrees of freedom

independentVariableLevel()

template<class X>

const Level & Dumux::Experimental::ODEVariables< X >::independentVariableLevel ( ) const

inline

Returns

the independent-variable level

update() [1/2]

template<class X>

void Dumux::Experimental::ODEVariables< X >::update ( const SolutionVector & solution )

inline

Parameters

solution

the new solution

update() [2/2]

template<class X>

void Dumux::Experimental::ODEVariables< X >::update ( const SolutionVector & solution, const Level & level )

inline

Parameters

solution	new solution
level	new independent-variable level

updateIndependentVariable()

template<class X>

void Dumux::Experimental::ODEVariables< X >::updateIndependentVariable ( const Level & level )

inline

Parameters

level

the new independent-variable level

---

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

• odesolver.hh