Opm::RegularizedBrooksCoreyParams< TraitsT > Class Template Reference

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

#include <RegularizedBrooksCoreyParams.hpp>

Inheritance diagram for Opm::RegularizedBrooksCoreyParams< TraitsT >:
Inheritance graph

Public Types

typedef TraitsT Traits
 

Public Member Functions

 RegularizedBrooksCoreyParams ()
 
 RegularizedBrooksCoreyParams (Scalar entryPressure, Scalar lambda)
 
void finalize ()
 Calculate all dependent quantities once the independent quantities of the parameter object have been set. More...
 
Scalar pcnwLowSw () const
 Return the threshold saturation below which the capillary pressure is regularized. More...
 
Scalar pcnwLow () const
 Return the capillary pressure at the low threshold saturation of the wetting phase. More...
 
Scalar pcnwSlopeLow () const
 Return the slope capillary pressure curve if Sw is smaller or equal to the low threshold saturation. More...
 
void setPcLowSw (Scalar value)
 Set the threshold saturation below which the capillary pressure is regularized. More...
 
void setThresholdSw (Scalar value) DUNE_DEPRECATED_MSG("this method has been renamed to setPcLowSw()")
 
Scalar pcnwHigh () const
 Return the capillary pressure at the high threshold saturation of the wetting phase. More...
 
Scalar pcnwSlopeHigh () const
 Return the slope capillary pressure curve if Sw is larger or equal to 1. More...
 
Scalar entryPressure () const
 Returns the entry pressure [Pa]. More...
 
void setEntryPressure (Scalar v)
 Set the entry pressure [Pa]. More...
 
Scalar lambda () const
 Returns the lambda shape parameter. More...
 
void setLambda (Scalar v)
 Set the lambda shape parameter. More...
 

Detailed Description

template<class TraitsT>
class Opm::RegularizedBrooksCoreyParams< TraitsT >

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

Member Typedef Documentation

template<class TraitsT >
typedef TraitsT Opm::RegularizedBrooksCoreyParams< TraitsT >::Traits

Constructor & Destructor Documentation

template<class TraitsT >
Opm::RegularizedBrooksCoreyParams< TraitsT >::RegularizedBrooksCoreyParams ( )
inline
template<class TraitsT >
Opm::RegularizedBrooksCoreyParams< TraitsT >::RegularizedBrooksCoreyParams ( Scalar  entryPressure,
Scalar  lambda 
)
inline

Member Function Documentation

template<class TraitsT >
Scalar Opm::BrooksCoreyParams< TraitsT >::entryPressure ( ) const
inlineinherited

Returns the entry pressure [Pa].

template<class TraitsT >
void Opm::RegularizedBrooksCoreyParams< TraitsT >::finalize ( )
inline

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

References Opm::BrooksCoreyParams< TraitsT >::finalize().

Referenced by Opm::RegularizedBrooksCoreyParams< TraitsT >::RegularizedBrooksCoreyParams().

template<class TraitsT >
Scalar Opm::BrooksCoreyParams< TraitsT >::lambda ( ) const
inlineinherited

Returns the lambda shape parameter.

template<class TraitsT >
Scalar Opm::RegularizedBrooksCoreyParams< TraitsT >::pcnwHigh ( ) const
inline

Return the capillary pressure at the high threshold saturation of the wetting phase.

template<class TraitsT >
Scalar Opm::RegularizedBrooksCoreyParams< TraitsT >::pcnwLow ( ) const
inline

Return the capillary pressure at the low threshold saturation of the wetting phase.

template<class TraitsT >
Scalar Opm::RegularizedBrooksCoreyParams< TraitsT >::pcnwLowSw ( ) const
inline

Return the threshold saturation below which the capillary pressure is regularized.

template<class TraitsT >
Scalar Opm::RegularizedBrooksCoreyParams< TraitsT >::pcnwSlopeHigh ( ) const
inline

Return the slope capillary pressure curve if Sw is larger or equal to 1.

For this case, we extrapolate the curve using a straight line.

template<class TraitsT >
Scalar Opm::RegularizedBrooksCoreyParams< TraitsT >::pcnwSlopeLow ( ) const
inline

Return the slope capillary pressure curve if Sw is smaller or equal to the low threshold saturation.

For this case, we extrapolate the curve using a straight line.

template<class TraitsT >
void Opm::BrooksCoreyParams< TraitsT >::setEntryPressure ( Scalar  v)
inlineinherited

Set the entry pressure [Pa].

template<class TraitsT >
void Opm::BrooksCoreyParams< TraitsT >::setLambda ( Scalar  v)
inlineinherited

Set the lambda shape parameter.

template<class TraitsT >
void Opm::RegularizedBrooksCoreyParams< TraitsT >::setPcLowSw ( Scalar  value)
inline

Set the threshold saturation below which the capillary pressure is regularized.

template<class TraitsT >
void Opm::RegularizedBrooksCoreyParams< TraitsT >::setThresholdSw ( Scalar  value)
inline

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