Opm::BlackOilExtboModule< TypeTag, enableExtboV > Class Template Reference

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

#include <blackoilextbomodules.hh>

Static Public Member Functions

static void registerParameters ()
 Register all run-time parameters for the black-oil solvent module. More...
 
static void registerOutputModules (Model &, 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 zFraction)
 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)
 
template<typename Value >
static Value xVolume (unsigned pvtRegionIdx, const Value &pressure, const Value &z)
 
template<typename Value >
static Value yVolume (unsigned pvtRegionIdx, const Value &pressure, const Value &z)
 
template<typename Value >
static Value pbubRs (unsigned pvtRegionIdx, const Value &z, const Value &rs)
 
template<typename Value >
static Value pbubRv (unsigned pvtRegionIdx, const Value &z, const Value &rv)
 
template<typename Value >
static Value oilViscosity (unsigned pvtRegionIdx, const Value &pressure, const Value &z)
 
template<typename Value >
static Value gasViscosity (unsigned pvtRegionIdx, const Value &pressure, const Value &z)
 
template<typename Value >
static Value bo (unsigned pvtRegionIdx, const Value &pressure, const Value &z)
 
template<typename Value >
static Value bg (unsigned pvtRegionIdx, const Value &pressure, const Value &z)
 
template<typename Value >
static Value rs (unsigned pvtRegionIdx, const Value &pressure, const Value &z)
 
template<typename Value >
static Value rv (unsigned pvtRegionIdx, const Value &pressure, const Value &z)
 
static Scalar referenceDensity (unsigned regionIdx)
 
static Scalar zLim (unsigned regionIdx)
 
template<typename Value >
static Value oilCmp (unsigned pvtRegionIdx, const Value &z)
 
template<typename Value >
static Value gasCmp (unsigned pvtRegionIdx, const Value &z)
 

Detailed Description

template<class TypeTag, bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
class Opm::BlackOilExtboModule< TypeTag, enableExtboV >

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

Member Function Documentation

◆ addStorage()

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

◆ assignPrimaryVars()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static void Opm::BlackOilExtboModule< TypeTag, enableExtboV >::assignPrimaryVars ( PrimaryVariables &  priVars,
Scalar  zFraction 
)
inlinestatic

Assign the solvent specific primary variables to a PrimaryVariables object.

◆ bg()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::bg ( unsigned  pvtRegionIdx,
const Value &  pressure,
const Value &  z 
)
inlinestatic

◆ bo()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::bo ( unsigned  pvtRegionIdx,
const Value &  pressure,
const Value &  z 
)
inlinestatic

◆ computeFlux()

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

◆ computeResidualError()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static Scalar Opm::BlackOilExtboModule< TypeTag, enableExtboV >::computeResidualError ( const EqVector &  resid)
inlinestatic

Return how much a residual is considered an error.

◆ computeUpdateError()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static Scalar Opm::BlackOilExtboModule< TypeTag, enableExtboV >::computeUpdateError ( const PrimaryVariables &  ,
const EqVector &   
)
inlinestatic

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

◆ deserializeEntity()

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

◆ eqApplies()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static bool Opm::BlackOilExtboModule< TypeTag, enableExtboV >::eqApplies ( unsigned  eqIdx)
inlinestatic

◆ eqName()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static std::string Opm::BlackOilExtboModule< TypeTag, enableExtboV >::eqName ( unsigned  eqIdx)
inlinestatic

◆ eqWeight()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static Scalar Opm::BlackOilExtboModule< TypeTag, enableExtboV >::eqWeight ( unsigned  eqIdx)
inlinestatic

◆ gasCmp()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::gasCmp ( unsigned  pvtRegionIdx,
const Value &  z 
)
inlinestatic

◆ gasViscosity()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::gasViscosity ( unsigned  pvtRegionIdx,
const Value &  pressure,
const Value &  z 
)
inlinestatic

◆ oilCmp()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::oilCmp ( unsigned  pvtRegionIdx,
const Value &  z 
)
inlinestatic

◆ oilViscosity()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::oilViscosity ( unsigned  pvtRegionIdx,
const Value &  pressure,
const Value &  z 
)
inlinestatic

◆ pbubRs()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::pbubRs ( unsigned  pvtRegionIdx,
const Value &  z,
const Value &  rs 
)
inlinestatic

◆ pbubRv()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::pbubRv ( unsigned  pvtRegionIdx,
const Value &  z,
const Value &  rv 
)
inlinestatic

◆ primaryVarApplies()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static bool Opm::BlackOilExtboModule< TypeTag, enableExtboV >::primaryVarApplies ( unsigned  pvIdx)
inlinestatic

◆ primaryVarName()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static std::string Opm::BlackOilExtboModule< TypeTag, enableExtboV >::primaryVarName ( unsigned  pvIdx)
inlinestatic

◆ primaryVarWeight()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static Scalar Opm::BlackOilExtboModule< TypeTag, enableExtboV >::primaryVarWeight ( unsigned  pvIdx)
inlinestatic

◆ referenceDensity()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static Scalar Opm::BlackOilExtboModule< TypeTag, enableExtboV >::referenceDensity ( unsigned  regionIdx)
inlinestatic

◆ registerOutputModules()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static void Opm::BlackOilExtboModule< TypeTag, enableExtboV >::registerOutputModules ( Model &  ,
Simulator &   
)
inlinestatic

Register all solvent specific VTK and ECL output modules.

◆ registerParameters()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static void Opm::BlackOilExtboModule< TypeTag, enableExtboV >::registerParameters ( )
inlinestatic

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

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

◆ rs()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::rs ( unsigned  pvtRegionIdx,
const Value &  pressure,
const Value &  z 
)
inlinestatic

◆ rv()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::rv ( unsigned  pvtRegionIdx,
const Value &  pressure,
const Value &  z 
)
inlinestatic

◆ serializeEntity()

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

◆ updatePrimaryVars()

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

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

◆ xVolume()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::xVolume ( unsigned  pvtRegionIdx,
const Value &  pressure,
const Value &  z 
)
inlinestatic

◆ yVolume()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
template<typename Value >
static Value Opm::BlackOilExtboModule< TypeTag, enableExtboV >::yVolume ( unsigned  pvtRegionIdx,
const Value &  pressure,
const Value &  z 
)
inlinestatic

◆ zLim()

template<class TypeTag , bool enableExtboV = getPropValue<TypeTag, Properties::EnableExtbo>()>
static Scalar Opm::BlackOilExtboModule< TypeTag, enableExtboV >::zLim ( unsigned  regionIdx)
inlinestatic

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