version 3.8
Dumux::ShallowWaterVolumeVariables< Traits > Class Template Reference

Volume variables for the shallow water equations model.

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

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 PrimaryVariablespriVars () 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
 Returns the mass density \(\mathrm{[kg/m^3]}\) of the fluid. More...
 
Scalar viscosity (int phaseIdx=0) const
 Return the dynamic viscosity \(\mathrm{[Pa s]}\) of the fluid. More...
 

Member Typedef Documentation

◆ FluidSystem

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

◆ 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

◆ density()

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

◆ extrusionFactor()

template<class Traits >
Scalar Dumux::ShallowWaterVolumeVariables< Traits >::extrusionFactor ( ) const
inline

◆ priVars()

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

◆ 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
Parameters
directionIndexindex of the direction staring at x = 0

◆ viscosity()

template<class Traits >
Scalar Dumux::ShallowWaterVolumeVariables< Traits >::viscosity ( int  phaseIdx = 0) const
inline

◆ waterDepth()

template<class Traits >
Scalar Dumux::ShallowWaterVolumeVariables< Traits >::waterDepth ( ) const
inline

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