Dumux::RegularizedVanGenuchtenParams< ScalarT > Class Template Reference

Parameters that are necessary for the regularization of VanGenuchten "material law". More...

#include <dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchtenparams.hh>

Inheritance diagram for Dumux::RegularizedVanGenuchtenParams< ScalarT >:

Description

template<class ScalarT>
class Dumux::RegularizedVanGenuchtenParams< ScalarT >

Parameters that are necessary for the regularization of VanGenuchten "material law".

Public Types
using	Scalar = ScalarT
using	Parent = VanGenuchtenParams<Scalar>

Public Member Functions
	RegularizedVanGenuchtenParams ()
	RegularizedVanGenuchtenParams (Scalar vgAlpha, Scalar vgN)
template<class OtherParams>
bool	operator== (const OtherParams &otherParams) const
	Equality comparison with another set of params.
void	initialize ()
	Sets some default regularization thresholds.
void	setPcLowSw (Scalar pcLowSw)
	Set the threshold saturation below which the capillary pressure is regularized.
Scalar	pcLowSw () const
	Threshold saturation below which the capillary pressure is regularized.
void	setPcHighSw (Scalar pcHighSw)
	Set the threshold saturation above which the capillary pressure is regularized.
Scalar	pcHighSw () const
	Threshold saturation above which the capillary pressure is regularized.
void	setKrnLowSw (Scalar krnLowSw)
	Set the threshold saturation below which the relative permeability of the non-wetting phase gets regularized.
Scalar	krnLowSw () const
	Threshold saturation below which the relative permeability of the non-wetting phase gets regularized.
void	setKrwHighSw (Scalar krwHighSw)
	Set the threshold saturation above which the relative permeability of the wetting phase gets regularized.
Scalar	krwHighSw () const
	Threshold saturation above which the relative permeability of the wetting phase gets regularized.
Scalar	vgAlpha () const
	Return the \(\mathrm{\alpha}\) shape parameter \(\mathrm{[1/Pa]}\) of van Genuchten's curve.
void	setVgAlpha (Scalar v)
	Set the \(\mathrm{\alpha}\) shape parameter \(\mathrm{[1/Pa]}\) of van Genuchten's curve.
Scalar	vgm () const
	Return the \(\mathrm{m}\) shape parameter \(\mathrm{[-]}\) of van Genuchten's curve.
void	setVgm (Scalar m)
	Set the \(\mathrm{m}\) shape parameter \(\mathrm{[-]}\) of van Genuchten's curve.
Scalar	vgn () const
	Return the \(\mathrm{n}\) shape parameter \(\mathrm{[-]}\) of van Genuchten's curve.
void	setVgn (Scalar n)
	Set the \(\mathrm{n}\) shape parameter \(\mathrm{[-]}\) of van Genuchten's curve.

Member Typedef Documentation

Parent

template<class ScalarT>

using Dumux::RegularizedVanGenuchtenParams< ScalarT >::Parent = VanGenuchtenParams<Scalar>

Scalar

template<class ScalarT>

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

Constructor & Destructor Documentation

RegularizedVanGenuchtenParams() [1/2]

template<class ScalarT>

Dumux::RegularizedVanGenuchtenParams< ScalarT >::RegularizedVanGenuchtenParams ( )

inline

RegularizedVanGenuchtenParams() [2/2]

template<class ScalarT>

Dumux::RegularizedVanGenuchtenParams< ScalarT >::RegularizedVanGenuchtenParams ( Scalar vgAlpha, Scalar vgN )

inline

Member Function Documentation

initialize()

template<class ScalarT>

void Dumux::RegularizedVanGenuchtenParams< ScalarT >::initialize ( )

inline

Sets some default regularization thresholds.

krnLowSw()

template<class ScalarT>

Scalar Dumux::RegularizedVanGenuchtenParams< ScalarT >::krnLowSw ( ) const

inline

Threshold saturation below which the relative permeability of the non-wetting phase gets regularized.

krwHighSw()

template<class ScalarT>

Scalar Dumux::RegularizedVanGenuchtenParams< ScalarT >::krwHighSw ( ) const

inline

Threshold saturation above which the relative permeability of the wetting phase gets regularized.

operator==()

template<class ScalarT>

template<class OtherParams>

bool Dumux::RegularizedVanGenuchtenParams< ScalarT >::operator== ( const OtherParams & otherParams ) const

inline

Equality comparison with another set of params.

pcHighSw()

template<class ScalarT>

Scalar Dumux::RegularizedVanGenuchtenParams< ScalarT >::pcHighSw ( ) const

inline

Threshold saturation above which the capillary pressure is regularized.

Most problems are very sensitive to this value (e.g. making it smaller might result in negative capillary pressures).

pcLowSw()

template<class ScalarT>

Scalar Dumux::RegularizedVanGenuchtenParams< ScalarT >::pcLowSw ( ) const

inline

Threshold saturation below which the capillary pressure is regularized.

setKrnLowSw()

template<class ScalarT>

void Dumux::RegularizedVanGenuchtenParams< ScalarT >::setKrnLowSw ( Scalar krnLowSw )

inline

Set the threshold saturation below which the relative permeability of the non-wetting phase gets regularized.

setKrwHighSw()

template<class ScalarT>

void Dumux::RegularizedVanGenuchtenParams< ScalarT >::setKrwHighSw ( Scalar krwHighSw )

inline

Set the threshold saturation above which the relative permeability of the wetting phase gets regularized.

setPcHighSw()

template<class ScalarT>

void Dumux::RegularizedVanGenuchtenParams< ScalarT >::setPcHighSw ( Scalar pcHighSw )

inline

Set the threshold saturation above which the capillary pressure is regularized.

setPcLowSw()

template<class ScalarT>

void Dumux::RegularizedVanGenuchtenParams< ScalarT >::setPcLowSw ( Scalar pcLowSw )

inline

Set the threshold saturation below which the capillary pressure is regularized.

Most problems are very sensitive to this value (e.g. making it smaller might result in very high capillary pressures)

setVgAlpha()

template<class ScalarT>

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

inlineinherited

Set the \(\mathrm{\alpha}\) shape parameter \(\mathrm{[1/Pa]}\) of van Genuchten's curve.

setVgm()

template<class ScalarT>

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

inlineinherited

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

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

setVgn()

template<class ScalarT>

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

inlineinherited

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

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

vgAlpha()

template<class ScalarT>

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

inlineinherited

Return the \(\mathrm{\alpha}\) shape parameter \(\mathrm{[1/Pa]}\) of van Genuchten's curve.

vgm()

template<class ScalarT>

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

inlineinherited

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

vgn()

template<class ScalarT>

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

inlineinherited

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

---

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

• regularizedvangenuchtenparams.hh