Implements a vector representing mass, molar or volumetric rates. More...

#include <richardsratevector.hh>

Inheritance diagram for Ewoms::RichardsRateVector< TypeTag >:

Public Member Functions
	RichardsRateVector ()

	RichardsRateVector (const Evaluation &value)

	RichardsRateVector (const RichardsRateVector &value)
	Default constructor. More...

void	setMassRate (const ParentType &value)
	Set a mass rate of the conservation quantities. More...

void	setMolarRate (const ParentType &value)
	Set a molar rate of the conservation quantities. More...

template<class RhsEval >
void	setEnthalpyRate (const RhsEval &rate)
	Set an enthalpy rate [J/As] where $A \in \{m^2, m^3\}$ . More...

template<class FluidState , class RhsEval >
void	setVolumetricRate (const FluidState &fluidState, int phaseIdx, const RhsEval &volume)
	Set a volumetric rate of a phase. More...

template<class RhsEval >
RichardsRateVector &	operator= (const RhsEval &value)
	Assignment operator from a scalar or a function evaluation. More...

RichardsRateVector &	operator= (const RichardsRateVector &other)
	Assignment operator from another rate vector. More...

Detailed Description

template<class TypeTag>
class Ewoms::RichardsRateVector< TypeTag >

Implements a vector representing mass, molar or volumetric rates.

This class is basically a Dune::FieldVector which can be set using either mass, molar or volumetric rates.

Constructor & Destructor Documentation

template<class TypeTag >

Ewoms::RichardsRateVector< TypeTag >::RichardsRateVector ( )

inline

template<class TypeTag >

Ewoms::RichardsRateVector< TypeTag >::RichardsRateVector ( const Evaluation & value )

inline

template<class TypeTag >

Ewoms::RichardsRateVector< TypeTag >::RichardsRateVector ( const RichardsRateVector< TypeTag > & value )

inline

Default constructor.

Member Function Documentation

template<class TypeTag >

template<class RhsEval >

RichardsRateVector& Ewoms::RichardsRateVector< TypeTag >::operator= ( const RhsEval & value )

inline

Assignment operator from a scalar or a function evaluation.

template<class TypeTag >

RichardsRateVector& Ewoms::RichardsRateVector< TypeTag >::operator= ( const RichardsRateVector< TypeTag > & other )

inline

Assignment operator from another rate vector.

template<class TypeTag >

template<class RhsEval >

void Ewoms::RichardsRateVector< TypeTag >::setEnthalpyRate ( const RhsEval & rate )

inline

Set an enthalpy rate [J/As] where $A \in \{m^2, m^3\}$ .

If the energy equation is not enabled, this method is a no-op.

Parameters

rate	The enthalpy rate in $[J/(m^2\,s)]$

template<class TypeTag >

void Ewoms::RichardsRateVector< TypeTag >::setMassRate ( const ParentType & value )

inline

Set a mass rate of the conservation quantities.

Enthalpy is not taken into account seperately here. This means that it must be set to the desired value in the parameter.

Parameters

value The mass rate in $[kg/(m^2\,s)]$ (unit for areal fluxes)

template<class TypeTag >

void Ewoms::RichardsRateVector< TypeTag >::setMolarRate ( const ParentType & value )

inline

Set a molar rate of the conservation quantities.

Enthalpy is not taken into account seperately here. This means that it must be set to the desired value in the parameter.

Parameters

value The new molar rate in $[mol/(m^2\,s)]$

template<class TypeTag >

template<class FluidState , class RhsEval >

void Ewoms::RichardsRateVector< TypeTag >::setVolumetricRate	(	const FluidState &	fluidState,
		int	phaseIdx,
		const RhsEval &	volume
	)

inline

Set a volumetric rate of a phase.

The enthalpy transported into the domain is taken into account by this method.

Parameters

fluidState	The thermodynamic state of the fluids which should be considered. The density and the composition of the considered phase must be specified before calling this method.
phaseIdx	The index of the fluid phase for which the given amount of volume should be specified.
volume	The volumetric rate of the fluid phase in $[m^3/(m^2\,s)]$ (unit for areal fluxes)

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

richardsratevector.hh

Public Member Functions

Detailed Description

template<class TypeTag> class Ewoms::RichardsRateVector< TypeTag >

Constructor & Destructor Documentation

Member Function Documentation

template<class TypeTag>
class Ewoms::RichardsRateVector< TypeTag >