Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT > Class Template Reference

Default implementation for the parameters required by the default three-phase capillary pressure model used by Eclipse. More...

#include <EclDefaultMaterialParams.hpp>

Inheritance diagram for Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >:
Inheritance graph

Public Types

using GasOilParams = GasOilParamsT
 
using OilWaterParams = OilWaterParamsT
 

Public Member Functions

 EclDefaultMaterialParams ()
 The default constructor. More...
 
const GasOilParamsgasOilParams () const
 The parameter object for the gas-oil twophase law. More...
 
GasOilParamsgasOilParams ()
 The parameter object for the gas-oil twophase law. More...
 
void setGasOilParams (std::shared_ptr< GasOilParams > val)
 Set the parameter object for the gas-oil twophase law. More...
 
const OilWaterParamsoilWaterParams () const
 The parameter object for the oil-water twophase law. More...
 
OilWaterParamsoilWaterParams ()
 The parameter object for the oil-water twophase law. More...
 
void setOilWaterParams (std::shared_ptr< OilWaterParams > val)
 Set the parameter object for the oil-water twophase law. More...
 
void setSwl (Scalar val)
 Set the saturation of "connate" water. More...
 
Scalar Swl () const
 Return the saturation of "connate" water. More...
 
bool inconsistentHysteresisUpdate () const
 Specify whether inconsistent saturations should be used to update the hysteresis parameters. More...
 
void finalize ()
 Mark the object as finalized. More...
 

Protected Member Functions

void check () const
 

Detailed Description

template<class Traits, class GasOilParamsT, class OilWaterParamsT>
class Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >

Default implementation for the parameters required by the default three-phase capillary pressure model used by Eclipse.

Essentially, this class just stores the two parameter objects for the twophase capillary pressure laws.

Member Typedef Documentation

◆ GasOilParams

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
using Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::GasOilParams = GasOilParamsT

◆ OilWaterParams

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
using Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::OilWaterParams = OilWaterParamsT

Constructor & Destructor Documentation

◆ EclDefaultMaterialParams()

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::EclDefaultMaterialParams ( )
inline

The default constructor.

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

◆ gasOilParams() [1/2]

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
GasOilParams & Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::gasOilParams ( )
inline

The parameter object for the gas-oil twophase law.

References Opm::EnsureFinalized::check().

◆ gasOilParams() [2/2]

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
const GasOilParams & Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::gasOilParams ( ) const
inline

The parameter object for the gas-oil twophase law.

References Opm::EnsureFinalized::check().

◆ inconsistentHysteresisUpdate()

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
bool Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::inconsistentHysteresisUpdate ( ) const
inline

Specify whether inconsistent saturations should be used to update the hysteresis parameters.

Returning 'true' is wrong from a physical point of view because the saturations which are used to update the hysteresis parameters are calculated differently than the ones used to calculate the relperms and capillary pressures. Since Eclipse E100 probably uses inconsistent saturations, we return true here anyway.

◆ oilWaterParams() [1/2]

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
OilWaterParams & Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::oilWaterParams ( )
inline

The parameter object for the oil-water twophase law.

References Opm::EnsureFinalized::check().

◆ oilWaterParams() [2/2]

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
const OilWaterParams & Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::oilWaterParams ( ) const
inline

The parameter object for the oil-water twophase law.

References Opm::EnsureFinalized::check().

◆ setGasOilParams()

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
void Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::setGasOilParams ( std::shared_ptr< GasOilParams val)
inline

Set the parameter object for the gas-oil twophase law.

◆ setOilWaterParams()

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
void Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::setOilWaterParams ( std::shared_ptr< OilWaterParams val)
inline

Set the parameter object for the oil-water twophase law.

◆ setSwl()

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
void Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::setSwl ( Scalar  val)
inline

Set the saturation of "connate" water.

According to

http://www.glossary.oilfield.slb.com/en/Terms/c/connate_water.aspx

the connate water is the water which is trapped in the pores of the rock during the rock's formation. For our application, this is basically a reduction of the rock's porosity...

◆ Swl()

template<class Traits , class GasOilParamsT , class OilWaterParamsT >
Scalar Opm::EclDefaultMaterialParams< Traits, GasOilParamsT, OilWaterParamsT >::Swl ( ) const
inline

Return the saturation of "connate" water.

References Opm::EnsureFinalized::check().


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