opm-simulators
Opm::BlackOilEnergyModule< TypeTag, activeModule > Class Template Reference

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

#include <blackoilenergymodules.hh>

Public Types

using ExtensiveQuantities = GetPropType< TypeTag, Properties::ExtensiveQuantities >
 

Static Public Member Functions

static void registerParameters ()
 Register all run-time parameters for the black-oil energy module.
 
static void registerOutputModules (Model &model, Simulator &simulator)
 Register all energy 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 OPM_HOST_DEVICE void computeFlux ([[maybe_unused]] RateVector &flux, [[maybe_unused]] const ElementContext &elemCtx, [[maybe_unused]] unsigned scvfIdx, [[maybe_unused]] unsigned timeIdx)
 
template<class RateVectorT >
static OPM_HOST_DEVICE void addHeatFlux (RateVectorT &flux, const Evaluation &heatFlux)
 
template<class UpEval , class RateVectorT , class Eval , class FluidState >
static OPM_HOST_DEVICE void addPhaseEnthalpyFluxes_ (RateVectorT &flux, unsigned phaseIdx, const Eval &volumeFlux, const FluidState &upFs)
 
template<class UpstreamEval >
static void addPhaseEnthalpyFlux_ (RateVector &flux, unsigned phaseIdx, const ElementContext &elemCtx, unsigned scvfIdx, unsigned timeIdx)
 
static void addToEnthalpyRate (RateVector &flux, const Evaluation &hRate)
 
template<class FluidState >
static void assignPrimaryVars (PrimaryVariables &priVars, const FluidState &fluidState)
 Assign the energy specific primary variables to a PrimaryVariables object.
 
static void updatePrimaryVars (PrimaryVariables &newPv, const PrimaryVariables &oldPv, const EqVector &delta)
 Do a Newton-Raphson update the primary variables of the energys.
 
static Scalar computeUpdateError (const PrimaryVariables &, const EqVector &)
 Return how much a Newton-Raphson update is considered an error.
 
static Scalar computeResidualError (const EqVector &resid)
 Return how much a residual is considered an error.
 
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)
 

Detailed Description

template<class TypeTag, EnergyModules activeModule = getPropValue<TypeTag, Properties::EnergyModuleType>()>
class Opm::BlackOilEnergyModule< TypeTag, activeModule >

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


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