Dumux::VanGenuchtenParams< ScalarT > Class Template Reference

Specification of the material parameters for the van Genuchten constitutive relations. More...

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

Inheritance diagram for Dumux::VanGenuchtenParams< ScalarT >:

Description

template<class ScalarT>
class Dumux::VanGenuchtenParams< ScalarT >

Specification of the material parameters for the van Genuchten constitutive relations.

In this implementation setting either the \(\mathrm{n}\) or \(\mathrm{m}\) shape parameter automatically calculates the other. I.e. they cannot be set independently.

Public Types
using	Scalar = ScalarT

Public Member Functions
	VanGenuchtenParams ()
	VanGenuchtenParams (Scalar vgAlpha, Scalar vgn)
template<class OtherParams>
bool	operator== (const OtherParams &otherParams) const
	Equality comparison with another set of params.
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

Scalar

template<class ScalarT>

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

Constructor & Destructor Documentation

VanGenuchtenParams() [1/2]

template<class ScalarT>

Dumux::VanGenuchtenParams< ScalarT >::VanGenuchtenParams ( )

inline

VanGenuchtenParams() [2/2]

template<class ScalarT>

Dumux::VanGenuchtenParams< ScalarT >::VanGenuchtenParams ( Scalar vgAlpha, Scalar vgn )

inline

Member Function Documentation

operator==()

template<class ScalarT>

template<class OtherParams>

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

inline

Equality comparison with another set of params.

setVgAlpha()

template<class ScalarT>

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

inline

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 )

inline

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 )

inline

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

inline

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

vgm()

template<class ScalarT>

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

inline

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

vgn()

template<class ScalarT>

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

inline

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

---

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

• vangenuchtenparams.hh