Opm::BlackOilBrineModule< TypeTag, enableBrineV > Class Template Reference

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

#include <blackoilbrinemodules.hh>

Static Public Member Functions

static void registerParameters ()
 Register all run-time parameters for the black-oil brine module. More...
 
static bool primaryVarApplies (unsigned pvIdx)
 
template<class FluidState >
static void assignPrimaryVars (PrimaryVariables &priVars, const FluidState &fluidState)
 Assign the brine specific primary variables to a PrimaryVariables object. More...
 
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 Scalar computeUpdateError (const PrimaryVariables &, const EqVector &)
 Return how much a Newton-Raphson update 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 Scalar & referencePressure (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & bdensityTable (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & pcfactTable (unsigned satnumRegionIdx)
 
static const TabulatedFunction & permfactTable (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & permfactTable (unsigned pvtnumRegionIdx)
 
static const Scalar saltsolTable (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const Scalar saltdenTable (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static bool hasBDensityTables ()
 
static bool hasSaltsolTables ()
 
static bool hasPcfactTables ()
 
static Scalar saltSol (unsigned regionIdx)
 

Detailed Description

template<class TypeTag, bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
class Opm::BlackOilBrineModule< TypeTag, enableBrineV >

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

Member Function Documentation

◆ addStorage()

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

◆ assignPrimaryVars()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
template<class FluidState >
static void Opm::BlackOilBrineModule< TypeTag, enableBrineV >::assignPrimaryVars ( PrimaryVariables &  priVars,
const FluidState &  fluidState 
)
inlinestatic

Assign the brine specific primary variables to a PrimaryVariables object.

◆ bdensityTable()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static const TabulatedFunction & Opm::BlackOilBrineModule< TypeTag, enableBrineV >::bdensityTable ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ computeFlux()

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

◆ computeUpdateError()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static Scalar Opm::BlackOilBrineModule< TypeTag, enableBrineV >::computeUpdateError ( const PrimaryVariables &  ,
const EqVector &   
)
inlinestatic

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

◆ deserializeEntity()

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

◆ eqApplies()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static bool Opm::BlackOilBrineModule< TypeTag, enableBrineV >::eqApplies ( unsigned  eqIdx)
inlinestatic

◆ eqName()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static std::string Opm::BlackOilBrineModule< TypeTag, enableBrineV >::eqName ( unsigned  eqIdx)
inlinestatic

◆ eqWeight()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static Scalar Opm::BlackOilBrineModule< TypeTag, enableBrineV >::eqWeight ( unsigned  eqIdx)
inlinestatic

◆ hasBDensityTables()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static bool Opm::BlackOilBrineModule< TypeTag, enableBrineV >::hasBDensityTables ( )
inlinestatic

◆ hasPcfactTables()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static bool Opm::BlackOilBrineModule< TypeTag, enableBrineV >::hasPcfactTables ( )
inlinestatic

◆ hasSaltsolTables()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static bool Opm::BlackOilBrineModule< TypeTag, enableBrineV >::hasSaltsolTables ( )
inlinestatic

◆ pcfactTable()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static const TabulatedFunction & Opm::BlackOilBrineModule< TypeTag, enableBrineV >::pcfactTable ( unsigned  satnumRegionIdx)
inlinestatic

◆ permfactTable() [1/2]

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static const TabulatedFunction & Opm::BlackOilBrineModule< TypeTag, enableBrineV >::permfactTable ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ permfactTable() [2/2]

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static const TabulatedFunction & Opm::BlackOilBrineModule< TypeTag, enableBrineV >::permfactTable ( unsigned  pvtnumRegionIdx)
inlinestatic

◆ primaryVarApplies()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static bool Opm::BlackOilBrineModule< TypeTag, enableBrineV >::primaryVarApplies ( unsigned  pvIdx)
inlinestatic

◆ primaryVarName()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static std::string Opm::BlackOilBrineModule< TypeTag, enableBrineV >::primaryVarName ( unsigned  pvIdx)
inlinestatic

◆ primaryVarWeight()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static Scalar Opm::BlackOilBrineModule< TypeTag, enableBrineV >::primaryVarWeight ( unsigned  pvIdx)
inlinestatic

◆ referencePressure()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static const Scalar & Opm::BlackOilBrineModule< TypeTag, enableBrineV >::referencePressure ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ registerParameters()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static void Opm::BlackOilBrineModule< TypeTag, enableBrineV >::registerParameters ( )
inlinestatic

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

◆ saltdenTable()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static const Scalar Opm::BlackOilBrineModule< TypeTag, enableBrineV >::saltdenTable ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ saltSol()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static Scalar Opm::BlackOilBrineModule< TypeTag, enableBrineV >::saltSol ( unsigned  regionIdx)
inlinestatic

◆ saltsolTable()

template<class TypeTag , bool enableBrineV = getPropValue<TypeTag, Properties::EnableBrine>()>
static const Scalar Opm::BlackOilBrineModule< TypeTag, enableBrineV >::saltsolTable ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

◆ serializeEntity()

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

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