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

Specification of the material params for the three-phase van Genuchten capillary pressure model. More...

#include <ThreePhaseParkerVanGenuchtenParams.hpp>

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

Public Types

typedef TraitsT Traits
 
typedef Traits::Scalar Scalar
 

Public Member Functions

 ThreePhaseParkerVanGenuchtenParams ()
 
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...
 
Scalar Swr () const
 Return the residual wetting saturation. More...
 
void setSwr (Scalar input)
 Set the residual wetting saturation. More...
 
Scalar Snr () const
 Return the residual non-wetting saturation. More...
 
void setSnr (Scalar input)
 Set the residual non-wetting saturation. More...
 
Scalar Sgr () const
 Return the residual gas saturation. More...
 
void setSgr (Scalar input)
 Set the residual gas saturation. More...
 
Scalar Swrx () const
 
void setSwrx (Scalar input)
 Set the residual gas saturation. More...
 
void setBetaNW (Scalar input)
 defines the scaling parameters of capillary pressure between the phases (=1 for Gas-Water) More...
 
void setBetaGN (Scalar input)
 
Scalar betaNW () const
 Return the values for the beta scaling parameters of capillary pressure between the phases. More...
 
Scalar betaGN () const
 
void setkrRegardsSnr (bool input)
 defines if residual n-phase saturation should be regarded in its relative permeability. More...
 
bool krRegardsSnr () const
 Calls if residual n-phase saturation should be regarded in its relative permeability. More...
 
void checkDefined () const
 
void finalize ()
 Mark the object as finalized. More...
 

Protected Member Functions

void check () const
 

Detailed Description

template<class TraitsT>
class Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >

Specification of the material params for the three-phase van Genuchten capillary pressure model.

In comparison to the two-phase version, this parameter object also includes the residual saturations, as their handling is very model-specific.

Member Typedef Documentation

◆ Scalar

template<class TraitsT >
typedef Traits::Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Scalar

◆ Traits

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

Constructor & Destructor Documentation

◆ ThreePhaseParkerVanGenuchtenParams()

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

Member Function Documentation

◆ betaGN()

template<class TraitsT >
Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::betaGN ( ) const
inline

References Opm::EnsureFinalized::check().

◆ betaNW()

template<class TraitsT >
Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::betaNW ( ) const
inline

Return the values for the beta scaling parameters of capillary pressure between the phases.

References Opm::EnsureFinalized::check().

◆ 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().

◆ checkDefined()

template<class TraitsT >
void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::checkDefined ( ) const
inline

References Opm::Valgrind::CheckDefined().

◆ finalize()

void Opm::EnsureFinalized::finalize ( )
inlineinherited

Mark the object as finalized.

Referenced by Opm::BrooksCoreyParams< TraitsT >::BrooksCoreyParams(), Opm::EclEpsTwoPhaseLawParams< EffLawT >::finalize(), Opm::EclHysteresisTwoPhaseLawParams< EffLawT >::finalize(), Opm::EclStone1MaterialParams< Traits, GasOilLawT, OilWaterLawT >::finalize(), Opm::PiecewiseLinearTwoPhaseMaterialParams< TraitsT >::finalize(), Opm::RegularizedBrooksCoreyParams< TraitsT >::finalize(), Opm::RegularizedVanGenuchtenParams< TraitsT >::finalize(), Opm::TwoPhaseLETCurvesParams< TraitsT >::finalize(), and Opm::VanGenuchtenParams< TraitsT >::VanGenuchtenParams().

◆ krRegardsSnr()

template<class TraitsT >
bool Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::krRegardsSnr ( ) const
inline

Calls if residual n-phase saturation should be regarded in its relative permeability.

References Opm::EnsureFinalized::check().

◆ setBetaGN()

template<class TraitsT >
void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setBetaGN ( Scalar  input)
inline

◆ setBetaNW()

template<class TraitsT >
void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setBetaNW ( Scalar  input)
inline

defines the scaling parameters of capillary pressure between the phases (=1 for Gas-Water)

◆ setkrRegardsSnr()

template<class TraitsT >
void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setkrRegardsSnr ( bool  input)
inline

defines if residual n-phase saturation should be regarded in its relative permeability.

◆ setSgr()

template<class TraitsT >
void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setSgr ( Scalar  input)
inline

Set the residual gas saturation.

◆ setSnr()

template<class TraitsT >
void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setSnr ( Scalar  input)
inline

Set the residual non-wetting saturation.

◆ setSwr()

template<class TraitsT >
void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setSwr ( Scalar  input)
inline

Set the residual wetting saturation.

◆ setSwrx()

template<class TraitsT >
void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setSwrx ( Scalar  input)
inline

Set the residual gas saturation.

◆ setVgAlpha()

template<class TraitsT >
void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setVgAlpha ( Scalar  v)
inline

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

◆ setVgM()

template<class TraitsT >
void Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setVgM ( Scalar  m)
inline

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::ThreePhaseParkerVanGenuchtenParams< TraitsT >::setVgN ( Scalar  n)
inline

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

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

◆ Sgr()

template<class TraitsT >
Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Sgr ( ) const
inline

Return the residual gas saturation.

References Opm::EnsureFinalized::check().

◆ Snr()

template<class TraitsT >
Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Snr ( ) const
inline

Return the residual non-wetting saturation.

References Opm::EnsureFinalized::check().

◆ Swr()

template<class TraitsT >
Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Swr ( ) const
inline

Return the residual wetting saturation.

References Opm::EnsureFinalized::check().

◆ Swrx()

template<class TraitsT >
Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::Swrx ( ) const
inline

References Opm::EnsureFinalized::check().

◆ vgAlpha()

template<class TraitsT >
Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::vgAlpha ( ) const
inline

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

References Opm::EnsureFinalized::check().

◆ vgM()

template<class TraitsT >
Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::vgM ( ) const
inline

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

References Opm::EnsureFinalized::check().

◆ vgN()

template<class TraitsT >
Scalar Opm::ThreePhaseParkerVanGenuchtenParams< TraitsT >::vgN ( ) const
inline

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: