Opm::BlackOilSolventModule< TypeTag, enableSolventV > Class Template Reference

Contains the high level supplements required to extend the black oil model by solvents. More...

#include <blackoilsolventmodules.hh>

Static Public Member Functions

static void setSolventPvt (const SolventPvt &value)
 Specify the solvent PVT of a all PVT regions. More...
 
static void setIsMiscible (const bool isMiscible)
 
static void registerParameters ()
 Register all run-time parameters for the black-oil solvent module. More...
 
static void registerOutputModules (Model &model, Simulator &simulator)
 Register all solvent specific VTK and ECL output modules. More...
 
static bool primaryVarApplies (unsigned pvIdx)
 
static std::string primaryVarName (unsigned pvIdx)
 
static Scalar primaryVarWeight (unsigned pvIdx)
 
static bool eqApplies (unsigned eqIdx)
 
static std::string eqName (unsigned eqIdx)
 
static Scalar eqWeight (unsigned eqIdx)
 
template<class LhsEval >
static void addStorage (Dune::FieldVector< LhsEval, numEq > &storage, const IntensiveQuantities &intQuants)
 
static void computeFlux (RateVector &flux, const ElementContext &elemCtx, unsigned scvfIdx, unsigned timeIdx)
 
static void assignPrimaryVars (PrimaryVariables &priVars, Scalar solventSaturation, Scalar solventRsw)
 Assign the solvent specific primary variables to a PrimaryVariables object. More...
 
static void updatePrimaryVars (PrimaryVariables &newPv, const PrimaryVariables &oldPv, const EqVector &delta)
 Do a Newton-Raphson update the primary variables of the solvents. More...
 
static Scalar computeUpdateError (const PrimaryVariables &, const EqVector &)
 Return how much a Newton-Raphson update is considered an error. More...
 
static Scalar computeResidualError (const EqVector &resid)
 Return how much a residual is considered an error. More...
 
template<class DofEntity >
static void serializeEntity (const Model &model, std::ostream &outstream, const DofEntity &dof)
 
template<class DofEntity >
static void deserializeEntity (Model &model, std::istream &instream, const DofEntity &dof)
 
static const SolventPvt & solventPvt ()
 
static const Co2GasPvt & co2GasPvt ()
 
static const H2GasPvt & h2GasPvt ()
 
static const BrineCo2Pvt & brineCo2Pvt ()
 
static const BrineH2Pvt & brineH2Pvt ()
 
static const TabulatedFunction & ssfnKrg (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & ssfnKrs (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & sof2Krn (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & misc (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & pmisc (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & msfnKrsg (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & msfnKro (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & sorwmis (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & sgcwmis (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & tlPMixTable (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const Scalar & tlMixParamViscosity (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const Scalar & tlMixParamDensity (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static bool isMiscible ()
 
template<class Value >
static const Value solubilityLimit (unsigned pvtIdx, const Value &temperature, const Value &pressure, const Value &saltConcentration)
 
static bool isSolubleInWater ()
 
static bool isCO2Sol ()
 
static bool isH2Sol ()
 

Detailed Description

template<class TypeTag, bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
class Opm::BlackOilSolventModule< TypeTag, enableSolventV >

Contains the high level supplements required to extend the black oil model by solvents.

Member Function Documentation

◆ addStorage()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
template<class LhsEval >
static void Opm::BlackOilSolventModule< TypeTag, enableSolventV >::addStorage ( Dune::FieldVector< LhsEval, numEq > &  storage,
const IntensiveQuantities &  intQuants 
)
inlinestatic

◆ assignPrimaryVars()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static void Opm::BlackOilSolventModule< TypeTag, enableSolventV >::assignPrimaryVars ( PrimaryVariables &  priVars,
Scalar  solventSaturation,
Scalar  solventRsw 
)
inlinestatic

Assign the solvent specific primary variables to a PrimaryVariables object.

References Opm::BlackOilSolventModule< TypeTag, enableSolventV >::isSolubleInWater().

◆ brineCo2Pvt()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const BrineCo2Pvt & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::brineCo2Pvt ( )
inlinestatic

◆ brineH2Pvt()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const BrineH2Pvt & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::brineH2Pvt ( )
inlinestatic

◆ co2GasPvt()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const Co2GasPvt & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::co2GasPvt ( )
inlinestatic

◆ computeFlux()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static void Opm::BlackOilSolventModule< TypeTag, enableSolventV >::computeFlux ( RateVector &  flux,
const ElementContext &  elemCtx,
unsigned  scvfIdx,
unsigned  timeIdx 
)
inlinestatic

◆ computeResidualError()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static Scalar Opm::BlackOilSolventModule< TypeTag, enableSolventV >::computeResidualError ( const EqVector &  resid)
inlinestatic

Return how much a residual is considered an error.

◆ computeUpdateError()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static Scalar Opm::BlackOilSolventModule< TypeTag, enableSolventV >::computeUpdateError ( const PrimaryVariables &  ,
const EqVector &   
)
inlinestatic

Return how much a Newton-Raphson update is considered an error.

◆ deserializeEntity()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
template<class DofEntity >
static void Opm::BlackOilSolventModule< TypeTag, enableSolventV >::deserializeEntity ( Model &  model,
std::istream &  instream,
const DofEntity &  dof 
)
inlinestatic

◆ eqApplies()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static bool Opm::BlackOilSolventModule< TypeTag, enableSolventV >::eqApplies ( unsigned  eqIdx)
inlinestatic

◆ eqName()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static std::string Opm::BlackOilSolventModule< TypeTag, enableSolventV >::eqName ( unsigned  eqIdx)
inlinestatic

◆ eqWeight()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static Scalar Opm::BlackOilSolventModule< TypeTag, enableSolventV >::eqWeight ( unsigned  eqIdx)
inlinestatic

◆ h2GasPvt()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const H2GasPvt & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::h2GasPvt ( )
inlinestatic

◆ isCO2Sol()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static bool Opm::BlackOilSolventModule< TypeTag, enableSolventV >::isCO2Sol ( )
inlinestatic

◆ isH2Sol()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static bool Opm::BlackOilSolventModule< TypeTag, enableSolventV >::isH2Sol ( )
inlinestatic

◆ isMiscible()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static bool Opm::BlackOilSolventModule< TypeTag, enableSolventV >::isMiscible ( )
inlinestatic

◆ isSolubleInWater()

◆ misc()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const TabulatedFunction & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::misc ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ msfnKro()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const TabulatedFunction & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::msfnKro ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ msfnKrsg()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const TabulatedFunction & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::msfnKrsg ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ pmisc()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const TabulatedFunction & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::pmisc ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ primaryVarApplies()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static bool Opm::BlackOilSolventModule< TypeTag, enableSolventV >::primaryVarApplies ( unsigned  pvIdx)
inlinestatic

◆ primaryVarName()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static std::string Opm::BlackOilSolventModule< TypeTag, enableSolventV >::primaryVarName ( unsigned  pvIdx)
inlinestatic

◆ primaryVarWeight()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static Scalar Opm::BlackOilSolventModule< TypeTag, enableSolventV >::primaryVarWeight ( unsigned  pvIdx)
inlinestatic

◆ registerOutputModules()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static void Opm::BlackOilSolventModule< TypeTag, enableSolventV >::registerOutputModules ( Model &  model,
Simulator &  simulator 
)
inlinestatic

Register all solvent specific VTK and ECL output modules.

Referenced by Opm::BlackOilModel< TypeTag >::registerOutputModules_().

◆ registerParameters()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static void Opm::BlackOilSolventModule< TypeTag, enableSolventV >::registerParameters ( )
inlinestatic

Register all run-time parameters for the black-oil solvent module.

Referenced by Opm::BlackOilModel< TypeTag >::registerParameters().

◆ serializeEntity()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
template<class DofEntity >
static void Opm::BlackOilSolventModule< TypeTag, enableSolventV >::serializeEntity ( const Model &  model,
std::ostream &  outstream,
const DofEntity &  dof 
)
inlinestatic

◆ setIsMiscible()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static void Opm::BlackOilSolventModule< TypeTag, enableSolventV >::setIsMiscible ( const bool  isMiscible)
inlinestatic

◆ setSolventPvt()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static void Opm::BlackOilSolventModule< TypeTag, enableSolventV >::setSolventPvt ( const SolventPvt &  value)
inlinestatic

Specify the solvent PVT of a all PVT regions.

◆ sgcwmis()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const TabulatedFunction & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::sgcwmis ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ sof2Krn()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const TabulatedFunction & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::sof2Krn ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ solubilityLimit()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
template<class Value >
static const Value Opm::BlackOilSolventModule< TypeTag, enableSolventV >::solubilityLimit ( unsigned  pvtIdx,
const Value &  temperature,
const Value &  pressure,
const Value &  saltConcentration 
)
inlinestatic

◆ solventPvt()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const SolventPvt & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::solventPvt ( )
inlinestatic

◆ sorwmis()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const TabulatedFunction & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::sorwmis ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ ssfnKrg()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const TabulatedFunction & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::ssfnKrg ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ ssfnKrs()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const TabulatedFunction & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::ssfnKrs ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ tlMixParamDensity()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const Scalar & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::tlMixParamDensity ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ tlMixParamViscosity()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const Scalar & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::tlMixParamViscosity ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ tlPMixTable()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static const TabulatedFunction & Opm::BlackOilSolventModule< TypeTag, enableSolventV >::tlPMixTable ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ updatePrimaryVars()

template<class TypeTag , bool enableSolventV = getPropValue<TypeTag, Properties::EnableSolvent>()>
static void Opm::BlackOilSolventModule< TypeTag, enableSolventV >::updatePrimaryVars ( PrimaryVariables &  newPv,
const PrimaryVariables &  oldPv,
const EqVector &  delta 
)
inlinestatic

Do a Newton-Raphson update the primary variables of the solvents.


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