Ewoms::BlackOilRateVector< TypeTag > Class Template Reference

Implements a vector representing mass, molar or volumetric rates for the black oil model. More...

#include <blackoilratevector.hh>

Inheritance diagram for Ewoms::BlackOilRateVector< TypeTag >:
Inheritance graph

Public Member Functions

 BlackOilRateVector ()
 
 BlackOilRateVector (Scalar value)
 
template<class Eval = Evaluation>
 BlackOilRateVector (const typename std::enable_if< std::is_same< Eval, Evaluation >::value, Evaluation >::type &value)
 
 BlackOilRateVector (const BlackOilRateVector &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 FluidState , class RhsEval >
void setVolumetricRate (const FluidState &fluidState, int phaseIdx, const RhsEval &volume)
 Set a volumetric rate of a phase. More...
 
template<class RhsEval >
BlackOilRateVectoroperator= (const RhsEval &value)
 Assignment operator from a scalar or a function evaluation. More...
 
BlackOilRateVectoroperator= (const BlackOilRateVector &other)
 Assignment operator from another rate vector. More...
 

Detailed Description

template<class TypeTag>
class Ewoms::BlackOilRateVector< TypeTag >

Implements a vector representing mass, molar or volumetric rates for the black oil model.

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::BlackOilRateVector< TypeTag >::BlackOilRateVector ( )
inline
template<class TypeTag >
Ewoms::BlackOilRateVector< TypeTag >::BlackOilRateVector ( Scalar  value)
inline

template<class TypeTag >
template<class Eval = Evaluation>
Ewoms::BlackOilRateVector< TypeTag >::BlackOilRateVector ( const typename std::enable_if< std::is_same< Eval, Evaluation >::value, Evaluation >::type &  value)
inline
template<class TypeTag >
Ewoms::BlackOilRateVector< TypeTag >::BlackOilRateVector ( const BlackOilRateVector< TypeTag > &  value)
inline

Default constructor.

Member Function Documentation

template<class TypeTag >
template<class RhsEval >
BlackOilRateVector& Ewoms::BlackOilRateVector< TypeTag >::operator= ( const RhsEval &  value)
inline

Assignment operator from a scalar or a function evaluation.

template<class TypeTag >
BlackOilRateVector& Ewoms::BlackOilRateVector< TypeTag >::operator= ( const BlackOilRateVector< TypeTag > &  other)
inline

Assignment operator from another rate vector.

template<class TypeTag >
void Ewoms::BlackOilRateVector< 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
valueThe mass rate in $[kg/(m^2\,s)]$ (unit for areal fluxes)

References Ewoms::BlackOilRateVector< TypeTag >::setMolarRate().

template<class TypeTag >
void Ewoms::BlackOilRateVector< 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
valueThe new molar rate in $[mol/(m^2\,s)]$

Referenced by Ewoms::BlackOilRateVector< TypeTag >::setMassRate().

template<class TypeTag >
template<class FluidState , class RhsEval >
void Ewoms::BlackOilRateVector< 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
fluidStateThe 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.
phaseIdxThe index of the fluid phase for which the given amount of volume should be specified.
volumeThe 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: