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 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 (unsigned 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, unsigned globalDofIdx, unsigned pvIdx)
	Returns the relative weight of a primary variable for calculating relative errors. More...

static Scalar	eqWeight (const Model &, unsigned, unsigned eqIdx)
	Returns the relative weight of a equation. More...

static void	setEnthalpyRate (RateVector &rateVec, const Evaluation &rate)
	Set the rate of energy flux of 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	thermalConductionRate (const ExtensiveQuantities &extQuants)
	Returns the conductive energy flux for a given flux integration point. More...

template<class RateVector , class FluidState >
static void	setEnthalpyRate (RateVector &rateVec, const FluidState &fluidState, unsigned phaseIdx, const Evaluation &volume)
	Given a fluid state, set the enthalpy rate which emerges from a volumetric rate. 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 LhsEval >
static void	addPhaseStorage (Dune::FieldVector< LhsEval, numEq > &storage, const IntensiveQuantities &intQuants, unsigned phaseIdx)
	Add the energy storage term for a fluid phase to an equation vector. More...

template<class Scv , class LhsEval >
static void	addFracturePhaseStorage (Dune::FieldVector< LhsEval, numEq > &storage, const IntensiveQuantities &intQuants, const Scv &scv, unsigned phaseIdx)
	Add the energy storage term for a fluid phase to an equation vector. More...

template<class LhsEval >
static void	addSolidEnergyStorage (Dune::FieldVector< LhsEval, numEq > &storage, const IntensiveQuantities &intQuants)
	Add the energy storage term for a fluid phase to an equation vector. More...

template<class Context >
static void	addAdvectiveFlux (RateVector &flux, const Context &context, unsigned spaceIdx, unsigned timeIdx)
	Evaluates the advective energy fluxes for a flux integration point and adds the result in the flux vector. More...

template<class Context >
static void	handleFractureFlux (RateVector &flux, const Context &context, unsigned spaceIdx, unsigned 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, unsigned spaceIdx, unsigned timeIdx)
	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, true >

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, true >::addAdvectiveFlux	(	RateVector &	flux,
		const Context &	context,
		unsigned	spaceIdx,
		unsigned	timeIdx
	)

inlinestatic

Evaluates the advective energy fluxes for a flux integration point 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, true >::addDiffusiveFlux	(	RateVector &	flux,
		const Context &	context,
		unsigned	spaceIdx,
		unsigned	timeIdx
	)

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 Scv , class LhsEval >

static void Opm::EnergyModule< TypeTag, true >::addFracturePhaseStorage	(	Dune::FieldVector< LhsEval, numEq > &	storage,
		const IntensiveQuantities &	intQuants,
		const Scv &	scv,
		unsigned	phaseIdx
	)

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, true >::addPhaseStorage	(	Dune::FieldVector< LhsEval, numEq > &	storage,
		const IntensiveQuantities &	intQuants,
		unsigned	phaseIdx
	)

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, true >::addSolidEnergyStorage	(	Dune::FieldVector< LhsEval, numEq > &	storage,
		const IntensiveQuantities &	intQuants
	)

inlinestatic

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

◆ addToEnthalpyRate()

template<class TypeTag >

static void Opm::EnergyModule< TypeTag, true >::addToEnthalpyRate	(	RateVector &	rateVec,
		const Evaluation &	rate
	)

inlinestatic

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

◆ eqName()

template<class TypeTag >

static std::string Opm::EnergyModule< TypeTag, true >::eqName ( unsigned eqIdx )

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, true >::eqWeight	(	const Model &	,
		unsigned	,
		unsigned	eqIdx
	)

inlinestatic

Returns the relative weight of a equation.

◆ handleFractureFlux()

template<class TypeTag >

template<class Context >

static void Opm::EnergyModule< TypeTag, true >::handleFractureFlux	(	RateVector &	flux,
		const Context &	context,
		unsigned	spaceIdx,
		unsigned	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.

◆ primaryVarName()

template<class TypeTag >

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

◆ primaryVarWeight()

template<class TypeTag >

static Scalar Opm::EnergyModule< TypeTag, true >::primaryVarWeight	(	const Model &	model,
		unsigned	globalDofIdx,
		unsigned	pvIdx
	)

inlinestatic

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

◆ registerParameters()

template<class TypeTag >

static void Opm::EnergyModule< TypeTag, true >::registerParameters ( )

inlinestatic

Register all run-time parameters for the energy module.

◆ setEnthalpyRate() [1/2]

template<class TypeTag >

static void Opm::EnergyModule< TypeTag, true >::setEnthalpyRate	(	RateVector &	rateVec,
		const Evaluation &	rate
	)

inlinestatic

Set the rate of energy flux of a rate vector.

◆ setEnthalpyRate() [2/2]

template<class TypeTag >

template<class RateVector , class FluidState >

static void Opm::EnergyModule< TypeTag, true >::setEnthalpyRate	(	RateVector &	rateVec,
		const FluidState &	fluidState,
		unsigned	phaseIdx,
		const Evaluation &	volume
	)

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, true >::setPriVarTemperatures	(	PrimaryVariables &	priVars,
		const FluidState &	fs
	)

inlinestatic

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

◆ thermalConductionRate()

template<class TypeTag >

static Evaluation Opm::EnergyModule< TypeTag, true >::thermalConductionRate ( const ExtensiveQuantities & extQuants )

inlinestatic

Returns the conductive energy flux for a given flux integration point.

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

energymodule.hh

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ addAdvectiveFlux()

◆ addDiffusiveFlux()

◆ addFracturePhaseStorage()

◆ addPhaseStorage()

◆ addSolidEnergyStorage()

◆ addToEnthalpyRate()

◆ eqName()

◆ eqWeight()

◆ handleFractureFlux()

◆ primaryVarName()

◆ primaryVarWeight()

◆ registerParameters()

◆ setEnthalpyRate() [1/2]

◆ setEnthalpyRate() [2/2]

◆ setPriVarTemperatures()

◆ thermalConductionRate()