Opm::RichardsIntensiveQuantities< TypeTag > Class Template Reference

Intensive quantities required by the Richards model. More...

#include <richardsintensivequantities.hh>

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

Public Types

using FluidState = Opm::ImmiscibleFluidState< Evaluation, FluidSystem >
 The type returned by the fluidState() method. More...
 

Public Member Functions

 RichardsIntensiveQuantities ()
 
 RichardsIntensiveQuantities (const RichardsIntensiveQuantities &other)=default
 
RichardsIntensiveQuantitiesoperator= (const RichardsIntensiveQuantities &other)=default
 
void update (const ElementContext &elemCtx, unsigned dofIdx, unsigned timeIdx)
 
const FluidStatefluidState () const
 Returns the phase state for the control-volume. More...
 
const Evaluation & porosity () const
 Returns the average porosity within the control volume. More...
 
const DimMatrix & intrinsicPermeability () const
 Returns the intrinsic permeability tensor a degree of freedom. More...
 
const Evaluation & relativePermeability (unsigned phaseIdx) const
 Returns the relative permeability of a given phase within the control volume. More...
 
const Evaluation & mobility (unsigned phaseIdx) const
 Returns the effective mobility of a given phase within the control volume. More...
 

Detailed Description

template<class TypeTag>
class Opm::RichardsIntensiveQuantities< TypeTag >

Intensive quantities required by the Richards model.

Member Typedef Documentation

◆ FluidState

template<class TypeTag >
using Opm::RichardsIntensiveQuantities< TypeTag >::FluidState = Opm::ImmiscibleFluidState<Evaluation, FluidSystem>

The type returned by the fluidState() method.

Constructor & Destructor Documentation

◆ RichardsIntensiveQuantities() [1/2]

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

◆ RichardsIntensiveQuantities() [2/2]

template<class TypeTag >
Opm::RichardsIntensiveQuantities< TypeTag >::RichardsIntensiveQuantities ( const RichardsIntensiveQuantities< TypeTag > &  other)
default

Member Function Documentation

◆ fluidState()

template<class TypeTag >
const FluidState & Opm::RichardsIntensiveQuantities< TypeTag >::fluidState ( ) const
inline

Returns the phase state for the control-volume.

◆ intrinsicPermeability()

template<class TypeTag >
const DimMatrix & Opm::RichardsIntensiveQuantities< TypeTag >::intrinsicPermeability ( ) const
inline

Returns the intrinsic permeability tensor a degree of freedom.

◆ mobility()

template<class TypeTag >
const Evaluation & Opm::RichardsIntensiveQuantities< TypeTag >::mobility ( unsigned  phaseIdx) const
inline

Returns the effective mobility of a given phase within the control volume.

Parameters
phaseIdxThe index of the fluid phase of interest.

◆ operator=()

template<class TypeTag >
RichardsIntensiveQuantities & Opm::RichardsIntensiveQuantities< TypeTag >::operator= ( const RichardsIntensiveQuantities< TypeTag > &  other)
default

◆ porosity()

template<class TypeTag >
const Evaluation & Opm::RichardsIntensiveQuantities< TypeTag >::porosity ( ) const
inline

Returns the average porosity within the control volume.

◆ relativePermeability()

template<class TypeTag >
const Evaluation & Opm::RichardsIntensiveQuantities< TypeTag >::relativePermeability ( unsigned  phaseIdx) const
inline

Returns the relative permeability of a given phase within the control volume.

Parameters
phaseIdxThe index of the fluid phase of interest.

◆ update()

template<class TypeTag >
void Opm::RichardsIntensiveQuantities< TypeTag >::update ( const ElementContext &  elemCtx,
unsigned  dofIdx,
unsigned  timeIdx 
)
inline


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