Dumux::ShallowWaterVolumeVariables< Traits > Class Template Reference

Volume variables for the shallow water equations model. More...

#include <dumux/freeflow/shallowwater/volumevariables.hh>

Description

template<class Traits>
class Dumux::ShallowWaterVolumeVariables< Traits >

Volume variables for the shallow water equations model.

Public Types
using	PrimaryVariables = typename Traits::PrimaryVariables
using	FluidSystem = typename Traits::FluidSystem
	export the underlying fluid system More...

Public Member Functions
template<class ElemSol , class Problem , class Element , class Scv >
void	update (const ElemSol &elemSol, const Problem &problem, const Element &element, const Scv &scv)
Scalar	extrusionFactor () const
	Return the extrusion factor (dummy variable). More...
const PrimaryVariables &	priVars () const
	Return the vector of primary variables. More...
Scalar	waterDepth () const
	Return water detph h inside the sub-control volume. More...
Scalar	velocity (int directionIndex) const
	Return water velocity component inside the sub-control volume. More...
Scalar	bedSurface () const
	Return the bed surface inside the sub-control volume. More...
Scalar	density (int phaseIdx=0) const
	Return the fluid density. More...

Member Typedef Documentation

FluidSystem

template<class Traits >

using Dumux::ShallowWaterVolumeVariables< Traits >::FluidSystem = typename Traits::FluidSystem

export the underlying fluid system

PrimaryVariables

template<class Traits >

using Dumux::ShallowWaterVolumeVariables< Traits >::PrimaryVariables = typename Traits::PrimaryVariables

Member Function Documentation

bedSurface()

template<class Traits >

Scalar Dumux::ShallowWaterVolumeVariables< Traits >::bedSurface ( ) const

inline

Return the bed surface inside the sub-control volume.

density()

template<class Traits >

Scalar Dumux::ShallowWaterVolumeVariables< Traits >::density ( int  phaseIdx = 0 ) const

inline

Return the fluid density.

extrusionFactor()

template<class Traits >

Scalar Dumux::ShallowWaterVolumeVariables< Traits >::extrusionFactor ( ) const

inline

Return the extrusion factor (dummy variable).

priVars()

template<class Traits >

const PrimaryVariables & Dumux::ShallowWaterVolumeVariables< Traits >::priVars ( ) const

inline

Return the vector of primary variables.

update()

template<class Traits >

template<class ElemSol , class Problem , class Element , class Scv >

void Dumux::ShallowWaterVolumeVariables< Traits >::update ( const ElemSol &  elemSol, const Problem &  problem, const Element &  element, const Scv &  scv  )

inline

velocity()

template<class Traits >

Scalar Dumux::ShallowWaterVolumeVariables< Traits >::velocity ( int  directionIndex ) const

inline

Return water velocity component inside the sub-control volume.

Parameters

directionIndex

index of the direction staring at x = 0

waterDepth()

template<class Traits >

Scalar Dumux::ShallowWaterVolumeVariables< Traits >::waterDepth ( ) const

inline

Return water detph h inside the sub-control volume.

---

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

• freeflow/shallowwater/volumevariables.hh