Dumux::ParkerVanGen3PParams< ScalarT > Class Template Reference

Reference implementation of a van Genuchten params. More...

#include <dumux/material/fluidmatrixinteractions/3p/parkervangen3pparams.hh>

Inheritance diagram for Dumux::ParkerVanGen3PParams< ScalarT >:

Description

template<class ScalarT>
class Dumux::ParkerVanGen3PParams< ScalarT >

Reference implementation of a van Genuchten params.

Public Types
using	Scalar = ScalarT

Public Member Functions
	ParkerVanGen3PParams ()
	ParkerVanGen3PParams (Scalar vgAlpha, Scalar vgn, Scalar KdNAPL, Scalar rhoBulk, Dune::FieldVector< Scalar, 4 > residualSaturation, Scalar betaNw=1.0, Scalar betaGn=1.0, Scalar betaGw=1.0, bool regardSnr=false)
Scalar	vgAlpha () const
	Return the \(\mathrm{\alpha}\) shape parameter of van Genuchten's curve. More...
void	setVgAlpha (Scalar v)
	Set the \(\mathrm{\alpha}\) shape parameter of van Genuchten's curve. More...
Scalar	vgm () const
	Return the \(\mathrm{m}\) shape parameter of van Genuchten's curve. More...
void	setVgm (Scalar m)
	Set the \(\mathrm{m}\) shape parameter of van Genuchten's curve. More...
Scalar	vgn () const
	Return the \(\mathrm{n}\) shape parameter of van Genuchten's curve. More...
void	setVgn (Scalar n)
	Set the \(\mathrm{n}\) shape parameter of van Genuchten's curve. More...
Scalar	satResidual (int phaseIdx) const
	Return the residual saturation. More...
void	setResiduals (Dune::FieldVector< Scalar, 3 > residualSaturation)
	Set all residual saturations. More...
Scalar	swr () const
	Return the residual wetting saturation. More...
void	setSwr (Scalar input)
	Set the residual wetting saturation. More...
Scalar	snr () const
	Return the residual non-wetting saturation. More...
void	setSnr (Scalar input)
	Set the residual non-wetting saturation. More...
Scalar	sgr () const
	Return the residual gas saturation. More...
void	setSgr (Scalar input)
	Set the residual gas saturation. More...
Scalar	swrx () const
	Set the residual total liquid saturation. More...
void	setSwrx (Scalar v)
	Set the residual total liquid saturation. More...
void	setBetaNw (Scalar input)
	defines the scaling parameters of capillary pressure between the phases (=1 for Gas-Water) More...
void	setBetaGn (Scalar input)
void	setBetaGw (Scalar input)
Scalar	betaNw () const
	Return the values for the beta scaling parameters of capillary pressure between the phases. More...
Scalar	betaGn () const
Scalar	betaGw () const
void	setKrRegardsSnr (bool input)
	defines if residual n-phase saturation should be regarded in its relative permeability. More...
bool	krRegardsSnr () const
	Calls if residual n-phase saturation should be regarded in its relative permeability. More...
Scalar	rhoBulk () const
	Return the bulk density of the porous medium in \(\mathrm{[kg/m^3]}\). More...
void	setRhoBulk (Scalar input)
	Set the bulk density of the porous medium. More...
Scalar	KdNAPL () const
	Return the adsorption coefficient. More...
void	setKdNAPL (Scalar input)
	Set the adsorption coefficient. More...

Member Typedef Documentation

Scalar

template<class ScalarT >

using Dumux::ParkerVanGen3PParams< ScalarT >::Scalar = ScalarT

Constructor & Destructor Documentation

ParkerVanGen3PParams() [1/2]

template<class ScalarT >

Dumux::ParkerVanGen3PParams< ScalarT >::ParkerVanGen3PParams ( )

inline

ParkerVanGen3PParams() [2/2]

template<class ScalarT >

Dumux::ParkerVanGen3PParams< ScalarT >::ParkerVanGen3PParams ( Scalar  vgAlpha, Scalar  vgn, Scalar  KdNAPL, Scalar  rhoBulk, Dune::FieldVector< Scalar, 4 >  residualSaturation, Scalar  betaNw = 1.0, Scalar  betaGn = 1.0, Scalar  betaGw = 1.0, bool  regardSnr = false  )

inline

Member Function Documentation

betaGn()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::betaGn ( ) const

inline

betaGw()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::betaGw ( ) const

inline

betaNw()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::betaNw ( ) const

inline

Return the values for the beta scaling parameters of capillary pressure between the phases.

KdNAPL()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::KdNAPL ( ) const

inline

Return the adsorption coefficient.

krRegardsSnr()

template<class ScalarT >

bool Dumux::ParkerVanGen3PParams< ScalarT >::krRegardsSnr ( ) const

inline

Calls if residual n-phase saturation should be regarded in its relative permeability.

rhoBulk()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::rhoBulk ( ) const

inline

Return the bulk density of the porous medium in \(\mathrm{[kg/m^3]}\).

satResidual()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::satResidual ( int  phaseIdx ) const

inline

Return the residual saturation.

Parameters

phaseIdx

Indicator, The saturation of phases

setBetaGn()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setBetaGn ( Scalar  input )

inline

setBetaGw()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setBetaGw ( Scalar  input )

inline

setBetaNw()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setBetaNw ( Scalar  input )

inline

defines the scaling parameters of capillary pressure between the phases (=1 for Gas-Water)

setKdNAPL()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setKdNAPL ( Scalar  input )

inline

Set the adsorption coefficient.

Parameters

input

Set the adsorption coefficient

setKrRegardsSnr()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setKrRegardsSnr ( bool  input )

inline

defines if residual n-phase saturation should be regarded in its relative permeability.

Parameters

input

Regard residual n-phase saturation

setResiduals()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setResiduals ( Dune::FieldVector< Scalar, 3 >  residualSaturation )

inline

Set all residual saturations.

setRhoBulk()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setRhoBulk ( Scalar  input )

inline

Set the bulk density of the porous medium.

Parameters

input

Density of the porous medium in \(\mathrm{[kg/m^3]}\)

setSgr()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setSgr ( Scalar  input )

inline

Set the residual gas saturation.

Parameters

input

Set the resiudal gas saturation

setSnr()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setSnr ( Scalar  input )

inline

Set the residual non-wetting saturation.

Parameters

input

Set the resiudal non-wetting saturation

setSwr()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setSwr ( Scalar  input )

inline

Set the residual wetting saturation.

Parameters

input

Set residual wetting saturation

setSwrx()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setSwrx ( Scalar  v )

inline

Set the residual total liquid saturation.

Parameters

v	Set the resiudal gas saturation

setVgAlpha()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setVgAlpha ( Scalar  v )

inline

Set the \(\mathrm{\alpha}\) shape parameter of van Genuchten's curve.

Parameters

v	Set shape parameter

setVgm()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setVgm ( Scalar  m )

inline

Set the \(\mathrm{m}\) shape parameter of van Genuchten's curve.

Parameters

m	Set shape parameter

The \(\mathrm{n}\) shape parameter is set to \(n = \frac{1}{1 - m}\)

setVgn()

template<class ScalarT >

void Dumux::ParkerVanGen3PParams< ScalarT >::setVgn ( Scalar  n )

inline

Set the \(\mathrm{n}\) shape parameter of van Genuchten's curve.

Parameters

n	Set shape parameter

The \(\mathrm{n}\) shape parameter is set to \(\mathrm{m = 1 - \frac{1}{n}}\)

sgr()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::sgr ( ) const

inline

Return the residual gas saturation.

snr()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::snr ( ) const

inline

Return the residual non-wetting saturation.

swr()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::swr ( ) const

inline

Return the residual wetting saturation.

swrx()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::swrx ( ) const

inline

Set the residual total liquid saturation.

vgAlpha()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::vgAlpha ( ) const

inline

Return the \(\mathrm{\alpha}\) shape parameter of van Genuchten's curve.

vgm()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::vgm ( ) const

inline

Return the \(\mathrm{m}\) shape parameter of van Genuchten's curve.

vgn()

template<class ScalarT >

Scalar Dumux::ParkerVanGen3PParams< ScalarT >::vgn ( ) const

inline

Return the \(\mathrm{n}\) shape parameter of van Genuchten's curve.

---

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

• parkervangen3pparams.hh