Dumux::Experimental::GridVariables< GG, X > Class Template Reference

Base class for grid variables. More...

#include <dumux/discretization/gridvariables.hh>

Inheritance diagram for Dumux::Experimental::GridVariables< GG, X >:

Description

template<class GG, class X>
class Dumux::Experimental::GridVariables< GG, X >

Base class for grid variables.

Template Parameters

GG	The grid geometry type
X	The type used for solution vectors

Public Types
using	GridGeometry = GG
	export the grid geometry type More...
using	SolutionVector = X
	export the type of solution vector More...
using	Scalar = typename ScalarT< X >::type
	export the underlying scalar type More...
using	TimeLevel = Dumux::Experimental::TimeLevel< Scalar >
	export the time representation More...

Public Member Functions
template<class... Args>
	GridVariables (std::shared_ptr< const GridGeometry > gridGeometry, Args &&... args)
	Constructor from a grid geometry. The remaining arguments must be valid arguments for the construction of the Variables class. More...
const GridGeometry &	gridGeometry () const
	Return a reference to the grid geometry. More...
const TimeLevel &	timeLevel () const
	Return the time level. More...
const SolutionVector &	dofs () const
	Return reference to the solution. More...
SolutionVector &	dofs ()
	Non-const access still required for privar switch (TODO: Remove dependency) More...
void	update (const SolutionVector &x)
	Update the state to a new solution. More...
void	update (const SolutionVector &x, const TimeLevel &t)
	Update the state to a new solution & time level. More...
void	updateTime (const TimeLevel &t)
	Update the time level only. More...

Member Typedef Documentation

GridGeometry

template<class GG , class X >

using Dumux::Experimental::GridVariables< GG, X >::GridGeometry = GG

export the grid geometry type

Scalar

template<class X >

using Dumux::Experimental::Variables< X >::Scalar = typename ScalarT<X>::type

inherited

export the underlying scalar type

SolutionVector

template<class X >

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

inherited

export the type of solution vector

TimeLevel

template<class X >

using Dumux::Experimental::Variables< X >::TimeLevel = Dumux::Experimental::TimeLevel<Scalar>

inherited

export the time representation

Constructor & Destructor Documentation

GridVariables()

template<class GG , class X >

template<class... Args>

Dumux::Experimental::GridVariables< GG, X >::GridVariables ( std::shared_ptr< const GridGeometry >  gridGeometry, Args &&...  args  )

inline

Constructor from a grid geometry. The remaining arguments must be valid arguments for the construction of the Variables class.

Member Function Documentation

dofs() [1/2]

template<class X >

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

inlineinherited

Non-const access still required for privar switch (TODO: Remove dependency)

dofs() [2/2]

template<class X >

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

inlineinherited

Return reference to the solution.

gridGeometry()

template<class GG , class X >

const GridGeometry & Dumux::Experimental::GridVariables< GG, X >::gridGeometry ( ) const

inline

Return a reference to the grid geometry.

timeLevel()

template<class X >

const TimeLevel & Dumux::Experimental::Variables< X >::timeLevel ( ) const

inlineinherited

Return the time level.

update() [1/2]

template<class X >

void Dumux::Experimental::Variables< X >::update ( const SolutionVector &  x )

inlineinherited

Update the state to a new solution.

update() [2/2]

template<class X >

void Dumux::Experimental::Variables< X >::update ( const SolutionVector &  x, const TimeLevel &  t  )

inlineinherited

Update the state to a new solution & time level.

updateTime()

template<class X >

void Dumux::Experimental::Variables< X >::updateTime ( const TimeLevel &  t )

inlineinherited

Update the time level only.

---

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

• discretization/gridvariables.hh