Ewoms::FvBaseIntensiveQuantities< TypeTag > Class Template Reference

Base class for the model specific class which provides access to all intensive (i.e., volume averaged) quantities. More...

#include <fvbaseintensivequantities.hh>

Public Member Functions
	FvBaseIntensiveQuantities ()
	FvBaseIntensiveQuantities (const FvBaseIntensiveQuantities &v)
FvBaseIntensiveQuantities &	operator= (const FvBaseIntensiveQuantities &v)
	Assignment operator. More...
void	setEvalPoint (const Implementation *ep)
	Sets the evaluation point used by the local jacobian. More...
const Implementation &	evalPoint () const
	Returns the evaluation point used by the local jacobian. More...
void	update (const ElementContext &elemCtx, int dofIdx, int timeIdx)
	Update all quantities for a given control volume. More...
void	updateScvGradients (const ElementContext &elemCtx, int dofIdx, int timeIdx)
	Update all gradients for a given control volume. More...
Scalar	extrusionFactor () const
	Return how much a given sub-control volume is extruded. More...
void	checkDefined () const
	If running in valgrind this makes sure that all quantities in the intensive quantities are defined. More...

Static Public Member Functions
static void	registerParameters ()
	Register all run-time parameters for the intensive quantities. More...

Detailed Description

template<class TypeTag>
class Ewoms::FvBaseIntensiveQuantities< TypeTag >

Base class for the model specific class which provides access to all intensive (i.e., volume averaged) quantities.

Constructor & Destructor Documentation

template<class TypeTag >

Ewoms::FvBaseIntensiveQuantities< TypeTag >::FvBaseIntensiveQuantities ( )

inline

template<class TypeTag >

Ewoms::FvBaseIntensiveQuantities< TypeTag >::FvBaseIntensiveQuantities ( const FvBaseIntensiveQuantities< TypeTag > &  v )

inline

Member Function Documentation

template<class TypeTag >

void Ewoms::FvBaseIntensiveQuantities< TypeTag >::checkDefined ( ) const

inline

If running in valgrind this makes sure that all quantities in the intensive quantities are defined.

template<class TypeTag >

const Implementation& Ewoms::FvBaseIntensiveQuantities< TypeTag >::evalPoint ( ) const

inline

Returns the evaluation point used by the local jacobian.

The evaluation point is only used by semi-smooth models.

template<class TypeTag >

Scalar Ewoms::FvBaseIntensiveQuantities< TypeTag >::extrusionFactor ( ) const

inline

Return how much a given sub-control volume is extruded.

This means the factor by which a lower-dimensional (1D or 2D) entity needs to be expanded to get a full dimensional cell. The default is 1.0 which means that 1D problems are actually thought as pipes with a cross section of 1 m^2 and 2D problems are assumed to extend 1 m to the back.

template<class TypeTag >

FvBaseIntensiveQuantities& Ewoms::FvBaseIntensiveQuantities< TypeTag >::operator= ( const FvBaseIntensiveQuantities< TypeTag > &  v )

inline

Assignment operator.

template<class TypeTag >

static void Ewoms::FvBaseIntensiveQuantities< TypeTag >::registerParameters ( )

inlinestatic

Register all run-time parameters for the intensive quantities.

template<class TypeTag >

void Ewoms::FvBaseIntensiveQuantities< TypeTag >::setEvalPoint ( const Implementation *  ep )

inline

Sets the evaluation point used by the local jacobian.

The evaluation point is only used by semi-smooth models.

Parameters

ep	A pointer to the IntensiveQuantities object of the evaluation point

template<class TypeTag >

void Ewoms::FvBaseIntensiveQuantities< TypeTag >::update ( const ElementContext &  elemCtx, int  dofIdx, int  timeIdx  )

inline

Update all quantities for a given control volume.

template<class TypeTag >

void Ewoms::FvBaseIntensiveQuantities< TypeTag >::updateScvGradients ( const ElementContext &  elemCtx, int  dofIdx, int  timeIdx  )

inline

Update all gradients for a given control volume.

Parameters

elemCtx	The execution context from which the method is called.
dofIdx	The index of the sub-control volume for which the intensive quantities should be calculated.
timeIdx	The index for the time discretization for which the intensive quantities should be calculated

---

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

• fvbaseintensivequantities.hh