Public Types | Static Public Member Functions | List of all members
Opm::BlackOilEnergyModule< TypeTag, enableEnergyV > 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. More...
 
static void registerOutputModules (Model &model, Simulator &simulator)
 Register all energy 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 addHeatFlux (RateVector &flux, const Evaluation &heatFlux)
 
template<class UpEval , class Eval , class FluidState >
static void addPhaseEnthalpyFluxes_ (RateVector &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)
 
static void assignPrimaryVars (PrimaryVariables &priVars, Scalar)
 Assign the energy specific primary variables to a PrimaryVariables object. More...
 
template<class FluidState >
static void assignPrimaryVars (PrimaryVariables &priVars, const FluidState &fluidState)
 Assign the energy 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 energys. 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)
 

Detailed Description

template<class TypeTag, bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
class Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >

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

Member Typedef Documentation

◆ ExtensiveQuantities

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
using Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::ExtensiveQuantities = GetPropType<TypeTag, Properties::ExtensiveQuantities>

Member Function Documentation

◆ addHeatFlux()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static void Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::addHeatFlux ( RateVector &  flux,
const Evaluation &  heatFlux 
)
inlinestatic

Referenced by Opm::BlackOilLocalResidualTPFA< TypeTag >::calculateFluxes_(), Opm::BlackOilLocalResidualTPFA< TypeTag >::computeBoundaryFluxFree(), and Opm::BlackOilLocalResidualTPFA< TypeTag >::computeBoundaryThermal().

◆ addPhaseEnthalpyFlux_()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
template<class UpstreamEval >
static void Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::addPhaseEnthalpyFlux_ ( RateVector &  flux,
unsigned  phaseIdx,
const ElementContext &  elemCtx,
unsigned  scvfIdx,
unsigned  timeIdx 
)
inlinestatic

◆ addPhaseEnthalpyFluxes_()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
template<class UpEval , class Eval , class FluidState >
static void Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::addPhaseEnthalpyFluxes_ ( RateVector &  flux,
unsigned  phaseIdx,
const Eval &  volumeFlux,
const FluidState &  upFs 
)
inlinestatic

◆ addStorage()

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

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

◆ addToEnthalpyRate()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static void Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::addToEnthalpyRate ( RateVector &  flux,
const Evaluation &  hRate 
)
inlinestatic

Referenced by Opm::BlackOilBoundaryRateVector< TypeTag >::setFreeFlow().

◆ assignPrimaryVars() [1/2]

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

Assign the energy specific primary variables to a PrimaryVariables object.

◆ assignPrimaryVars() [2/2]

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static void Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::assignPrimaryVars ( PrimaryVariables &  priVars,
Scalar   
)
inlinestatic

Assign the energy specific primary variables to a PrimaryVariables object.

Referenced by Opm::BlackOilPrimaryVariables< TypeTag >::assignNaive().

◆ computeFlux()

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

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

◆ computeResidualError()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static Scalar Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::computeResidualError ( const EqVector &  resid)
inlinestatic

Return how much a residual is considered an error.

◆ computeUpdateError()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static Scalar Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::computeUpdateError ( const PrimaryVariables &  ,
const EqVector &   
)
inlinestatic

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

◆ deserializeEntity()

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

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

◆ eqApplies()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static bool Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::eqApplies ( unsigned  eqIdx)
inlinestatic

Referenced by Opm::BlackOilModel< TypeTag >::eqName(), Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::eqName(), and Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::eqWeight().

◆ eqName()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static std::string Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::eqName ( unsigned  eqIdx)
inlinestatic

References Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::eqApplies().

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

◆ eqWeight()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static Scalar Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::eqWeight ( unsigned  eqIdx)
inlinestatic

References Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::eqApplies().

◆ primaryVarApplies()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static bool Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::primaryVarApplies ( unsigned  pvIdx)
inlinestatic

Referenced by Opm::BlackOilModel< TypeTag >::primaryVarName(), Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::primaryVarName(), Opm::BlackOilModel< TypeTag >::primaryVarWeight(), and Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::primaryVarWeight().

◆ primaryVarName()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static std::string Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::primaryVarName ( unsigned  pvIdx)
inlinestatic

References Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::primaryVarApplies().

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

◆ primaryVarWeight()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static Scalar Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::primaryVarWeight ( unsigned  pvIdx)
inlinestatic

References Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::primaryVarApplies().

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

◆ registerOutputModules()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static void Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::registerOutputModules ( Model &  model,
Simulator &  simulator 
)
inlinestatic

Register all energy specific VTK and ECL output modules.

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

◆ registerParameters()

template<class TypeTag , bool enableEnergyV = getPropValue<TypeTag, Properties::EnableEnergy>()>
static void Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::registerParameters ( )
inlinestatic

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

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

◆ serializeEntity()

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

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

◆ updatePrimaryVars()

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

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

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