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

Volume averaged quantities required by the Richards model. More...

#include <dumux/porousmediumflow/richards/volumevariables.hh>

Inheritance diagram for Dumux::RichardsVolumeVariables< Traits >:

Description

template<class Traits>
class Dumux::RichardsVolumeVariables< Traits >

This contains the quantities which are are constant within a finite volume in the Richards model.

Public Types

using FluidSystem = typename Traits::FluidSystem
 Export type of the fluid system. More...
 
using FluidState = typename Traits::FluidState
 Export type of the fluid state. More...
 
using SolidState = typename Traits::SolidState
 
using SolidSystem = typename Traits::SolidSystem
 Export type of solid system. More...
 
using Indices = typename Traits::ModelTraits::Indices
 
using PrimaryVariables = typename Traits::PrimaryVariables
 Export the type used for the primary variables. 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)
 Updates all quantities for a given control volume. More...
 
template<class ElemSol , class Problem , class Element , class Scv >
void completeFluidState (const ElemSol &elemSol, const Problem &problem, const Element &element, const Scv &scv, FluidState &fluidState, SolidState &solidState)
 Fills the fluid state according to the primary variables. More...
 
const FluidStatefluidState () const
 Returns the fluid configuration at the given primary variables. More...
 
const SolidStatesolidState () const
 Returns the phase state for the control volume. More...
 
Scalar temperature () const
 Returns the temperature. More...
 
Scalar porosity () const
 Returns the average porosity [] within the control volume. More...
 
const PermeabilityType & permeability () const
 Returns the permeability within the control volume in \([m^2]\). More...
 
Scalar saturation (const int phaseIdx=liquidPhaseIdx) const
 Returns the average absolute saturation [] of a given fluid phase within the finite volume. More...
 
Scalar density (const int phaseIdx=liquidPhaseIdx) const
 Returns the average mass density \(\mathrm{[kg/m^3]}\) of a given fluid phase within the control volume. More...
 
Scalar pressure (const int phaseIdx=liquidPhaseIdx) const
 Returns the effective pressure \(\mathrm{[Pa]}\) of a given phase within the control volume. More...
 
Scalar mobility (const int phaseIdx=liquidPhaseIdx) const
 Returns the effective mobility \(\mathrm{[1/(Pa*s)]}\) of a given phase within the control volume. More...
 
Scalar viscosity (const int phaseIdx=liquidPhaseIdx) const
 Returns the dynamic viscosity \(\mathrm{[Pa*s]}\) of a given phase within the control volume. More...
 
Scalar relativePermeability (const int phaseIdx=liquidPhaseIdx) const
 Returns relative permeability [-] of a given phase within the control volume. More...
 
Scalar capillaryPressure () const
 Returns the effective capillary pressure \(\mathrm{[Pa]}\) within the control volume. More...
 
Scalar pressureHead (const int phaseIdx=liquidPhaseIdx) const
 Returns the pressureHead \(\mathrm{[cm]}\) of a given phase within the control volume. More...
 
Scalar waterContent (const int phaseIdx=liquidPhaseIdx) const
 Returns the water content of a fluid phase within the finite volume. More...
 
const PrimaryVariablespriVars () const
 Returns the vector of primary variables. More...
 
Scalar priVar (const int pvIdx) const
 Returns a component of primary variable vector. More...
 
Scalar extrusionFactor () const
 Returns how much the sub-control volume is extruded. More...
 

Static Public Member Functions

static constexpr int numFluidPhases ()
 Return number of phases considered by the model. More...
 
static constexpr int numFluidComponents ()
 Return number of components considered by the model. More...
 

Static Public Attributes

static constexpr auto liquidPhaseIdx = Traits::FluidSystem::phase0Idx
 Export phase indices. More...
 
static constexpr auto gasPhaseIdx = Traits::FluidSystem::phase1Idx
 

Protected Attributes

FluidState fluidState_
 the fluid state More...
 
SolidState solidState_
 
Scalar relativePermeabilityWetting_
 the relative permeability of the wetting phase More...
 
PermeabilityType permeability_
 the intrinsic permeability More...
 
Scalar minPc_
 the minimum capillary pressure (entry pressure) More...
 
Scalar effectiveDiffCoeff_
 

Member Typedef Documentation

◆ FluidState

template<class Traits >
using Dumux::RichardsVolumeVariables< Traits >::FluidState = typename Traits::FluidState

◆ FluidSystem

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

◆ Indices

template<class Traits >
using Dumux::RichardsVolumeVariables< Traits >::Indices = typename Traits::ModelTraits::Indices

◆ PrimaryVariables

template<class Traits >
using Dumux::PorousMediumFlowVolumeVariables< Traits >::PrimaryVariables = typename Traits::PrimaryVariables
inherited

◆ SolidState

template<class Traits >
using Dumux::RichardsVolumeVariables< Traits >::SolidState = typename Traits::SolidState

Export type of the fluid state Export type of solid state

◆ SolidSystem

template<class Traits >
using Dumux::RichardsVolumeVariables< Traits >::SolidSystem = typename Traits::SolidSystem

Member Function Documentation

◆ capillaryPressure()

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::capillaryPressure ( ) const
inline

The capillary pressure is defined as the difference in pressures of the nonwetting and the wetting phase, i.e.

\[ p_c = p_n - p_w \]

Note
Capillary pressures are always larger than the entry pressure This regularization doesn't affect the residual in which pc is not needed.

◆ completeFluidState()

template<class Traits >
template<class ElemSol , class Problem , class Element , class Scv >
void Dumux::RichardsVolumeVariables< Traits >::completeFluidState ( const ElemSol &  elemSol,
const Problem &  problem,
const Element &  element,
const Scv &  scv,
FluidState fluidState,
SolidState solidState 
)
inline

Taking the information from the primary variables, the fluid state is filled with every information that is necessary to evaluate the model's local residual.

Parameters
elemSolA vector containing all primary variables connected to the element
problemThe problem at hand.
elementThe current element.
scvThe subcontrol volume.
fluidStateThe fluid state to fill.
solidStateThe solid state to fill.

◆ density()

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::density ( const int  phaseIdx = liquidPhaseIdx) const
inline
Parameters
phaseIdxThe index of the fluid phase

◆ extrusionFactor()

template<class Traits >
Scalar Dumux::PorousMediumFlowVolumeVariables< Traits >::extrusionFactor ( ) const
inlineinherited

This means the factor by which a lower-dimensional (1D or 2D) entity needs to be expanded to get a full dimensional cell. The default is 1.0 which means that 1D problems are actually thought as pipes with a cross section of 1 m^2 and 2D problems are assumed to extend 1 m to the back.

◆ fluidState()

template<class Traits >
const FluidState & Dumux::RichardsVolumeVariables< Traits >::fluidState ( ) const
inline

◆ mobility()

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::mobility ( const int  phaseIdx = liquidPhaseIdx) const
inline

The mobility of a fluid phase is defined as the relative permeability of the phase (given by the chosen material law) divided by the dynamic viscosity of the fluid, i.e.

\[ \lambda_\alpha := \frac{k_{r\alpha}}{\mu_\alpha} \]

Parameters
phaseIdxThe index of the fluid phase

◆ numFluidComponents()

template<class Traits >
static constexpr int Dumux::PorousMediumFlowVolumeVariables< Traits >::numFluidComponents ( )
inlinestaticconstexprinherited

◆ numFluidPhases()

template<class Traits >
static constexpr int Dumux::PorousMediumFlowVolumeVariables< Traits >::numFluidPhases ( )
inlinestaticconstexprinherited

◆ permeability()

template<class Traits >
const PermeabilityType & Dumux::RichardsVolumeVariables< Traits >::permeability ( ) const
inline

◆ porosity()

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::porosity ( ) const
inline

The porosity is defined as the ratio of the pore space to the total volume, i.e.

\[ \Phi := \frac{V_{pore}}{V_{pore} + V_{rock}} \]

◆ pressure()

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::pressure ( const int  phaseIdx = liquidPhaseIdx) const
inline

For the nonwetting phase (i.e. the gas phase), we assume infinite mobility, which implies that the nonwetting phase pressure is equal to the finite volume's reference pressure defined by the problem.

Parameters
phaseIdxThe index of the fluid phase

◆ pressureHead()

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::pressureHead ( const int  phaseIdx = liquidPhaseIdx) const
inline

For the nonwetting phase (i.e. the gas phase), we assume infinite mobility, which implies that the nonwetting phase pressure is equal to the finite volume's reference pressure defined by the problem.

Parameters
phaseIdxThe index of the fluid phase
Note
this function is here as a convenience to the user to not have to manually do a conversion. It is not correct if the density is not constant or the gravity different

◆ priVar()

template<class Traits >
Scalar Dumux::PorousMediumFlowVolumeVariables< Traits >::priVar ( const int  pvIdx) const
inlineinherited
Parameters
pvIdxThe index of the primary variable of interest

◆ priVars()

template<class Traits >
const PrimaryVariables & Dumux::PorousMediumFlowVolumeVariables< Traits >::priVars ( ) const
inlineinherited

◆ relativePermeability()

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::relativePermeability ( const int  phaseIdx = liquidPhaseIdx) const
inline
Parameters
phaseIdxThe index of the fluid phase

◆ saturation()

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::saturation ( const int  phaseIdx = liquidPhaseIdx) const
inline

The saturation of a fluid phase is defined as the fraction of the pore volume filled by it, i.e.

\[ S_\alpha := \frac{V_\alpha}{V_{pore}} = \phi \frac{V_\alpha}{V} \]

Parameters
phaseIdxThe index of the fluid phase

◆ solidState()

template<class Traits >
const SolidState & Dumux::RichardsVolumeVariables< Traits >::solidState ( ) const
inline

◆ temperature()

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::temperature ( ) const
inline

◆ update()

template<class Traits >
template<class ElemSol , class Problem , class Element , class Scv >
void Dumux::RichardsVolumeVariables< Traits >::update ( const ElemSol &  elemSol,
const Problem &  problem,
const Element &  element,
const Scv &  scv 
)
inline
Parameters
elemSolA vector containing all primary variables connected to the element
problemThe object specifying the problem which ought to be simulated
elementAn element which contains part of the control volume
scvThe sub-control volume

◆ viscosity()

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::viscosity ( const int  phaseIdx = liquidPhaseIdx) const
inline
Parameters
phaseIdxThe index of the fluid phase
Note
The nonwetting phase is infinitely mobile

◆ waterContent()

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::waterContent ( const int  phaseIdx = liquidPhaseIdx) const
inline

The water content is defined as the fraction of the saturation divided by the porosity.

Parameters
phaseIdxThe index of the fluid phase
Note
this function is here as a convenience to the user to not have to manually do a conversion.

Member Data Documentation

◆ effectiveDiffCoeff_

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::effectiveDiffCoeff_
protected

◆ fluidState_

template<class Traits >
FluidState Dumux::RichardsVolumeVariables< Traits >::fluidState_
protected

◆ gasPhaseIdx

template<class Traits >
constexpr auto Dumux::RichardsVolumeVariables< Traits >::gasPhaseIdx = Traits::FluidSystem::phase1Idx
staticconstexpr

◆ liquidPhaseIdx

template<class Traits >
constexpr auto Dumux::RichardsVolumeVariables< Traits >::liquidPhaseIdx = Traits::FluidSystem::phase0Idx
staticconstexpr

◆ minPc_

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::minPc_
protected

◆ permeability_

template<class Traits >
PermeabilityType Dumux::RichardsVolumeVariables< Traits >::permeability_
protected

◆ relativePermeabilityWetting_

template<class Traits >
Scalar Dumux::RichardsVolumeVariables< Traits >::relativePermeabilityWetting_
protected

◆ solidState_

template<class Traits >
SolidState Dumux::RichardsVolumeVariables< Traits >::solidState_
protected

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