Opm::ImmiscibleRateVector< TypeTag > Class Template Reference

Implements a vector representing rates of conserved quantities. More...

#include <immiscibleratevector.hh>

Inheritance diagram for Opm::ImmiscibleRateVector< TypeTag >:

Public Member Functions
	ImmiscibleRateVector ()
	Default constructor.
	ImmiscibleRateVector (const Evaluation &value)
	Constructor with assignment from scalar. More...
	ImmiscibleRateVector (const ImmiscibleRateVector &value)
	Copy 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 . More...
template<class FluidState , class RhsEval >
void	setVolumetricRate (const FluidState &fluidState, unsigned phaseIdx, const RhsEval &volume)
	Set a volumetric rate of a phase. More...
template<class RhsEval >
ImmiscibleRateVector &	operator= (const RhsEval &value)
	Assignment operator from a scalar or a function evaluation.
ImmiscibleRateVector &	operator= (const ImmiscibleRateVector &other)
	Assignment operator from another rate vector.

Detailed Description

template<class TypeTag>
class Opm::ImmiscibleRateVector< TypeTag >

Implements a vector representing rates of conserved quantities.

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

Constructor & Destructor Documentation

ImmiscibleRateVector() [1/2]

template<class TypeTag >

Opm::ImmiscibleRateVector< TypeTag >::ImmiscibleRateVector ( const Evaluation &  value )

inlineexplicit

Constructor with assignment from scalar.

Parameters

value

The scalar value to which all entries of the vector will be set.

ImmiscibleRateVector() [2/2]

template<class TypeTag >

Opm::ImmiscibleRateVector< TypeTag >::ImmiscibleRateVector ( const ImmiscibleRateVector< TypeTag > &  value )

inline

Copy constructor.

Parameters

value

The rate vector that will be duplicated.

Member Function Documentation

setEnthalpyRate()

template<class TypeTag >

template<class RhsEval >

void Opm::ImmiscibleRateVector< TypeTag >::setEnthalpyRate ( const RhsEval &  rate )

inline

Set an enthalpy rate [J/As] where .

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

Parameters

rate	The enthalpy rate in

setMassRate()

template<class TypeTag >

void Opm::ImmiscibleRateVector< 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 (unit for areal fluxes)

setMolarRate()

template<class TypeTag >

void Opm::ImmiscibleRateVector< 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

setVolumetricRate()

template<class TypeTag >

template<class FluidState , class RhsEval >

void Opm::ImmiscibleRateVector< TypeTag >::setVolumetricRate ( const FluidState &  fluidState, unsigned  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 (unit for areal fluxes)

---

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

• opm/models/immiscible/immiscibleratevector.hh