Static Public Member Functions | List of all members
Opm::BlackOilFoamModule< TypeTag, enableFoamV > Class Template Reference

Contains the high level supplements required to extend the black oil model to include the effects of foam. More...

#include <blackoilfoammodules.hh>

Static Public Member Functions

static void registerParameters ()
 Register all run-time parameters for the black-oil foam module. More...
 
static void registerOutputModules (Model &, Simulator &)
 Register all foam 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 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 foamRockDensity (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static bool foamAllowDesorption (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & adsorbedFoamTable (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const TabulatedFunction & gasMobilityMultiplierTable (const ElementContext &elemCtx, unsigned scvIdx, unsigned timeIdx)
 
static const BlackOilFoamParams< Scalar >::FoamCoefficients & foamCoefficients (const ElementContext &elemCtx, const unsigned scvIdx, const unsigned timeIdx)
 
static Phase transportPhase ()
 

Detailed Description

template<class TypeTag, bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
class Opm::BlackOilFoamModule< TypeTag, enableFoamV >

Contains the high level supplements required to extend the black oil model to include the effects of foam.

Member Function Documentation

◆ addStorage()

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

Referenced by Opm::BlackOilLocalResidual< TypeTag >::computeStorage(), and Opm::BlackOilLocalResidualTPFA< TypeTag >::computeStorage().

◆ adsorbedFoamTable()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static const TabulatedFunction & Opm::BlackOilFoamModule< TypeTag, enableFoamV >::adsorbedFoamTable ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

Referenced by Opm::BlackOilFoamIntensiveQuantities< TypeTag, enableFoam >::foamPropertiesUpdate_().

◆ computeFlux()

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

References Opm::BlackOilFoamModule< TypeTag, enableFoamV >::transportPhase().

Referenced by Opm::BlackOilLocalResidual< TypeTag >::computeFlux().

◆ computeUpdateError()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static Scalar Opm::BlackOilFoamModule< TypeTag, enableFoamV >::computeUpdateError ( const PrimaryVariables &  ,
const EqVector &   
)
inlinestatic

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

◆ deserializeEntity()

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

◆ eqApplies()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static bool Opm::BlackOilFoamModule< TypeTag, enableFoamV >::eqApplies ( unsigned  eqIdx)
inlinestatic

Referenced by Opm::BlackOilFoamModule< TypeTag, enableFoamV >::eqName(), and Opm::BlackOilFoamModule< TypeTag, enableFoamV >::eqWeight().

◆ eqName()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static std::string Opm::BlackOilFoamModule< TypeTag, enableFoamV >::eqName ( unsigned  eqIdx)
inlinestatic

References Opm::BlackOilFoamModule< TypeTag, enableFoamV >::eqApplies().

◆ eqWeight()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static Scalar Opm::BlackOilFoamModule< TypeTag, enableFoamV >::eqWeight ( unsigned  eqIdx)
inlinestatic

References Opm::BlackOilFoamModule< TypeTag, enableFoamV >::eqApplies().

◆ foamAllowDesorption()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static bool Opm::BlackOilFoamModule< TypeTag, enableFoamV >::foamAllowDesorption ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

Referenced by Opm::BlackOilFoamIntensiveQuantities< TypeTag, enableFoam >::foamPropertiesUpdate_().

◆ foamCoefficients()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static const BlackOilFoamParams< Scalar >::FoamCoefficients & Opm::BlackOilFoamModule< TypeTag, enableFoamV >::foamCoefficients ( const ElementContext &  elemCtx,
const unsigned  scvIdx,
const unsigned  timeIdx 
)
inlinestatic

Referenced by Opm::BlackOilFoamIntensiveQuantities< TypeTag, enableFoam >::foamPropertiesUpdate_().

◆ foamRockDensity()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static const Scalar Opm::BlackOilFoamModule< TypeTag, enableFoamV >::foamRockDensity ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

Referenced by Opm::BlackOilFoamIntensiveQuantities< TypeTag, enableFoam >::foamPropertiesUpdate_().

◆ gasMobilityMultiplierTable()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static const TabulatedFunction & Opm::BlackOilFoamModule< TypeTag, enableFoamV >::gasMobilityMultiplierTable ( const ElementContext &  elemCtx,
unsigned  scvIdx,
unsigned  timeIdx 
)
inlinestatic

Referenced by Opm::BlackOilFoamIntensiveQuantities< TypeTag, enableFoam >::foamPropertiesUpdate_().

◆ primaryVarApplies()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static bool Opm::BlackOilFoamModule< TypeTag, enableFoamV >::primaryVarApplies ( unsigned  pvIdx)
inlinestatic

Referenced by Opm::BlackOilFoamModule< TypeTag, enableFoamV >::primaryVarName(), and Opm::BlackOilFoamModule< TypeTag, enableFoamV >::primaryVarWeight().

◆ primaryVarName()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static std::string Opm::BlackOilFoamModule< TypeTag, enableFoamV >::primaryVarName ( unsigned  pvIdx)
inlinestatic

References Opm::BlackOilFoamModule< TypeTag, enableFoamV >::primaryVarApplies().

◆ primaryVarWeight()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static Scalar Opm::BlackOilFoamModule< TypeTag, enableFoamV >::primaryVarWeight ( unsigned  pvIdx)
inlinestatic

References Opm::BlackOilFoamModule< TypeTag, enableFoamV >::primaryVarApplies().

◆ registerOutputModules()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static void Opm::BlackOilFoamModule< TypeTag, enableFoamV >::registerOutputModules ( Model &  ,
Simulator &   
)
inlinestatic

Register all foam specific VTK and ECL output modules.

◆ registerParameters()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static void Opm::BlackOilFoamModule< TypeTag, enableFoamV >::registerParameters ( )
inlinestatic

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

◆ serializeEntity()

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

◆ transportPhase()

template<class TypeTag , bool enableFoamV = getPropValue<TypeTag, Properties::EnableFoam>()>
static Phase Opm::BlackOilFoamModule< TypeTag, enableFoamV >::transportPhase ( )
inlinestatic

Referenced by Opm::BlackOilFoamModule< TypeTag, enableFoamV >::computeFlux(), and Opm::BlackOilFoamIntensiveQuantities< TypeTag, enableFoam >::foamPropertiesUpdate_().

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