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

The grid variables class for general schemes, storing variables and data. More...

#include <dumux/discretization/gridvariables.hh>

Description

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

Template Parameters

GG	The type of the grid geometry
GVC	The type of the grid variables cache

Public Types
using	GridDiscretization = GG
	export type of the grid discretization
using	GridVariablesCache = GVC
	export type of the grid variables cache
using	Variables = typename GridVariablesCache::Variables
	export type of the variables
using	PrimaryVariables = typename Variables::PrimaryVariables
	export primary variable type
using	Scalar = typename PrimaryVariables::value_type
	export scalar

Public Member Functions
template<class Problem>
	GridVariables (std::shared_ptr< Problem > problem, std::shared_ptr< const GridDiscretization > gridDiscretization)
template<class SolutionVector>
void	init (const SolutionVector &curSol)
	initialize all variables (stationary case)
template<class SolutionVector>
void	update (const SolutionVector &curSol)
	update all variables
template<class SolutionVector>
void	updateAfterGridAdaption (const SolutionVector &curSol)
	update all variables after grid adaption
void	advanceTimeStep ()
	Sets the current state as the previous for next time step.
template<class SolutionVector>
void	resetTimeStep (const SolutionVector &solution)
	resets state to the one before time integration
const GridVariablesCache &	curGridVars () const
	return the current variables
GridVariablesCache &	curGridVars ()
	return the current variables
const GridVariablesCache &	prevGridVars () const
	return the variables of the previous time step (for instationary problems)
GridVariablesCache &	prevGridVars ()
	return the variables of the previous time step (for instationary problems)
const GridDiscretization &	gridDiscretization () const
	return the grid discretization

Protected Attributes
std::shared_ptr< const GridDiscretization >	gridDiscretization_
	pointer to the constant grid discretization

Member Typedef Documentation

GridDiscretization

template<class GG, class GVC>

using Dumux::Experimental::GridVariables< GG, GVC >::GridDiscretization = GG

GridVariablesCache

template<class GG, class GVC>

using Dumux::Experimental::GridVariables< GG, GVC >::GridVariablesCache = GVC

PrimaryVariables

template<class GG, class GVC>

using Dumux::Experimental::GridVariables< GG, GVC >::PrimaryVariables = typename Variables::PrimaryVariables

Scalar

template<class GG, class GVC>

using Dumux::Experimental::GridVariables< GG, GVC >::Scalar = typename PrimaryVariables::value_type

Variables

template<class GG, class GVC>

using Dumux::Experimental::GridVariables< GG, GVC >::Variables = typename GridVariablesCache::Variables

Constructor & Destructor Documentation

GridVariables()

template<class GG, class GVC>

template<class Problem>

Dumux::Experimental::GridVariables< GG, GVC >::GridVariables ( std::shared_ptr< Problem > problem, std::shared_ptr< const GridDiscretization > gridDiscretization )

inline

Member Function Documentation

advanceTimeStep()

template<class GG, class GVC>

void Dumux::Experimental::GridVariables< GG, GVC >::advanceTimeStep ( )

inline

Note

this has to be called at the end of each time step

curGridVars() [1/2]

template<class GG, class GVC>

GridVariablesCache & Dumux::Experimental::GridVariables< GG, GVC >::curGridVars ( )

inline

curGridVars() [2/2]

template<class GG, class GVC>

const GridVariablesCache & Dumux::Experimental::GridVariables< GG, GVC >::curGridVars ( ) const

inline

gridDiscretization()

template<class GG, class GVC>

const GridDiscretization & Dumux::Experimental::GridVariables< GG, GVC >::gridDiscretization ( ) const

inline

init()

template<class GG, class GVC>

template<class SolutionVector>

void Dumux::Experimental::GridVariables< GG, GVC >::init ( const SolutionVector & curSol )

inline

prevGridVars() [1/2]

template<class GG, class GVC>

GridVariablesCache & Dumux::Experimental::GridVariables< GG, GVC >::prevGridVars ( )

inline

prevGridVars() [2/2]

template<class GG, class GVC>

const GridVariablesCache & Dumux::Experimental::GridVariables< GG, GVC >::prevGridVars ( ) const

inline

resetTimeStep()

template<class GG, class GVC>

template<class SolutionVector>

void Dumux::Experimental::GridVariables< GG, GVC >::resetTimeStep ( const SolutionVector & solution )

inline

update()

template<class GG, class GVC>

template<class SolutionVector>

void Dumux::Experimental::GridVariables< GG, GVC >::update ( const SolutionVector & curSol )

inline

updateAfterGridAdaption()

template<class GG, class GVC>

template<class SolutionVector>

void Dumux::Experimental::GridVariables< GG, GVC >::updateAfterGridAdaption ( const SolutionVector & curSol )

inline

Member Data Documentation

gridDiscretization_

template<class GG, class GVC>

std::shared_ptr<const GridDiscretization> Dumux::Experimental::GridVariables< GG, GVC >::gridDiscretization_

protected

---

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

• discretization/gridvariables.hh