Public Member Functions | List of all members
Opm::ImmiscibleRateVector< TypeTag > Class Template Reference
Flow Models » Immiscible

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

#include <immiscibleratevector.hh>

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

Public Member Functions

 ImmiscibleRateVector ()
 Default constructor. More...
 
 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 $A \in \{m^2, m^3\}$. 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. More...
 
ImmiscibleRateVector & operator= (const ImmiscibleRateVector &other)
 Assignment operator from another rate vector. More...
 

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/3]

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

Default constructor.

◆ ImmiscibleRateVector() [2/3]

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

Constructor with assignment from scalar.

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

◆ ImmiscibleRateVector() [3/3]

template<class TypeTag >
Opm::ImmiscibleRateVector< TypeTag >::ImmiscibleRateVector ( const ImmiscibleRateVector< TypeTag > &  value)
inline

Copy constructor.

Parameters
valueThe rate vector that will be duplicated.

Member Function Documentation

◆ operator=() [1/2]

template<class TypeTag >
ImmiscibleRateVector & Opm::ImmiscibleRateVector< TypeTag >::operator= ( const ImmiscibleRateVector< TypeTag > &  other)
inline

Assignment operator from another rate vector.

◆ operator=() [2/2]

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

Assignment operator from a scalar or a function evaluation.

◆ setEnthalpyRate()

template<class TypeTag >
template<class RhsEval >
void Opm::ImmiscibleRateVector< 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
rateThe enthalpy rate in $[J/(m^2\,s)]$

◆ 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
valueThe mass rate in $[kg/(m^2\,s)]$ (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
valueThe new molar rate in $[mol/(m^2\,s)]$

◆ 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
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: