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

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

Inheritance diagram for Dumux::ThreePVolumeVariables< Traits >:

Public Types
using	FluidState = typename Traits::FluidState
	Export fluid state type. More...

using	FluidSystem = typename Traits::FluidSystem
	Export fluid system type. More...

using	Indices = Idx
	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	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...

template<class ElemSol , class Problem , class Element , class Scv >
void	completeFluidState (const ElemSol &elemSol, const Problem &problem, const Element &element, const Scv &scv, FluidState &fluidState, SolidState &solidState)
	Sets complete fluid state. More...

const FluidState &	fluidState () const
	Returns the phase state for the control-volume. More...

const SolidState &	solidState () const
	Returns the phase state for the control volume. More...

Scalar	saturation (const int phaseIdx) const
	Returns the effective saturation of a given phase within the control volume. More...

Scalar	density (const int phaseIdx) const
	Returns the mass 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	capillaryPressure () const
	Returns the effective capillary pressure within the control volume. More...

Scalar	porosity () const
	Returns the average porosity within the control volume. More...

const PermeabilityType &	permeability () const
	Returns the permeability within the control volume in \([m^2]\). More...

const PrimaryVariables &	priVars () 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 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::ThreePVolumeVariables< Traits >::FluidState = typename Traits::FluidState

◆ FluidSystem

template<class Traits >

using Dumux::ThreePVolumeVariables< Traits >::FluidSystem = typename Traits::FluidSystem

◆ Indices

template<class Traits >

using Dumux::ThreePVolumeVariables< Traits >::Indices = Idx

◆ PrimaryVariables

template<class Traits >

using Dumux::PorousMediumFlowVolumeVariables< Traits >::PrimaryVariables = typename Traits::PrimaryVariables

inherited

◆ SolidState

template<class Traits >

using Dumux::ThreePVolumeVariables< Traits >::SolidState = typename Traits::SolidState

◆ SolidSystem

template<class Traits >

using Dumux::ThreePVolumeVariables< Traits >::SolidSystem = typename Traits::SolidSystem

Member Function Documentation

◆ capillaryPressure()

template<class Traits >

Scalar Dumux::ThreePVolumeVariables< Traits >::capillaryPressure ( ) const

inline

◆ completeFluidState()

template<class Traits >

template<class ElemSol , class Problem , class Element , class Scv >

void Dumux::ThreePVolumeVariables< Traits >::completeFluidState	(	const ElemSol &	elemSol,
		const Problem &	problem,
		const Element &	element,
		const Scv &	scv,
		FluidState &	fluidState,
		SolidState &	solidState
	)

inline

Parameters

elemSol	A vector containing all primary variables connected to the element
problem	The object specifying the problem which ought to be simulated
element	An element which contains part of the control volume
scv	The sub-control volume
fluidState	A container with the current (physical) state of the fluid
solidState	A container with the current (physical) state of the solid

Set temperature, saturations, capillary pressures, viscosities, densities and enthalpies.

◆ density()

template<class Traits >

Scalar Dumux::ThreePVolumeVariables< Traits >::density ( const int phaseIdx ) const

inline

Parameters

phaseIdx The phase index

◆ extrusionFactor()

template<class Traits >

Scalar Dumux::PorousMediumFlowVolumeVariables< Traits >::extrusionFactor ( ) const

inlineinherited

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::ThreePVolumeVariables< Traits >::fluidState ( ) const

inline

◆ mobility()

template<class Traits >

Scalar Dumux::ThreePVolumeVariables< Traits >::mobility ( const int phaseIdx ) const

inline

Parameters

phaseIdx The phase index

◆ numFluidComponents()

template<class Traits >

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

inlinestaticconstexprinherited

◆ numFluidPhases()

template<class Traits >

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

inlinestaticconstexprinherited

◆ permeability()

template<class Traits >

const PermeabilityType & Dumux::ThreePVolumeVariables< Traits >::permeability ( ) const

inline

◆ porosity()

template<class Traits >

Scalar Dumux::ThreePVolumeVariables< Traits >::porosity ( ) const

inline

◆ pressure()

template<class Traits >

Scalar Dumux::ThreePVolumeVariables< Traits >::pressure ( const int phaseIdx ) const

inline

Parameters

phaseIdx The phase index

◆ priVar()

template<class Traits >

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

inlineinherited

Parameters

pvIdx The index of the primary variable of interest

◆ priVars()

template<class Traits >

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

inlineinherited

◆ saturation()

template<class Traits >

Scalar Dumux::ThreePVolumeVariables< Traits >::saturation ( const int phaseIdx ) const

inline

Parameters

phaseIdx The phase index

◆ solidState()

template<class Traits >

const SolidState & Dumux::ThreePVolumeVariables< Traits >::solidState ( ) const

inline

◆ temperature()

template<class Traits >

Scalar Dumux::ThreePVolumeVariables< Traits >::temperature ( ) const

inline

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::ThreePVolumeVariables< Traits >::update	(	const ElemSol &	elemSol,
		const Problem &	problem,
		const Element &	element,
		const Scv &	scv
	)

inline

Parameters

elemSol	A vector containing all primary variables connected to the element
problem	The object specifying the problem which ought to be simulated
element	An element which contains part of the control volume
scv	The sub control volume

Member Data Documentation

◆ fluidState_

template<class Traits >

FluidState Dumux::ThreePVolumeVariables< Traits >::fluidState_

protected

◆ solidState_

template<class Traits >

SolidState Dumux::ThreePVolumeVariables< Traits >::solidState_

protected

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

porousmediumflow/3p/volumevariables.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Member Typedef Documentation

◆ FluidState

◆ FluidSystem

◆ Indices

◆ PrimaryVariables

◆ SolidState

◆ SolidSystem

Member Function Documentation

◆ capillaryPressure()

◆ completeFluidState()

◆ density()

◆ extrusionFactor()

◆ fluidState()

◆ mobility()

◆ numFluidComponents()

◆ numFluidPhases()

◆ permeability()

◆ porosity()

◆ pressure()

◆ priVar()

◆ priVars()

◆ saturation()

◆ solidState()

◆ temperature()

◆ update()

Member Data Documentation

◆ fluidState_

◆ solidState_