My Project
Opm::ParkerLenhardParams< TraitsT > Class Template Reference

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

#include <ParkerLenhardParams.hpp>

Inheritance diagram for Opm::ParkerLenhardParams< TraitsT >:
Opm::EnsureFinalized

Public Types

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

Public Member Functions

 ParkerLenhardParams (const ParkerLenhardParams &p)
 
const VanGenuchtenParams & micParams () const
 Returns the parameters of the main imbibition curve (which uses the van Genuchten capillary pressure model).
 
void setMicParams (const VanGenuchtenParams *val)
 Sets the parameters of the main imbibition curve (which uses the van Genuchten capillary pressure model).
 
const VanGenuchtenParams & mdcParams () const
 Returns the parameters of the main drainage curve (which uses the van Genuchten capillary pressure model).
 
void setMdcParams (const VanGenuchtenParams *val)
 Sets the parameters of the main drainage curve (which uses the van Genuchten capillary pressure model).
 
Scalar Snr () const
 Returns non-wetting phase residual saturation.
 
void setSnr (Scalar val)
 Set the non-wetting phase residual saturation.
 
Scalar SwrPc () const
 Returns wetting phase residual saturation for the capillary pressure curve.
 
Scalar SwrKr () const
 Returns wetting phase residual saturation for the residual saturation curves.
 
void setSwr (Scalar pcSwr, Scalar krSwr=-1)
 Set the wetting phase residual saturation for the capillary pressure and the relative permeabilities.
 
Scalar currentSnr () const
 Returns the current effective residual saturation.
 
void setCurrentSnr (Scalar val)
 Set the current effective residual saturation.
 
ScanningCurvemdc () const
 Returns the main drainage curve.
 
void setMdc (ScanningCurve *val)
 Set the main drainage curve.
 
ScanningCurvepisc () const
 Returns the primary imbibition scanning curve.
 
void setPisc (ScanningCurve *val)
 Set the primary imbibition scanning curve.
 
ScanningCurvecsc () const
 Returns the current scanning curve.
 
void setCsc (ScanningCurve *val)
 Set the current scanning curve.
 
- Public Member Functions inherited from Opm::EnsureFinalized
void finalize ()
 Mark the object as finalized.
 

Additional Inherited Members

- Protected Member Functions inherited from Opm::EnsureFinalized
 EnsureFinalized ()
 The default constructor.
 
void check () const
 

Detailed Description

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

Default parameter class for the Parker-Lenhard hysteresis model.


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