Ewoms::EnergyModule< TypeTag, false > Class Template Reference

Provides the auxiliary methods required for consideration of the energy equation. More...

#include <energymodule.hh>

Static Public Member Functions

static void registerParameters ()
 Register all run-time parameters for the energy module. More...
 
static std::string primaryVarName (int pvIdx)
 Returns the name of a primary variable or an empty string if the specified primary variable index does not belong to the energy module. More...
 
static std::string eqName (int eqIdx)
 Returns the name of an equation or an empty string if the specified equation index does not belong to the energy module. More...
 
static Scalar primaryVarWeight (const Model &model, int globalDofIdx, int pvIdx)
 Returns the relative weight of a primary variable for calculating relative errors. More...
 
static Scalar eqWeight (const Model &model, int globalDofIdx, int eqIdx)
 Returns the relative weight of a equation of the residual. More...
 
template<class FluidState >
static void setPriVarTemperatures (PrimaryVariables &priVars, const FluidState &fs)
 Given a fluid state, set the temperature in the primary variables. More...
 
template<class FluidState >
static void setEnthalpyRate (RateVector &rateVec, const FluidState &fluidState, int phaseIdx, const Evaluation &volume)
 Given a fluid state, set the enthalpy rate which emerges from a volumetric rate. More...
 
static void setEnthalpyRate (RateVector &rateVec, const Evaluation &rate)
 Add the rate of the enthalpy flux to a rate vector. More...
 
static void addToEnthalpyRate (RateVector &rateVec, const Evaluation &rate)
 Add the rate of the enthalpy flux to a rate vector. More...
 
static Evaluation heatConductionRate (const ExtensiveQuantities &extQuants)
 Add the rate of the conductive heat flux to a rate vector. More...
 
template<class LhsEval >
static void addPhaseStorage (Dune::FieldVector< LhsEval, numEq > &storage, const IntensiveQuantities &intQuants, int phaseIdx)
 Add the energy storage term for a fluid phase to an equation vector. More...
 
template<class LhsEval , class Scv >
static void addFracturePhaseStorage (Dune::FieldVector< LhsEval, numEq > &storage, const IntensiveQuantities &intQuants, const Scv &scv, int phaseIdx)
 Add the energy storage term for a fluid phase to an equation vector. More...
 
template<class LhsEval >
static void addSolidHeatStorage (Dune::FieldVector< LhsEval, numEq > &storage, const IntensiveQuantities &intQuants)
 Add the energy storage term for the fracture part a fluid phase to an equation vector. More...
 
template<class Context >
static void addAdvectiveFlux (RateVector &flux, const Context &context, int spaceIdx, int timeIdx)
 Evaluates the advective energy fluxes over a face of a subcontrol volume and adds the result in the flux vector. More...
 
template<class Context >
static void handleFractureFlux (RateVector &flux, const Context &context, int spaceIdx, int timeIdx)
 Evaluates the advective energy fluxes over a fracture which should be attributed to a face of a subcontrol volume and adds the result in the flux vector. More...
 
template<class Context >
static void addDiffusiveFlux (RateVector &flux, const Context &context, int spaceIdx, int timeIdx)
 Adds the diffusive heat flux to the flux vector over the face of a sub-control volume. More...
 

Detailed Description

template<class TypeTag>
class Ewoms::EnergyModule< TypeTag, false >

Provides the auxiliary methods required for consideration of the energy equation.

Member Function Documentation

template<class TypeTag >
template<class Context >
static void Ewoms::EnergyModule< TypeTag, false >::addAdvectiveFlux ( RateVector &  flux,
const Context &  context,
int  spaceIdx,
int  timeIdx 
)
inlinestatic

Evaluates the advective energy fluxes over a face of a subcontrol volume and adds the result in the flux vector.

This method is called by compute flux (base class)

template<class TypeTag >
template<class Context >
static void Ewoms::EnergyModule< TypeTag, false >::addDiffusiveFlux ( RateVector &  flux,
const Context &  context,
int  spaceIdx,
int  timeIdx 
)
inlinestatic

Adds the diffusive heat flux to the flux vector over the face of a sub-control volume.

This method is called by compute flux (base class)

template<class TypeTag >
template<class LhsEval , class Scv >
static void Ewoms::EnergyModule< TypeTag, false >::addFracturePhaseStorage ( Dune::FieldVector< LhsEval, numEq > &  storage,
const IntensiveQuantities &  intQuants,
const Scv &  scv,
int  phaseIdx 
)
inlinestatic

Add the energy storage term for a fluid phase to an equation vector.

template<class TypeTag >
template<class LhsEval >
static void Ewoms::EnergyModule< TypeTag, false >::addPhaseStorage ( Dune::FieldVector< LhsEval, numEq > &  storage,
const IntensiveQuantities &  intQuants,
int  phaseIdx 
)
inlinestatic

Add the energy storage term for a fluid phase to an equation vector.

template<class TypeTag >
template<class LhsEval >
static void Ewoms::EnergyModule< TypeTag, false >::addSolidHeatStorage ( Dune::FieldVector< LhsEval, numEq > &  storage,
const IntensiveQuantities &  intQuants 
)
inlinestatic

Add the energy storage term for the fracture part a fluid phase to an equation vector.

template<class TypeTag >
static void Ewoms::EnergyModule< TypeTag, false >::addToEnthalpyRate ( RateVector &  rateVec,
const Evaluation &  rate 
)
inlinestatic

Add the rate of the enthalpy flux to a rate vector.

template<class TypeTag >
static std::string Ewoms::EnergyModule< TypeTag, false >::eqName ( int  eqIdx)
inlinestatic

Returns the name of an equation or an empty string if the specified equation index does not belong to the energy module.

template<class TypeTag >
static Scalar Ewoms::EnergyModule< TypeTag, false >::eqWeight ( const Model &  model,
int  globalDofIdx,
int  eqIdx 
)
inlinestatic

Returns the relative weight of a equation of the residual.

template<class TypeTag >
template<class Context >
static void Ewoms::EnergyModule< TypeTag, false >::handleFractureFlux ( RateVector &  flux,
const Context &  context,
int  spaceIdx,
int  timeIdx 
)
inlinestatic

Evaluates the advective energy fluxes over a fracture which should be attributed to a face of a subcontrol volume and adds the result in the flux vector.

template<class TypeTag >
static Evaluation Ewoms::EnergyModule< TypeTag, false >::heatConductionRate ( const ExtensiveQuantities &  extQuants)
inlinestatic

Add the rate of the conductive heat flux to a rate vector.

template<class TypeTag >
static std::string Ewoms::EnergyModule< TypeTag, false >::primaryVarName ( int  pvIdx)
inlinestatic

Returns the name of a primary variable or an empty string if the specified primary variable index does not belong to the energy module.

template<class TypeTag >
static Scalar Ewoms::EnergyModule< TypeTag, false >::primaryVarWeight ( const Model &  model,
int  globalDofIdx,
int  pvIdx 
)
inlinestatic

Returns the relative weight of a primary variable for calculating relative errors.

template<class TypeTag >
static void Ewoms::EnergyModule< TypeTag, false >::registerParameters ( )
inlinestatic

Register all run-time parameters for the energy module.

template<class TypeTag >
template<class FluidState >
static void Ewoms::EnergyModule< TypeTag, false >::setEnthalpyRate ( RateVector &  rateVec,
const FluidState &  fluidState,
int  phaseIdx,
const Evaluation &  volume 
)
inlinestatic

Given a fluid state, set the enthalpy rate which emerges from a volumetric rate.

template<class TypeTag >
static void Ewoms::EnergyModule< TypeTag, false >::setEnthalpyRate ( RateVector &  rateVec,
const Evaluation &  rate 
)
inlinestatic

Add the rate of the enthalpy flux to a rate vector.

template<class TypeTag >
template<class FluidState >
static void Ewoms::EnergyModule< TypeTag, false >::setPriVarTemperatures ( PrimaryVariables &  priVars,
const FluidState &  fs 
)
inlinestatic

Given a fluid state, set the temperature in the primary variables.


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