3.4
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Member Functions | List of all members
Dumux::FluidMatrix::BrooksCorey::Params< Scalar > Struct Template Reference

The parameter type. More...

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

Description

template<class Scalar>
struct Dumux::FluidMatrix::BrooksCorey::Params< Scalar >

The parameter type.

Template Parameters
ScalarThe scalar type
Note
The Brooks Corey laws are parameterized with two parameters: \(\mathrm{p_{ce}, \lambda}\), the capillary entry pressure in \(\mathrm{[Pa]}\)] and a dimensionless shape parameter, respectively.

Public Member Functions

 Params (Scalar pcEntry, Scalar lambda)
 
Scalar pcEntry () const
 
void setPcEntry (Scalar pcEntry)
 
Scalar lambda () const
 
void setLambda (Scalar lambda)
 
bool operator== (const Params &p) const
 

Constructor & Destructor Documentation

◆ Params()

template<class Scalar >
Dumux::FluidMatrix::BrooksCorey::Params< Scalar >::Params ( Scalar  pcEntry,
Scalar  lambda 
)
inline

Member Function Documentation

◆ lambda()

template<class Scalar >
Scalar Dumux::FluidMatrix::BrooksCorey::Params< Scalar >::lambda ( ) const
inline

◆ operator==()

template<class Scalar >
bool Dumux::FluidMatrix::BrooksCorey::Params< Scalar >::operator== ( const Params< Scalar > &  p) const
inline

◆ pcEntry()

template<class Scalar >
Scalar Dumux::FluidMatrix::BrooksCorey::Params< Scalar >::pcEntry ( ) const
inline

◆ setLambda()

template<class Scalar >
void Dumux::FluidMatrix::BrooksCorey::Params< Scalar >::setLambda ( Scalar  lambda)
inline

◆ setPcEntry()

template<class Scalar >
void Dumux::FluidMatrix::BrooksCorey::Params< Scalar >::setPcEntry ( Scalar  pcEntry)
inline

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