Dumux::BrooksCoreyParams< ScalarT > Class Template Reference

Specification of the material parameters for the Brooks Corey constitutive relations. More...

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

Inheritance diagram for Dumux::BrooksCoreyParams< ScalarT >:

Description

template<class ScalarT>
class Dumux::BrooksCoreyParams< ScalarT >

Specification of the material parameters for the Brooks Corey constitutive relations.

See also

BrooksCorey

Public Types
using	Scalar = ScalarT

Public Member Functions
	BrooksCoreyParams ()=default
	BrooksCoreyParams (Scalar pe, Scalar lambda)
template<class OtherParams >
bool	operator== (const OtherParams &otherParams) const
	Equality comparison with another set of params. 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::BrooksCoreyParams< ScalarT >::Scalar = ScalarT

Constructor & Destructor Documentation

BrooksCoreyParams() [1/2]

template<class ScalarT >

Dumux::BrooksCoreyParams< ScalarT >::BrooksCoreyParams ( )

default

BrooksCoreyParams() [2/2]

template<class ScalarT >

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

inline

Member Function Documentation

lambda()

template<class ScalarT >

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

inline

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

operator==()

template<class ScalarT >

template<class OtherParams >

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

inline

Equality comparison with another set of params.

pe()

template<class ScalarT >

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

inline

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

setLambda()

template<class ScalarT >

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

inline

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

setPe()

template<class ScalarT >

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

inline

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

---

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

• brookscoreyparams.hh