Dumux::RegularizedBrooksCoreyParams< ScalarT > Class Template Reference

Parameters that are necessary for the regularization of the Brooks-Corey capillary pressure model. More...

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

Inheritance diagram for Dumux::RegularizedBrooksCoreyParams< ScalarT >:

Description

template<class ScalarT>
class Dumux::RegularizedBrooksCoreyParams< ScalarT >

Parameters that are necessary for the regularization of the Brooks-Corey capillary pressure model.

Public Types
using	Scalar = ScalarT

Public Member Functions
	RegularizedBrooksCoreyParams ()
	RegularizedBrooksCoreyParams (Scalar pe, Scalar lambda)
template<class OtherParams >
bool	operator== (const OtherParams &otherParams) const
	Equality comparison with another set of params. More...
void	setThresholdSw (Scalar thresholdSw)
	Set the threshold saturation below which the capillary pressure is regularized. More...
Scalar	thresholdSw () const
	Threshold saturation below which the capillary pressure is regularized. More...
Scalar	pe () const
	Returns the entry pressure in $\mathrm{[Pa]}$. More...
void	setPe (Scalar v)
	Set the entry pressure in $\mathrm{[Pa]}$]. More...
Scalar	lambda () const
	Returns the lambda shape parameter $\mathrm{[-]}$. More...
void	setLambda (Scalar v)
	Set the lambda shape parameter $\mathrm{[-]}$. More...

Member Typedef Documentation

Scalar

template<class ScalarT >

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

Constructor & Destructor Documentation

RegularizedBrooksCoreyParams() [1/2]

template<class ScalarT >

Dumux::RegularizedBrooksCoreyParams< ScalarT >::RegularizedBrooksCoreyParams ( )

inline

RegularizedBrooksCoreyParams() [2/2]

template<class ScalarT >

Dumux::RegularizedBrooksCoreyParams< ScalarT >::RegularizedBrooksCoreyParams ( Scalar  pe, Scalar  lambda  )

inline

Member Function Documentation

lambda()

template<class ScalarT >

Scalar Dumux::BrooksCoreyParams< ScalarT >::lambda ( ) const

inlineinherited

Returns the lambda shape parameter $\mathrm{[-]}$.

operator==()

template<class ScalarT >

template<class OtherParams >

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

inline

Equality comparison with another set of params.

pe()

template<class ScalarT >

Scalar Dumux::BrooksCoreyParams< ScalarT >::pe ( ) const

inlineinherited

Returns the entry pressure in $\mathrm{[Pa]}$.

setLambda()

template<class ScalarT >

void Dumux::BrooksCoreyParams< ScalarT >::setLambda ( Scalar  v )

inlineinherited

Set the lambda shape parameter $\mathrm{[-]}$.

setPe()

template<class ScalarT >

void Dumux::BrooksCoreyParams< ScalarT >::setPe ( Scalar  v )

inlineinherited

Set the entry pressure in $\mathrm{[Pa]}$].

setThresholdSw()

template<class ScalarT >

void Dumux::RegularizedBrooksCoreyParams< ScalarT >::setThresholdSw ( Scalar  thresholdSw )

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 negative pressures).

thresholdSw()

template<class ScalarT >

Scalar Dumux::RegularizedBrooksCoreyParams< ScalarT >::thresholdSw ( ) const

inline

Threshold saturation below which the capillary pressure is regularized.

---

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

• regularizedbrookscoreyparams.hh