Contains the quantities which are are constant within a finite volume (the pore body) in the two-phase model. More...

#include <dumux/porenetwork/2p/volumevariables.hh>

Inheritance diagram for Dumux::PoreNetwork::TwoPVolumeVariables< Traits >:

Description

template<class Traits>
class Dumux::PoreNetwork::TwoPVolumeVariables< Traits >

Contains the quantities which are are constant within a finite volume (the pore body) in the two-phase model.

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

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

using	SolidState = typename Traits::SolidState
	Export type of solid state. More...

using	SolidSystem = typename Traits::SolidSystem
	Export type of solid system. More...

using	Indices = typename ModelTraits::Indices
	Export the indices. 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...

Scalar	poreInscribedRadius () const
	Returns the pore's inscribed radius. More...

Scalar	poreVolume () const
	Returns the pore volume. // TODO should this be a fraction only? More...

Scalar	surfaceTension () const
	Returns the surface tension. 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 (int phaseIdx) const
	Returns the saturation of a given phase within the control volume in \([-]\). More...

Scalar	density (int phaseIdx) const
	Returns the mass density of a given phase within the control volume in \([kg/m^3]\). More...

Scalar	pressure (int phaseIdx) const
	Returns the effective pressure of a given phase within the control volume in \([kg/(m*s^2)=N/m^2=Pa]\). More...

Scalar	capillaryPressure () const
	Returns the capillary pressure within the control volume in \([kg/(m*s^2)=N/m^2=Pa]\). More...

Scalar	temperature () const
	Returns temperature inside the sub-control volume in \([K]\). More...

Scalar	viscosity (int phaseIdx) const
	Returns the dynamic viscosity of the fluid within the control volume in \(\mathrm{[Pa s]}\). More...

Scalar	mobility (int phaseIdx) const
	Returns the effective mobility of a given phase within the control volume in \([s*m/kg]\). More...

Scalar	porosity () const
	Returns the average porosity within the control volume in \([-]\). More...

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

int	wettingPhase () const
	Returns the wetting phase index. 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
Scalar	poreInscribedRadius_

Scalar	poreVolume_

Scalar	surfaceTension_

FluidState	fluidState_

SolidState	solidState_

Member Typedef Documentation

◆ FluidState

template<class Traits >

using Dumux::PoreNetwork::TwoPVolumeVariables< Traits >::FluidState = typename Traits::FluidState

Export type of fluid state.

◆ FluidSystem

template<class Traits >

using Dumux::PoreNetwork::TwoPVolumeVariables< Traits >::FluidSystem = typename Traits::FluidSystem

Export type of fluid system.

◆ Indices

template<class Traits >

using Dumux::PoreNetwork::TwoPVolumeVariables< 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.

◆ SolidState

template<class Traits >

using Dumux::PoreNetwork::TwoPVolumeVariables< Traits >::SolidState = typename Traits::SolidState

Export type of solid state.

◆ SolidSystem

template<class Traits >

using Dumux::PoreNetwork::TwoPVolumeVariables< Traits >::SolidSystem = typename Traits::SolidSystem

Export type of solid system.

Member Function Documentation

◆ capillaryPressure()

template<class Traits >

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

inlineinherited

Returns the capillary pressure within the control volume in \([kg/(m*s^2)=N/m^2=Pa]\).

◆ completeFluidState()

template<class Traits >

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

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

inlineinherited

Sets complete fluid state.

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::TwoPVolumeVariables< Traits >::density ( int phaseIdx ) const

inlineinherited

Returns the mass density of a given phase within the control volume in \([kg/m^3]\).

Parameters

phaseIdx The 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::TwoPVolumeVariables< Traits >::fluidState ( ) const

inlineinherited

Returns the phase state for the control volume.

◆ mobility()

template<class Traits >

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

inlineinherited

Returns the effective mobility of a given phase within the control volume in \([s*m/kg]\).

Parameters

phaseIdx The phase 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.

◆ permeability()

template<class Traits >

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

inlineinherited

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

◆ poreInscribedRadius()

template<class Traits >

Scalar Dumux::PoreNetwork::TwoPVolumeVariables< Traits >::poreInscribedRadius ( ) const

inline

Returns the pore's inscribed radius.

◆ poreVolume()

template<class Traits >

Scalar Dumux::PoreNetwork::TwoPVolumeVariables< Traits >::poreVolume ( ) const

inline

Returns the pore volume. // TODO should this be a fraction only?

◆ porosity()

template<class Traits >

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

inlineinherited

Returns the average porosity within the control volume in \([-]\).

◆ pressure()

template<class Traits >

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

inlineinherited

Returns the effective pressure of a given phase within the control volume in \([kg/(m*s^2)=N/m^2=Pa]\).

Parameters

phaseIdx The phase index

◆ priVar()

template<class Traits >

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

inlineinherited

Returns a component of primary variable vector.

Parameters

pvIdx The 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::TwoPVolumeVariables< Traits >::saturation ( int phaseIdx ) const

inlineinherited

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

Parameters

phaseIdx The phase index

◆ solidState()

template<class Traits >

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

inlineinherited

Returns the phase state for the control volume.

◆ surfaceTension()

template<class Traits >

Scalar Dumux::PoreNetwork::TwoPVolumeVariables< Traits >::surfaceTension ( ) const

inline

Returns the surface tension.

◆ temperature()

template<class Traits >

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

inlineinherited

Returns temperature inside the sub-control volume in \([K]\).

Note that we assume thermodynamic equilibrium, i.e. the temperature 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::PoreNetwork::TwoPVolumeVariables< Traits >::update	(	const ElemSol &	elemSol,
		const Problem &	problem,
		const Element &	element,
		const Scv &	scv
	)

inline

Updates all quantities for a given control volume.

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

◆ viscosity()

template<class Traits >

Scalar Dumux::TwoPVolumeVariables< Traits >::viscosity ( int phaseIdx ) const

inlineinherited

Returns the dynamic viscosity of the fluid within the control volume in \(\mathrm{[Pa s]}\).

Parameters

phaseIdx The phase index

◆ wettingPhase()

template<class Traits >

int Dumux::TwoPVolumeVariables< Traits >::wettingPhase ( ) const

inlineinherited

Returns the wetting phase index.

Member Data Documentation

◆ fluidState_

template<class Traits >

FluidState Dumux::TwoPVolumeVariables< Traits >::fluidState_

protectedinherited

◆ poreInscribedRadius_

template<class Traits >

Scalar Dumux::PoreNetwork::TwoPVolumeVariables< Traits >::poreInscribedRadius_

protected

◆ poreVolume_

template<class Traits >

Scalar Dumux::PoreNetwork::TwoPVolumeVariables< Traits >::poreVolume_

protected

◆ solidState_

template<class Traits >

SolidState Dumux::TwoPVolumeVariables< Traits >::solidState_

protectedinherited

◆ surfaceTension_

template<class Traits >

Scalar Dumux::PoreNetwork::TwoPVolumeVariables< Traits >::surfaceTension_

protected

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

porenetwork/2p/volumevariables.hh

Description

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()

◆ poreInscribedRadius()

◆ poreVolume()

◆ porosity()

◆ pressure()

◆ priVar()

◆ priVars()

◆ saturation()

◆ solidState()

◆ surfaceTension()

◆ temperature()

◆ update()

◆ viscosity()

◆ wettingPhase()

Member Data Documentation

◆ fluidState_

◆ poreInscribedRadius_

◆ poreVolume_

◆ solidState_

◆ surfaceTension_