Opm::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 (unsigned)
 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 (unsigned)
 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 &, unsigned, unsigned)
 Returns the relative weight of a primary variable for calculating relative errors. More...
 
static Scalar eqWeight (const Model &, unsigned, unsigned)
 Returns the relative weight of a equation of the residual. More...
 
template<class FluidState >
static void setPriVarTemperatures (PrimaryVariables &, const FluidState &)
 Given a fluid state, set the temperature in the primary variables. More...
 
template<class RateVector , class FluidState >
static void setEnthalpyRate (RateVector &, const FluidState &, unsigned, const Evaluation &)
 Given a fluid state, set the enthalpy rate which emerges from a volumetric rate. More...
 
static void setEnthalpyRate (RateVector &, const Evaluation &)
 Add the rate of the enthalpy flux to a rate vector. More...
 
static void addToEnthalpyRate (RateVector &, const Evaluation &)
 Add the rate of the enthalpy flux to a rate vector. More...
 
static Scalar thermalConductionRate (const ExtensiveQuantities &)
 Add the rate of the conductive energy flux to a rate vector. More...
 
template<class LhsEval >
static void addPhaseStorage (Dune::FieldVector< LhsEval, numEq > &, const IntensiveQuantities &, unsigned)
 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 > &, const IntensiveQuantities &, const Scv &, unsigned)
 Add the energy storage term for a fluid phase to an equation vector. More...
 
template<class LhsEval >
static void addSolidEnergyStorage (Dune::FieldVector< LhsEval, numEq > &, const IntensiveQuantities &)
 Add the energy storage term for the fracture part a fluid phase to an equation vector. More...
 
template<class Context >
static void addAdvectiveFlux (RateVector &, const Context &, unsigned, unsigned)
 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 &, const Context &, unsigned, unsigned)
 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 &, const Context &, unsigned, unsigned)
 Adds the diffusive energy flux to the flux vector over the face of a sub-control volume. More...
 

Detailed Description

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

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

Member Function Documentation

◆ addAdvectiveFlux()

template<class TypeTag >
template<class Context >
static void Opm::EnergyModule< TypeTag, false >::addAdvectiveFlux ( RateVector &  ,
const Context &  ,
unsigned  ,
unsigned   
)
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)

◆ addDiffusiveFlux()

template<class TypeTag >
template<class Context >
static void Opm::EnergyModule< TypeTag, false >::addDiffusiveFlux ( RateVector &  ,
const Context &  ,
unsigned  ,
unsigned   
)
inlinestatic

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

This method is called by compute flux (base class)

◆ addFracturePhaseStorage()

template<class TypeTag >
template<class LhsEval , class Scv >
static void Opm::EnergyModule< TypeTag, false >::addFracturePhaseStorage ( Dune::FieldVector< LhsEval, numEq > &  ,
const IntensiveQuantities &  ,
const Scv &  ,
unsigned   
)
inlinestatic

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

◆ addPhaseStorage()

template<class TypeTag >
template<class LhsEval >
static void Opm::EnergyModule< TypeTag, false >::addPhaseStorage ( Dune::FieldVector< LhsEval, numEq > &  ,
const IntensiveQuantities &  ,
unsigned   
)
inlinestatic

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

◆ addSolidEnergyStorage()

template<class TypeTag >
template<class LhsEval >
static void Opm::EnergyModule< TypeTag, false >::addSolidEnergyStorage ( Dune::FieldVector< LhsEval, numEq > &  ,
const IntensiveQuantities &   
)
inlinestatic

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

◆ addToEnthalpyRate()

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

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

◆ eqName()

template<class TypeTag >
static std::string Opm::EnergyModule< TypeTag, false >::eqName ( unsigned  )
inlinestatic

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

◆ eqWeight()

template<class TypeTag >
static Scalar Opm::EnergyModule< TypeTag, false >::eqWeight ( const Model &  ,
unsigned  ,
unsigned   
)
inlinestatic

Returns the relative weight of a equation of the residual.

◆ handleFractureFlux()

template<class TypeTag >
template<class Context >
static void Opm::EnergyModule< TypeTag, false >::handleFractureFlux ( RateVector &  ,
const Context &  ,
unsigned  ,
unsigned   
)
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.

◆ primaryVarName()

template<class TypeTag >
static std::string Opm::EnergyModule< TypeTag, false >::primaryVarName ( unsigned  )
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.

◆ primaryVarWeight()

template<class TypeTag >
static Scalar Opm::EnergyModule< TypeTag, false >::primaryVarWeight ( const Model &  ,
unsigned  ,
unsigned   
)
inlinestatic

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

◆ registerParameters()

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

Register all run-time parameters for the energy module.

◆ setEnthalpyRate() [1/2]

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

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

◆ setEnthalpyRate() [2/2]

template<class TypeTag >
template<class RateVector , class FluidState >
static void Opm::EnergyModule< TypeTag, false >::setEnthalpyRate ( RateVector &  ,
const FluidState &  ,
unsigned  ,
const Evaluation &   
)
inlinestatic

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

◆ setPriVarTemperatures()

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

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

◆ thermalConductionRate()

template<class TypeTag >
static Scalar Opm::EnergyModule< TypeTag, false >::thermalConductionRate ( const ExtensiveQuantities &  )
inlinestatic

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


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