Opm::LinearMaterialParams< TraitsT > Class Template Reference

Reference implementation of params for the linear M-phase material material. More...

#include <LinearMaterialParams.hpp>

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

Public Types

typedef TraitsT Traits
 

Public Member Functions

 LinearMaterialParams ()
 The default constructor. More...
 
Scalar pcMinSat (unsigned phaseIdx) const
 Return the relative phase pressure at the minimum saturation of a phase. More...
 
void setPcMinSat (unsigned phaseIdx, Scalar val)
 Set the relative phase pressure at the minimum saturation of a phase. More...
 
Scalar pcMaxSat (unsigned phaseIdx) const
 Return the relative phase pressure at the maximum saturation of a phase. More...
 
void setPcMaxSat (unsigned phaseIdx, Scalar val)
 Set the relative phase pressure at the maximum saturation of a phase. More...
 
void finalize ()
 Mark the object as finalized. More...
 

Protected Member Functions

void check () const
 

Detailed Description

template<class TraitsT>
class Opm::LinearMaterialParams< TraitsT >

Reference implementation of params for the linear M-phase material material.

Member Typedef Documentation

◆ Traits

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

Constructor & Destructor Documentation

◆ LinearMaterialParams()

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

The default constructor.

We set the capillary pressure to zero, if not specified otherwise.

References Opm::LinearMaterialParams< TraitsT >::setPcMaxSat(), and Opm::LinearMaterialParams< TraitsT >::setPcMinSat().

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

◆ pcMaxSat()

template<class TraitsT >
Scalar Opm::LinearMaterialParams< TraitsT >::pcMaxSat ( unsigned  phaseIdx) const
inline

Return the relative phase pressure at the maximum saturation of a phase.

This means $p_{c\alpha}$ at $S_\alpha=1$.

References Opm::EnsureFinalized::check().

◆ pcMinSat()

template<class TraitsT >
Scalar Opm::LinearMaterialParams< TraitsT >::pcMinSat ( unsigned  phaseIdx) const
inline

Return the relative phase pressure at the minimum saturation of a phase.

This means $p_{c\alpha}$ at $S_\alpha=0$.

References Opm::EnsureFinalized::check().

◆ setPcMaxSat()

template<class TraitsT >
void Opm::LinearMaterialParams< TraitsT >::setPcMaxSat ( unsigned  phaseIdx,
Scalar  val 
)
inline

Set the relative phase pressure at the maximum saturation of a phase.

This means $p_{c\alpha}$ at $S_\alpha=1$.

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

◆ setPcMinSat()

template<class TraitsT >
void Opm::LinearMaterialParams< TraitsT >::setPcMinSat ( unsigned  phaseIdx,
Scalar  val 
)
inline

Set the relative phase pressure at the minimum saturation of a phase.

This means $p_{c\alpha}$ at $S_\alpha=0$.

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


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