Public Types | Public Member Functions | Protected Member Functions | List of all members
Opm::RegularizedVanGenuchtenParams< TraitsT > Class Template Reference

Parameters that are necessary for the regularization of VanGenuchten "material law". More...

#include <RegularizedVanGenuchtenParams.hpp>

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

Public Types

typedef TraitsT Traits
 

Public Member Functions

 RegularizedVanGenuchtenParams ()
 
 RegularizedVanGenuchtenParams (Scalar vgAlpha, Scalar vgN)
 
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...
 
Scalar pcnwHighSw () const
 Return the threshold saturation below which the capillary pressure is regularized. More...
 
Scalar pcnwHigh () const
 Return the capillary pressure at the high threshold saturation of the wetting phase. More...
 
const Spline< Scalar > & pcnwHighSpline () const
 Return the spline curve which ought to be used between the upper threshold saturation and 1. More...
 
Scalar pcnwSlopeHigh () const
 Return the slope capillary pressure curve if Sw is larger or equal to 1. More...
 
void setPCHighSw (Scalar value)
 Set the threshold saturation below which the capillary pressure is regularized. More...
 
Scalar vgAlpha () const
 Return the $\alpha$ shape parameter of van Genuchten's curve. More...
 
void setVgAlpha (Scalar v)
 Set the $\alpha$ shape parameter of van Genuchten's curve. More...
 
Scalar vgM () const
 Return the $m$ shape parameter of van Genuchten's curve. More...
 
void setVgM (Scalar m)
 Set the $m$ shape parameter of van Genuchten's curve. More...
 
Scalar vgN () const
 Return the $n$ shape parameter of van Genuchten's curve. More...
 
void setVgN (Scalar n)
 Set the $n$ shape parameter of van Genuchten's curve. More...
 

Protected Member Functions

void check () const
 

Detailed Description

template<class TraitsT>
class Opm::RegularizedVanGenuchtenParams< TraitsT >

Parameters that are necessary for the regularization of VanGenuchten "material law".

Member Typedef Documentation

◆ Traits

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

Constructor & Destructor Documentation

◆ RegularizedVanGenuchtenParams() [1/2]

template<class TraitsT >
Opm::RegularizedVanGenuchtenParams< TraitsT >::RegularizedVanGenuchtenParams ( )
inline

◆ RegularizedVanGenuchtenParams() [2/2]

template<class TraitsT >
Opm::RegularizedVanGenuchtenParams< TraitsT >::RegularizedVanGenuchtenParams ( Scalar  vgAlpha,
Scalar  vgN 
)
inline

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

Member Function Documentation

◆ check()

void Opm::EnsureFinalized::check ( ) const
inlineprotectedinherited

Referenced by Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::betaGN(), Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::betaNW(), Opm::ParkerLenhardParams< TraitsT >::csc(), Opm::ParkerLenhardParams< TraitsT >::currentSnr(), Opm::EclHeatcrLawParams< ScalarT >::dRockHeatCapacity_dT(), Opm::TwoPhaseLETCurvesParams< TraitsT >::dS(), Opm::TwoPhaseLETCurvesParams< TraitsT >::dSpc(), Opm::EclThconrLawParams< ScalarT >::dTotalThermalConductivity_dSg(), Opm::TwoPhaseLETCurvesParams< TraitsT >::E(), Opm::BrooksCoreyParams< TraitsT >::entryPressure(), Opm::TwoPhaseLETCurvesParams< TraitsT >::Epc(), Opm::EclStone1MaterialParams< Traits, GasOilLawT, OilWaterLawT >::eta(), Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::gasOilParams(), Opm::EclStone1MaterialParams< Traits, GasOilLawT, OilWaterLawT >::gasOilParams(), Opm::EclStone2MaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::gasOilParams(), Opm::EclTwoPhaseMaterialParams< Traits, GasOilParamsT, OilWaterParamsT, GasWaterParamsT >::gasOilParams(), Opm::EclTwoPhaseMaterialParams< Traits, GasOilParamsT, OilWaterParamsT, GasWaterParamsT >::gasWaterParams(), Opm::EclSpecrockLawParams< ScalarT >::internalEnergyFunction(), Opm::PiecewiseLinearTwoPhaseMaterialParams< TraitsT >::krnSamples(), Opm::SplineTwoPhaseMaterialParams< TraitsT >::krnSpline(), Opm::EclStone1MaterialParams< Traits, GasOilLawT, OilWaterLawT >::krocw(), Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::krRegardsSnr(), Opm::TwoPhaseLETCurvesParams< TraitsT >::Krt(), Opm::PiecewiseLinearTwoPhaseMaterialParams< TraitsT >::krwSamples(), Opm::SplineTwoPhaseMaterialParams< TraitsT >::krwSpline(), Opm::TwoPhaseLETCurvesParams< TraitsT >::L(), Opm::BrooksCoreyParams< TraitsT >::lambda(), Opm::TwoPhaseLETCurvesParams< TraitsT >::Lpc(), Opm::ParkerLenhardParams< TraitsT >::mdc(), Opm::ParkerLenhardParams< TraitsT >::mdcParams(), Opm::ParkerLenhardParams< TraitsT >::micParams(), Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::oilWaterParams(), Opm::EclStone1MaterialParams< Traits, GasOilLawT, OilWaterLawT >::oilWaterParams(), Opm::EclStone2MaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::oilWaterParams(), Opm::EclTwoPhaseMaterialParams< Traits, GasOilParamsT, OilWaterParamsT, GasWaterParamsT >::oilWaterParams(), Opm::TwoPhaseLETCurvesParams< TraitsT >::Pcir(), Opm::LinearMaterialParams< TraitsT >::pcMaxSat(), Opm::LinearMaterialParams< TraitsT >::pcMinSat(), Opm::RegularizedBrooksCoreyParams< TraitsT >::pcnwHigh(), Opm::RegularizedVanGenuchtenParams< TraitsT >::pcnwHigh(), Opm::RegularizedVanGenuchtenParams< TraitsT >::pcnwHighSpline(), Opm::RegularizedVanGenuchtenParams< TraitsT >::pcnwHighSw(), Opm::RegularizedBrooksCoreyParams< TraitsT >::pcnwLow(), Opm::RegularizedVanGenuchtenParams< TraitsT >::pcnwLow(), Opm::RegularizedBrooksCoreyParams< TraitsT >::pcnwLowSw(), Opm::RegularizedVanGenuchtenParams< TraitsT >::pcnwLowSw(), Opm::PiecewiseLinearTwoPhaseMaterialParams< TraitsT >::pcnwSamples(), Opm::RegularizedBrooksCoreyParams< TraitsT >::pcnwSlopeHigh(), Opm::RegularizedVanGenuchtenParams< TraitsT >::pcnwSlopeHigh(), Opm::RegularizedBrooksCoreyParams< TraitsT >::pcnwSlopeLow(), Opm::RegularizedVanGenuchtenParams< TraitsT >::pcnwSlopeLow(), Opm::SplineTwoPhaseMaterialParams< TraitsT >::pcnwSpline(), Opm::TwoPhaseLETCurvesParams< TraitsT >::Pct(), Opm::ParkerLenhardParams< TraitsT >::pisc(), Opm::EclThcLawParams< ScalarT >::porosity(), Opm::EclHeatcrLawParams< ScalarT >::referenceRockHeatCapacity(), Opm::EclThconrLawParams< ScalarT >::referenceTotalThermalConductivity(), Opm::EffToAbsLawParams< EffLawParamsT, numPhases >::residualSaturation(), Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Sgr(), Opm::TwoPhaseLETCurvesParams< TraitsT >::Smin(), Opm::TwoPhaseLETCurvesParams< TraitsT >::Sminpc(), Opm::ParkerLenhardParams< TraitsT >::Snr(), Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Snr(), Opm::ConstantSolidHeatCapLawParams< ScalarT >::solidHeatCapacity(), Opm::EffToAbsLawParams< EffLawParamsT, numPhases >::sumResidualSaturations(), Opm::PiecewiseLinearTwoPhaseMaterialParams< TraitsT >::SwKrnSamples(), Opm::PiecewiseLinearTwoPhaseMaterialParams< TraitsT >::SwKrwSamples(), Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::Swl(), Opm::EclStone1MaterialParams< Traits, GasOilLawT, OilWaterLawT >::Swl(), Opm::EclStone2MaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::Swl(), Opm::PiecewiseLinearTwoPhaseMaterialParams< TraitsT >::SwPcwnSamples(), Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Swr(), Opm::ParkerLenhardParams< TraitsT >::SwrKr(), Opm::ParkerLenhardParams< TraitsT >::SwrPc(), Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Swrx(), Opm::TwoPhaseLETCurvesParams< TraitsT >::T(), Opm::EclThcLawParams< ScalarT >::thcgas(), Opm::EclThcLawParams< ScalarT >::thcoil(), Opm::EclThcLawParams< ScalarT >::thcrock(), Opm::EclThcLawParams< ScalarT >::thcwater(), Opm::TwoPhaseLETCurvesParams< TraitsT >::Tpc(), Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::vgAlpha(), Opm::VanGenuchtenParams< TraitsT >::vgAlpha(), Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::vgM(), Opm::VanGenuchtenParams< TraitsT >::vgM(), Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::vgN(), and Opm::VanGenuchtenParams< TraitsT >::vgN().

◆ finalize()

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

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

References Opm::EnsureFinalized::finalize(), and Opm::VanGenuchten< TraitsT, ParamsT >::twoPhaseSatPcnw().

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

◆ pcnwHigh()

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

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

References Opm::EnsureFinalized::check().

◆ pcnwHighSpline()

template<class TraitsT >
const Spline< Scalar > & Opm::RegularizedVanGenuchtenParams< TraitsT >::pcnwHighSpline ( ) const
inline

Return the spline curve which ought to be used between the upper threshold saturation and 1.

References Opm::EnsureFinalized::check().

◆ pcnwHighSw()

template<class TraitsT >
Scalar Opm::RegularizedVanGenuchtenParams< TraitsT >::pcnwHighSw ( ) const
inline

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

References Opm::EnsureFinalized::check().

◆ pcnwLow()

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

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

References Opm::EnsureFinalized::check().

◆ pcnwLowSw()

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

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

References Opm::EnsureFinalized::check().

◆ pcnwSlopeHigh()

template<class TraitsT >
Scalar Opm::RegularizedVanGenuchtenParams< 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.

References Opm::EnsureFinalized::check().

◆ pcnwSlopeLow()

template<class TraitsT >
Scalar Opm::RegularizedVanGenuchtenParams< 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.

References Opm::EnsureFinalized::check().

◆ setPCHighSw()

template<class TraitsT >
void Opm::RegularizedVanGenuchtenParams< TraitsT >::setPCHighSw ( Scalar  value)
inline

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

◆ setPCLowSw()

template<class TraitsT >
void Opm::RegularizedVanGenuchtenParams< TraitsT >::setPCLowSw ( Scalar  value)
inline

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

◆ setVgAlpha()

template<class TraitsT >
void Opm::VanGenuchtenParams< TraitsT >::setVgAlpha ( Scalar  v)
inlineinherited

Set the $\alpha$ shape parameter of van Genuchten's curve.

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

◆ setVgM()

template<class TraitsT >
void Opm::VanGenuchtenParams< TraitsT >::setVgM ( Scalar  m)
inlineinherited

Set the $m$ shape parameter of van Genuchten's curve.

The $n$ shape parameter is set to $n = \frac{1}{1 - m}$

◆ setVgN()

template<class TraitsT >
void Opm::VanGenuchtenParams< TraitsT >::setVgN ( Scalar  n)
inlineinherited

Set the $n$ shape parameter of van Genuchten's curve.

The $n$ shape parameter is set to $m = 1 - \frac{1}{n}$

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

◆ vgAlpha()

template<class TraitsT >
Scalar Opm::VanGenuchtenParams< TraitsT >::vgAlpha ( ) const
inlineinherited

Return the $\alpha$ shape parameter of van Genuchten's curve.

References Opm::EnsureFinalized::check().

◆ vgM()

template<class TraitsT >
Scalar Opm::VanGenuchtenParams< TraitsT >::vgM ( ) const
inlineinherited

Return the $m$ shape parameter of van Genuchten's curve.

References Opm::EnsureFinalized::check().

◆ vgN()

template<class TraitsT >
Scalar Opm::VanGenuchtenParams< TraitsT >::vgN ( ) const
inlineinherited

Return the $n$ shape parameter of van Genuchten's curve.

References Opm::EnsureFinalized::check().

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