Opm::ParkerLenhardParams< TraitsT > Class Template Reference

Default parameter class for the Parker-Lenhard hysteresis model. More...

#include <ParkerLenhardParams.hpp>

Public Types
typedef TraitsT::Scalar	Scalar
typedef Opm::RegularizedVanGenuchten < TraitsT >	VanGenuchten
typedef VanGenuchten::Params	VanGenuchtenParams
typedef PLScanningCurve< Scalar >	ScanningCurve

Public Member Functions
	ParkerLenhardParams ()
	ParkerLenhardParams (const ParkerLenhardParams &p)
	~ParkerLenhardParams ()
void	finalize ()
	Calculate all dependent quantities once the independent quantities of the parameter object have been set. More...
const VanGenuchtenParams &	micParams () const
	Returns the parameters of the main imbibition curve (which uses the van Genuchten capillary pressure model). More...
void	setMicParams (const VanGenuchtenParams *val)
	Sets the parameters of the main imbibition curve (which uses the van Genuchten capillary pressure model). More...
const VanGenuchtenParams &	mdcParams () const
	Returns the parameters of the main drainage curve (which uses the van Genuchten capillary pressure model). More...
void	setMdcParams (const VanGenuchtenParams *val)
	Sets the parameters of the main drainage curve (which uses the van Genuchten capillary pressure model). More...
Scalar	Snr () const
	Returns non-wetting phase residual saturation. More...
void	setSnr (Scalar val)
	Set the non-wetting phase residual saturation. More...
Scalar	SwrPc () const
	Returns wetting phase residual saturation for the capillary pressure curve. More...
Scalar	SwrKr () const
	Returns wetting phase residual saturation for the residual saturation curves. More...
void	setSwr (Scalar pcSwr, Scalar krSwr=-1)
	Set the wetting phase residual saturation for the capillary pressure and the relative permeabilities. More...
Scalar	currentSnr () const
	Returns the current effective residual saturation. More...
void	setCurrentSnr (Scalar val)
	Set the current effective residual saturation. More...
ScanningCurve *	mdc () const
	Returns the main drainage curve. More...
void	setMdc (ScanningCurve *val)
	Set the main drainage curve. More...
ScanningCurve *	pisc () const
	Returns the primary imbibition scanning curve. More...
void	setPisc (ScanningCurve *val)
	Set the primary imbibition scanning curve. More...
ScanningCurve *	csc () const
	Returns the current scanning curve. More...
void	setCsc (ScanningCurve *val)
	Set the current scanning curve. More...

Detailed Description

template<class TraitsT>
class Opm::ParkerLenhardParams< TraitsT >

Default parameter class for the Parker-Lenhard hysteresis model.

Member Typedef Documentation

template<class TraitsT >

typedef TraitsT::Scalar Opm::ParkerLenhardParams< TraitsT >::Scalar

template<class TraitsT >

typedef PLScanningCurve<Scalar> Opm::ParkerLenhardParams< TraitsT >::ScanningCurve

template<class TraitsT >

typedef Opm::RegularizedVanGenuchten<TraitsT> Opm::ParkerLenhardParams< TraitsT >::VanGenuchten

template<class TraitsT >

typedef VanGenuchten::Params Opm::ParkerLenhardParams< TraitsT >::VanGenuchtenParams

Constructor & Destructor Documentation

template<class TraitsT >

Opm::ParkerLenhardParams< TraitsT >::ParkerLenhardParams ( )

inline

template<class TraitsT >

Opm::ParkerLenhardParams< TraitsT >::ParkerLenhardParams ( const ParkerLenhardParams< TraitsT > &  p )

inline

template<class TraitsT >

Opm::ParkerLenhardParams< TraitsT >::~ParkerLenhardParams ( )

inline

Member Function Documentation

template<class TraitsT >

ScanningCurve* Opm::ParkerLenhardParams< TraitsT >::csc ( ) const

inline

Returns the current scanning curve.

template<class TraitsT >

Scalar Opm::ParkerLenhardParams< TraitsT >::currentSnr ( ) const

inline

Returns the current effective residual saturation.

template<class TraitsT >

void Opm::ParkerLenhardParams< TraitsT >::finalize ( )

inline

Calculate all dependent quantities once the independent quantities of the parameter object have been set.

template<class TraitsT >

ScanningCurve* Opm::ParkerLenhardParams< TraitsT >::mdc ( ) const

inline

Returns the main drainage curve.

template<class TraitsT >

const VanGenuchtenParams& Opm::ParkerLenhardParams< TraitsT >::mdcParams ( ) const

inline

Returns the parameters of the main drainage curve (which uses the van Genuchten capillary pressure model).

template<class TraitsT >

const VanGenuchtenParams& Opm::ParkerLenhardParams< TraitsT >::micParams ( ) const

inline

Returns the parameters of the main imbibition curve (which uses the van Genuchten capillary pressure model).

template<class TraitsT >

ScanningCurve* Opm::ParkerLenhardParams< TraitsT >::pisc ( ) const

inline

Returns the primary imbibition scanning curve.

template<class TraitsT >

void Opm::ParkerLenhardParams< TraitsT >::setCsc ( ScanningCurve *  val )

inline

Set the current scanning curve.

template<class TraitsT >

void Opm::ParkerLenhardParams< TraitsT >::setCurrentSnr ( Scalar  val )

inline

Set the current effective residual saturation.

template<class TraitsT >

void Opm::ParkerLenhardParams< TraitsT >::setMdc ( ScanningCurve *  val )

inline

Set the main drainage curve.

template<class TraitsT >

void Opm::ParkerLenhardParams< TraitsT >::setMdcParams ( const VanGenuchtenParams *  val )

inline

Sets the parameters of the main drainage curve (which uses the van Genuchten capillary pressure model).

template<class TraitsT >

void Opm::ParkerLenhardParams< TraitsT >::setMicParams ( const VanGenuchtenParams *  val )

inline

Sets the parameters of the main imbibition curve (which uses the van Genuchten capillary pressure model).

template<class TraitsT >

void Opm::ParkerLenhardParams< TraitsT >::setPisc ( ScanningCurve *  val )

inline

Set the primary imbibition scanning curve.

template<class TraitsT >

void Opm::ParkerLenhardParams< TraitsT >::setSnr ( Scalar  val )

inline

Set the non-wetting phase residual saturation.

template<class TraitsT >

void Opm::ParkerLenhardParams< TraitsT >::setSwr ( Scalar  pcSwr, Scalar  krSwr = -1  )

inline

Set the wetting phase residual saturation for the capillary pressure and the relative permeabilities.

template<class TraitsT >

Scalar Opm::ParkerLenhardParams< TraitsT >::Snr ( ) const

inline

Returns non-wetting phase residual saturation.

template<class TraitsT >

Scalar Opm::ParkerLenhardParams< TraitsT >::SwrKr ( ) const

inline

Returns wetting phase residual saturation for the residual saturation curves.

template<class TraitsT >

Scalar Opm::ParkerLenhardParams< TraitsT >::SwrPc ( ) const

inline

Returns wetting phase residual saturation for the capillary pressure curve.

---

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

• ParkerLenhardParams.hpp