Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV > Class Template Reference

The global face variables class for staggered models. More...

#include <dumux/discretization/facecentered/staggered/elementsolution.hh>

Description

template<class FVElementGeometry, class PV>
class Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV >

The global face variables class for staggered models.

Public Types
using	PrimaryVariables = PV
	export the primary variables type More...

Public Member Functions
	FaceCenteredStaggeredElementSolution ()=default
template<class SolutionVector >
	FaceCenteredStaggeredElementSolution (const Element &element, const SolutionVector &sol, const GridGeometry &gridGeometry)
	Constructor with element, solution vector and grid geometry. More...
template<class ElementVolumeVariables >
	FaceCenteredStaggeredElementSolution (const Element &element, const ElementVolumeVariables &elemVolVars, const FVElementGeometry &fvGeometry)
	Constructor with element, element volume variables and fv element geometry. More...
	FaceCenteredStaggeredElementSolution (PrimaryVariables &&priVars)
	Constructor with a primary variable object. More...
	FaceCenteredStaggeredElementSolution (const PrimaryVariables &priVars)
	Constructor with a primary variable object. More...
template<class SolutionVector >
void	update (const Element &element, const SolutionVector &sol, const GridGeometry &gridGeometry)
	extract the element solution from the solution vector using a mapper More...
const PrimaryVariables &	operator[] (SmallLocalIndexType localScvIdx) const
	bracket operator const access More...
PrimaryVariables &	operator[] (SmallLocalIndexType localScvIdx)
	bracket operator More...

Static Public Member Functions
static constexpr std::size_t	size ()
	return the size of the element solution More...

Member Typedef Documentation

PrimaryVariables

template<class FVElementGeometry , class PV >

using Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV >::PrimaryVariables = PV

export the primary variables type

Constructor & Destructor Documentation

FaceCenteredStaggeredElementSolution() [1/5]

template<class FVElementGeometry , class PV >

Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV >::FaceCenteredStaggeredElementSolution ( )

default

FaceCenteredStaggeredElementSolution() [2/5]

template<class FVElementGeometry , class PV >

template<class SolutionVector >

Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV >::FaceCenteredStaggeredElementSolution ( const Element &  element, const SolutionVector &  sol, const GridGeometry &  gridGeometry  )

inline

Constructor with element, solution vector and grid geometry.

FaceCenteredStaggeredElementSolution() [3/5]

template<class FVElementGeometry , class PV >

template<class ElementVolumeVariables >

Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV >::FaceCenteredStaggeredElementSolution ( const Element &  element, const ElementVolumeVariables &  elemVolVars, const FVElementGeometry &  fvGeometry  )

inline

Constructor with element, element volume variables and fv element geometry.

FaceCenteredStaggeredElementSolution() [4/5]

template<class FVElementGeometry , class PV >

Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV >::FaceCenteredStaggeredElementSolution ( PrimaryVariables &&  priVars )

inline

Constructor with a primary variable object.

FaceCenteredStaggeredElementSolution() [5/5]

template<class FVElementGeometry , class PV >

Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV >::FaceCenteredStaggeredElementSolution ( const PrimaryVariables &  priVars )

inline

Constructor with a primary variable object.

Member Function Documentation

operator[]() [1/2]

template<class FVElementGeometry , class PV >

PrimaryVariables & Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV >::operator[] ( SmallLocalIndexType  localScvIdx )

inline

bracket operator

operator[]() [2/2]

template<class FVElementGeometry , class PV >

const PrimaryVariables & Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV >::operator[] ( SmallLocalIndexType  localScvIdx ) const

inline

bracket operator const access

size()

template<class FVElementGeometry , class PV >

static constexpr std::size_t Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV >::size ( )

inlinestaticconstexpr

return the size of the element solution

update()

template<class FVElementGeometry , class PV >

template<class SolutionVector >

void Dumux::FaceCenteredStaggeredElementSolution< FVElementGeometry, PV >::update ( const Element &  element, const SolutionVector &  sol, const GridGeometry &  gridGeometry  )

inline

extract the element solution from the solution vector using a mapper

---

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

• facecentered/staggered/elementsolution.hh