opm-simulators
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 setParams (BlackOilFoamParams< Scalar > &&params)
 Set parameters.
 
static void registerParameters ()
 Register all run-time parameters for the black-oil foam module.
 
static void registerOutputModules (Model &, Simulator &)
 Register all foam specific VTK and ECL output modules.
 
static bool primaryVarApplies (unsigned pvIdx)
 
static std::string primaryVarName ([[maybe_unused]] unsigned pvIdx)
 
static Scalar primaryVarWeight ([[maybe_unused]] unsigned pvIdx)
 
static bool eqApplies (unsigned eqIdx)
 
static std::string eqName ([[maybe_unused]] unsigned eqIdx)
 
static Scalar eqWeight ([[maybe_unused]] unsigned eqIdx)
 
template<class StorageType >
static OPM_HOST_DEVICE void addStorage (StorageType &storage, const IntensiveQuantities &intQuants)
 
static void computeFlux ([[maybe_unused]] RateVector &flux, [[maybe_unused]] const ElementContext &elemCtx, [[maybe_unused]] unsigned scvfIdx, [[maybe_unused]] unsigned timeIdx)
 
static Scalar computeUpdateError (const PrimaryVariables &, const EqVector &)
 Return how much a Newton-Raphson update is considered an error.
 
template<class DofEntity >
static void serializeEntity ([[maybe_unused]] const Model &model, [[maybe_unused]] std::ostream &outstream, [[maybe_unused]] const DofEntity &dof)
 
template<class DofEntity >
static void deserializeEntity ([[maybe_unused]] Model &model, [[maybe_unused]] std::istream &instream, [[maybe_unused]] 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.


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