3.5-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Dumux::ThreePWaterOilVolumeVariables< Traits > Class Template Reference

Contains the quantities which are are constant within a finite volume in the three-phase, two-component model. More...

#include <dumux/porousmediumflow/3pwateroil/volumevariables.hh>

Inheritance diagram for Dumux::ThreePWaterOilVolumeVariables< Traits >:

Description

template<class Traits>
class Dumux::ThreePWaterOilVolumeVariables< Traits >

Contains the quantities which are are constant within a finite volume in the three-phase, two-component model.

Public Types

using FluidState = typename Traits::FluidState
 The type of the object returned by the fluidState() method. More...
 
using FluidSystem = typename Traits::FluidSystem
 The type of the fluid system. More...
 
using Indices = typename ModelTraits::Indices
 Export the indices. More...
 
using SolidState = typename Traits::SolidState
 Export type of solid state. More...
 
using SolidSystem = typename Traits::SolidSystem
 Export type of solid system. More...
 
using PrimaryVariableSwitch = ThreePWaterOilPrimaryVariableSwitch
 Export the primary variable switch. More...
 
using PrimaryVariables = typename Traits::PrimaryVariables
 Export the type used for the primary variables. More...
 

Public Member Functions

template<class ElemSol , class Problem , class Element , class Scv >
void update (const ElemSol &elemSol, const Problem &problem, const Element &element, const Scv &scv)
 Updates all quantities for a given control volume. More...
 
const FluidStatefluidState () const
 Returns the phase state for the control-volume. More...
 
const SolidStatesolidState () const
 Returns the phase state for the control volume. More...
 
Scalar averageMolarMass (int phaseIdx) const
 Returns the average molar mass \(\mathrm{[kg/mol]}\) of the fluid phase. More...
 
Scalar saturation (const int phaseIdx) const
 Returns the effective saturation of a given phase within the control volume. More...
 
Scalar massFraction (const int phaseIdx, const int compIdx) const
 Returns the mass fraction of a given component in a given phase within the control volume in \([-]\). More...
 
Scalar moleFraction (const int phaseIdx, const int compIdx) const
 Returns the mole fraction of a given component in a given phase within the control volume in \([-]\). More...
 
Scalar density (const int phaseIdx) const
 Returns the mass density of a given phase within the control volume. More...
 
Scalar molarDensity (const int phaseIdx) const
 Returns the molar density of a given phase within the control volume. More...
 
Scalar pressure (const int phaseIdx) const
 Returns the effective pressure of a given phase within the control volume. More...
 
Scalar temperature () const
 Returns temperature inside the sub-control volume. More...
 
Scalar mobility (const int phaseIdx) const
 Returns the effective mobility of a given phase within the control volume. More...
 
Scalar viscosity (const int phaseIdx) const
 
Scalar capillaryPressure () const
 Returns the effective capillary pressure within the control volume. More...
 
Scalar porosity () const
 Returns the average porosity within the control volume. More...
 
Scalar permeability () const
 Returns the permeability within the control volume. More...
 
Scalar diffusionCoefficient (int phaseIdx, int compIIdx, int compJIdx) const
 
Scalar effectiveDiffusionCoefficient (int phaseIdx, int compIIdx, int compJIdx) const
 Returns the effective diffusion coefficients for a phase in \([m^2/s]\). More...
 
Scalar bulkDensTimesAdsorpCoeff () const
 Returns the adsorption information. More...
 
Scalar internalEnergy (int phaseIdx) const
 Returns the total internal energy of a phase in the sub-control volume. More...
 
Scalar enthalpy (int phaseIdx) const
 Returns the total enthalpy of a phase in the sub-control volume. More...
 
const PrimaryVariablespriVars () const
 Returns the vector of primary variables. More...
 
Scalar priVar (const int pvIdx) const
 Returns a component of primary variable vector. More...
 
Scalar extrusionFactor () const
 Returns how much the sub-control volume is extruded. More...
 

Static Public Member Functions

static constexpr bool onlyGasPhaseCanDisappear ()
 State if only the gas phase is allowed to disappear. More...
 
static constexpr int numFluidPhases ()
 Return number of phases considered by the model. More...
 
static constexpr int numFluidComponents ()
 Return number of components considered by the model. More...
 

Protected Attributes

FluidState fluidState_
 
SolidState solidState_
 

Member Typedef Documentation

◆ FluidState

template<class Traits >
using Dumux::ThreePWaterOilVolumeVariables< Traits >::FluidState = typename Traits::FluidState

The type of the object returned by the fluidState() method.

◆ FluidSystem

template<class Traits >
using Dumux::ThreePWaterOilVolumeVariables< Traits >::FluidSystem = typename Traits::FluidSystem

The type of the fluid system.

◆ Indices

template<class Traits >
using Dumux::ThreePWaterOilVolumeVariables< Traits >::Indices = typename ModelTraits::Indices

Export the indices.

◆ PrimaryVariables

template<class Traits >
using Dumux::PorousMediumFlowVolumeVariables< Traits >::PrimaryVariables = typename Traits::PrimaryVariables
inherited

Export the type used for the primary variables.

◆ PrimaryVariableSwitch

template<class Traits >
using Dumux::ThreePWaterOilVolumeVariables< Traits >::PrimaryVariableSwitch = ThreePWaterOilPrimaryVariableSwitch

Export the primary variable switch.

◆ SolidState

template<class Traits >
using Dumux::ThreePWaterOilVolumeVariables< Traits >::SolidState = typename Traits::SolidState

Export type of solid state.

◆ SolidSystem

template<class Traits >
using Dumux::ThreePWaterOilVolumeVariables< Traits >::SolidSystem = typename Traits::SolidSystem

Export type of solid system.

Member Function Documentation

◆ averageMolarMass()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::averageMolarMass ( int  phaseIdx) const
inline

Returns the average molar mass \(\mathrm{[kg/mol]}\) of the fluid phase.

Parameters
phaseIdxThe phase index

◆ bulkDensTimesAdsorpCoeff()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::bulkDensTimesAdsorpCoeff ( ) const
inline

Returns the adsorption information.

◆ capillaryPressure()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::capillaryPressure ( ) const
inline

Returns the effective capillary pressure within the control volume.

◆ density()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::density ( const int  phaseIdx) const
inline

Returns the mass density of a given phase within the control volume.

Parameters
phaseIdxThe phase index

◆ diffusionCoefficient()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::diffusionCoefficient ( int  phaseIdx,
int  compIIdx,
int  compJIdx 
) const
inline

◆ effectiveDiffusionCoefficient()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::effectiveDiffusionCoefficient ( int  phaseIdx,
int  compIIdx,
int  compJIdx 
) const
inline

Returns the effective diffusion coefficients for a phase in \([m^2/s]\).

◆ enthalpy()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::enthalpy ( int  phaseIdx) const
inline

Returns the total enthalpy of a phase in the sub-control volume.

Parameters
phaseIdxThe phase index

◆ extrusionFactor()

template<class Traits >
Scalar Dumux::PorousMediumFlowVolumeVariables< Traits >::extrusionFactor ( ) const
inlineinherited

Returns how much the sub-control volume is extruded.

This means the factor by which a lower-dimensional (1D or 2D) entity needs to be expanded to get a full dimensional cell. The default is 1.0 which means that 1D problems are actually thought as pipes with a cross section of 1 m^2 and 2D problems are assumed to extend 1 m to the back.

◆ fluidState()

template<class Traits >
const FluidState & Dumux::ThreePWaterOilVolumeVariables< Traits >::fluidState ( ) const
inline

Returns the phase state for the control-volume.

◆ internalEnergy()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::internalEnergy ( int  phaseIdx) const
inline

Returns the total internal energy of a phase in the sub-control volume.

Parameters
phaseIdxThe phase index

◆ massFraction()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::massFraction ( const int  phaseIdx,
const int  compIdx 
) const
inline

Returns the mass fraction of a given component in a given phase within the control volume in \([-]\).

Parameters
phaseIdxThe phase index
compIdxThe component index

◆ mobility()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::mobility ( const int  phaseIdx) const
inline

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

Parameters
phaseIdxThe phase index

◆ molarDensity()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::molarDensity ( const int  phaseIdx) const
inline

Returns the molar density of a given phase within the control volume.

Parameters
phaseIdxThe phase index

◆ moleFraction()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::moleFraction ( const int  phaseIdx,
const int  compIdx 
) const
inline

Returns the mole fraction of a given component in a given phase within the control volume in \([-]\).

Parameters
phaseIdxThe phase index
compIdxThe component index

◆ numFluidComponents()

template<class Traits >
static constexpr int Dumux::PorousMediumFlowVolumeVariables< Traits >::numFluidComponents ( )
inlinestaticconstexprinherited

Return number of components considered by the model.

◆ numFluidPhases()

template<class Traits >
static constexpr int Dumux::PorousMediumFlowVolumeVariables< Traits >::numFluidPhases ( )
inlinestaticconstexprinherited

Return number of phases considered by the model.

◆ onlyGasPhaseCanDisappear()

template<class Traits >
static constexpr bool Dumux::ThreePWaterOilVolumeVariables< Traits >::onlyGasPhaseCanDisappear ( )
inlinestaticconstexpr

State if only the gas phase is allowed to disappear.

◆ permeability()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::permeability ( ) const
inline

Returns the permeability within the control volume.

◆ porosity()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::porosity ( ) const
inline

Returns the average porosity within the control volume.

◆ pressure()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::pressure ( const int  phaseIdx) const
inline

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

Parameters
phaseIdxThe phase index

◆ priVar()

template<class Traits >
Scalar Dumux::PorousMediumFlowVolumeVariables< Traits >::priVar ( const int  pvIdx) const
inlineinherited

Returns a component of primary variable vector.

Parameters
pvIdxThe index of the primary variable of interest

◆ priVars()

template<class Traits >
const PrimaryVariables & Dumux::PorousMediumFlowVolumeVariables< Traits >::priVars ( ) const
inlineinherited

Returns the vector of primary variables.

◆ saturation()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::saturation ( const int  phaseIdx) const
inline

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

Parameters
phaseIdxThe phase index

◆ solidState()

template<class Traits >
const SolidState & Dumux::ThreePWaterOilVolumeVariables< Traits >::solidState ( ) const
inline

Returns the phase state for the control volume.

◆ temperature()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::temperature ( ) const
inline

Returns temperature inside the sub-control volume.

Note that we assume thermodynamic equilibrium, i.e. the temperatures of the rock matrix and of all fluid phases are identical.

◆ update()

template<class Traits >
template<class ElemSol , class Problem , class Element , class Scv >
void Dumux::ThreePWaterOilVolumeVariables< Traits >::update ( const ElemSol &  elemSol,
const Problem &  problem,
const Element &  element,
const Scv &  scv 
)
inline

Updates all quantities for a given control volume.

Parameters
elemSolA vector containing all primary variables connected to the element
problemThe object specifying the problem which ought to be simulated
elementAn element which contains part of the control volume
scvThe sub control volume

◆ viscosity()

template<class Traits >
Scalar Dumux::ThreePWaterOilVolumeVariables< Traits >::viscosity ( const int  phaseIdx) const
inline

Member Data Documentation

◆ fluidState_

template<class Traits >
FluidState Dumux::ThreePWaterOilVolumeVariables< Traits >::fluidState_
protected

◆ solidState_

template<class Traits >
SolidState Dumux::ThreePWaterOilVolumeVariables< Traits >::solidState_
protected

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