Public Member Functions | List of all members
Opm::BlackOilRateVector< TypeTag > Class Template Reference
Flow Models » Black Oil

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

#include <blackoilratevector.hh>

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

Public Member Functions

 BlackOilRateVector ()
 
 BlackOilRateVector (Scalar value)
 
void setMassRate (const ParentType &value, unsigned pvtRegionIdx=0)
 Set a mass rate of the conservation quantities. More...
 
void setMolarRate (const ParentType &value, unsigned pvtRegionIdx=0)
 Set a molar rate of the conservation quantities. 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 >
BlackOilRateVector & operator= (const RhsEval &value)
 Assignment operator from a scalar or a function evaluation. More...
 

Detailed Description

template<class TypeTag>
class Opm::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

◆ BlackOilRateVector() [1/2]

template<class TypeTag >
Opm::BlackOilRateVector< TypeTag >::BlackOilRateVector ( )
inline

◆ BlackOilRateVector() [2/2]

template<class TypeTag >
Opm::BlackOilRateVector< TypeTag >::BlackOilRateVector ( Scalar  value)
inline

Member Function Documentation

◆ operator=()

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

Assignment operator from a scalar or a function evaluation.

◆ setMassRate()

template<class TypeTag >
void Opm::BlackOilRateVector< TypeTag >::setMassRate ( const ParentType &  value,
unsigned  pvtRegionIdx = 0 
)
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 Opm::BlackOilSolventModule< TypeTag, enableSolventV >::solventPvt().

◆ setMolarRate()

template<class TypeTag >
void Opm::BlackOilRateVector< TypeTag >::setMolarRate ( const ParentType &  value,
unsigned  pvtRegionIdx = 0 
)
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)]$

References Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::molarMass(), and Opm::BlackOilSolventModule< TypeTag, enableSolventV >::solventPvt().

◆ setVolumetricRate()

template<class TypeTag >
template<class FluidState , class RhsEval >
void Opm::BlackOilRateVector< 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
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: