Contains the quantities which are constant within a finite volume in the two-phase two-component model. This is the base class for a 2p2c model with and without chemical nonequilibrium. More...

#include <dumux/porousmediumflow/2p2c/volumevariables.hh>

Inheritance diagram for Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >:

Description

template<class Traits, class Impl>
class Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >

Contains the quantities which are constant within a finite volume in the two-phase two-component model. This is the base class for a 2p2c model with and without chemical nonequilibrium.

Public Types
using	FluidState = typename Traits::FluidState
	The type of the object returned by the fluidState() method. More...

using	FluidSystem = typename Traits::FluidSystem
	The fluid system used here. 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 = TwoPNCPrimaryVariableSwitch
	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...

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 within the control volume. More...

const SolidState &	solidState () 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 saturation of a given phase within the control volume in \([-]\). 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 in \([kg/m^3]\). More...

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

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

Scalar	pressure (const 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	temperature () const
	Returns temperature within the control volume in \([K]\). More...

Scalar	relativePermeability (const int phaseIdx) const
	Returns the relative permeability of a given phase within the control volume in \([-]\). More...

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

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

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

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

Scalar	diffusionCoefficient (int phaseIdx, int compIIdx, int compJIdx) const
	Returns the binary diffusion coefficients for a phase in \([m^2/s]\). More...

Scalar	effectiveDiffusionCoefficient (int phaseIdx, int compIIdx, int compJIdx) const
	Returns the effective diffusion coefficients for a phase in \([m^2/s]\). 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 bool	useMoles ()
	Return whether moles or masses are balanced. More...

static constexpr TwoPFormulation	priVarFormulation ()
	Return the two-phase formulation used here. 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 Member Functions
const Impl &	asImp_ () const

Impl &	asImp_ ()

Member Typedef Documentation

◆ FluidState

template<class Traits , class Impl >

using Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::FluidState = typename Traits::FluidState

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

◆ FluidSystem

template<class Traits , class Impl >

using Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::FluidSystem = typename Traits::FluidSystem

The fluid system used here.

◆ Indices

template<class Traits , class Impl >

using Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::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 , class Impl >

using Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::PrimaryVariableSwitch = TwoPNCPrimaryVariableSwitch

Export the primary variable switch.

◆ SolidState

template<class Traits , class Impl >

using Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::SolidState = typename Traits::SolidState

Export type of solid state.

◆ SolidSystem

template<class Traits , class Impl >

using Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::SolidSystem = typename Traits::SolidSystem

Export type of solid system.

Member Function Documentation

◆ asImp_() [1/2]

template<class Traits , class Impl >

Impl & Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::asImp_ ( )

inlineprotected

◆ asImp_() [2/2]

template<class Traits , class Impl >

const Impl & Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::asImp_ ( ) const

inlineprotected

◆ averageMolarMass()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::averageMolarMass ( int phaseIdx ) const

inline

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

Parameters

phaseIdx The phase index

◆ capillaryPressure()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::capillaryPressure ( ) const

inline

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

◆ completeFluidState()

template<class Traits , class Impl >

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

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

inline

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 , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::density ( const int phaseIdx ) const

inline

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

Parameters

phaseIdx The phase index

◆ diffusionCoefficient()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::diffusionCoefficient	(	int	phaseIdx,
		int	compIIdx,
		int	compJIdx
	)		const

inline

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

◆ effectiveDiffusionCoefficient()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::effectiveDiffusionCoefficient	(	int	phaseIdx,
		int	compIIdx,
		int	compJIdx
	)		const

inline

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

◆ 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 , class Impl >

const FluidState & Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::fluidState ( ) const

inline

Returns the phase state within the control volume.

◆ massFraction()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::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

phaseIdx	The phase index
compIdx	The component index

◆ mobility()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::mobility ( const int phaseIdx ) const

inline

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

Parameters

phaseIdx The phase index

◆ molarDensity()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::molarDensity ( const int phaseIdx ) const

inline

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

Parameters

phaseIdx The phase index

◆ moleFraction()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::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

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

◆ permeability()

template<class Traits , class Impl >

const PermeabilityType & Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::permeability ( ) const

inline

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

◆ porosity()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::porosity ( ) const

inline

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

◆ pressure()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::pressure ( const int phaseIdx ) const

inline

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

◆ priVarFormulation()

template<class Traits , class Impl >

static constexpr TwoPFormulation Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::priVarFormulation ( )

inlinestaticconstexpr

Return the two-phase formulation used here.

◆ priVars()

template<class Traits >

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

inlineinherited

Returns the vector of primary variables.

◆ relativePermeability()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::relativePermeability ( const int phaseIdx ) const

inline

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

Parameters

phaseIdx The phase index

◆ saturation()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::saturation ( const int phaseIdx ) const

inline

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

Parameters

phaseIdx The phase index

◆ solidState()

template<class Traits , class Impl >

const SolidState & Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::solidState ( ) const

inline

Returns the phase state for the control-volume.

◆ temperature()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::temperature ( ) const

inline

Returns temperature within the 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 , class Impl >

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

void Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::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

◆ useMoles()

template<class Traits , class Impl >

static constexpr bool Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::useMoles ( )

inlinestaticconstexpr

Return whether moles or masses are balanced.

◆ viscosity()

template<class Traits , class Impl >

Scalar Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::viscosity ( const int phaseIdx ) const

inline

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

Parameters

phaseIdx The phase index

◆ wettingPhase()

template<class Traits , class Impl >

int Dumux::TwoPTwoCVolumeVariablesBase< Traits, Impl >::wettingPhase ( ) const

inline

Returns the wetting phase index.

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

porousmediumflow/2p2c/volumevariables.hh

Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Typedef Documentation

◆ FluidState

◆ FluidSystem

◆ Indices

◆ PrimaryVariables

◆ PrimaryVariableSwitch

◆ SolidState

◆ SolidSystem

Member Function Documentation

◆ asImp_() [1/2]

◆ asImp_() [2/2]

◆ averageMolarMass()

◆ capillaryPressure()

◆ completeFluidState()

◆ density()

◆ diffusionCoefficient()

◆ effectiveDiffusionCoefficient()

◆ extrusionFactor()

◆ fluidState()

◆ massFraction()

◆ mobility()

◆ molarDensity()

◆ moleFraction()

◆ numFluidComponents()

◆ numFluidPhases()

◆ permeability()

◆ porosity()

◆ pressure()

◆ priVar()

◆ priVarFormulation()

◆ priVars()

◆ relativePermeability()

◆ saturation()

◆ solidState()

◆ temperature()

◆ update()

◆ useMoles()

◆ viscosity()

◆ wettingPhase()