The volume variables (i.e. secondary variables) for the two-phase one-component model. More...

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

Inheritance diagram for Dumux::TwoPOneCVolumeVariables< Traits >:

Description

template<class Traits>
class Dumux::TwoPOneCVolumeVariables< Traits >

The volume variables (i.e. secondary variables) for the two-phase one-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 Traits::ModelTraits::Indices
	The type of 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 = TwoPOneCPrimaryVariableSwitch
	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...

template<class ElemSol , class Problem , class Element , class Scv >
void	updateTemperature (const ElemSol &elemSol, const Problem &problem, const Element &element, const Scv &scv, FluidState &fluidState, SolidState &solidState)

const FluidState &	fluidState () const
	Returns the fluid state for 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 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	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 int phaseIdx=0) 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 in \([kg/(m*s^2)=N/m^2=Pa]\). More...

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

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

Scalar	vaporTemperature () const
	Returns the vapor temperature \(T_{vap}(p_n)\) of the fluid within the control volume. 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 TwoPFormulation	priVarFormulation ()
	Return the two-phase formulation used here. 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::TwoPOneCVolumeVariables< Traits >::FluidState = typename Traits::FluidState

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

◆ FluidSystem

template<class Traits >

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

The type of the fluid system.

◆ Indices

template<class Traits >

using Dumux::TwoPOneCVolumeVariables< Traits >::Indices = typename Traits::ModelTraits::Indices

The type of 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::TwoPOneCVolumeVariables< Traits >::PrimaryVariableSwitch = TwoPOneCPrimaryVariableSwitch

Export the primary variable switch.

◆ SolidState

template<class Traits >

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

Export type of solid state.

◆ SolidSystem

template<class Traits >

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

Export type of solid system.

Member Function Documentation

◆ averageMolarMass()

template<class Traits >

Scalar Dumux::TwoPOneCVolumeVariables< Traits >::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 >

Scalar Dumux::TwoPOneCVolumeVariables< Traits >::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 >

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

void Dumux::TwoPOneCVolumeVariables< Traits >::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

◆ density()

template<class Traits >

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

inline

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

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

inline

Returns the fluid state for the control-volume.

◆ mobility()

template<class Traits >

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

inline

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

Parameters

phaseIdx The phase index

◆ molarDensity()

template<class Traits >

Scalar Dumux::TwoPOneCVolumeVariables< Traits >::molarDensity ( const int phaseIdx ) const

inline

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

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.

◆ permeability()

template<class Traits >

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

inline

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

◆ porosity()

template<class Traits >

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

inline

Returns the average porosity within the control volume.

◆ pressure()

template<class Traits >

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

inline

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

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 >

static constexpr TwoPFormulation Dumux::TwoPOneCVolumeVariables< Traits >::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.

◆ saturation()

template<class Traits >

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

inline

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

Parameters

phaseIdx The phase index

◆ solidState()

template<class Traits >

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

inline

Returns the phase state for the control volume.

◆ temperature()

template<class Traits >

Scalar Dumux::TwoPOneCVolumeVariables< Traits >::temperature ( const int phaseIdx = 0 ) 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::TwoPOneCVolumeVariables< 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

◆ updateTemperature()

template<class Traits >

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

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

inline

Depending on the phase state, the fluid temperature is either obtained as a primary variable from the solution vector or calculated from the liquid's vapor pressure.

◆ vaporTemperature()

template<class Traits >

Scalar Dumux::TwoPOneCVolumeVariables< Traits >::vaporTemperature ( ) const

inline

Returns the vapor temperature \(T_{vap}(p_n)\) of the fluid within the control volume.

◆ wettingPhase()

template<class Traits >

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

inline

Returns the wetting phase index.

Member Data Documentation

◆ fluidState_

template<class Traits >

FluidState Dumux::TwoPOneCVolumeVariables< Traits >::fluidState_

protected

◆ solidState_

template<class Traits >

SolidState Dumux::TwoPOneCVolumeVariables< Traits >::solidState_

protected

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

porousmediumflow/2p1c/volumevariables.hh

Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Member Typedef Documentation

◆ FluidState

◆ FluidSystem

◆ Indices

◆ PrimaryVariables

◆ PrimaryVariableSwitch

◆ SolidState

◆ SolidSystem

Member Function Documentation

◆ averageMolarMass()

◆ capillaryPressure()

◆ completeFluidState()

◆ density()

◆ extrusionFactor()

◆ fluidState()

◆ mobility()

◆ molarDensity()

◆ numFluidComponents()

◆ permeability()

◆ porosity()

◆ pressure()

◆ priVar()

◆ priVarFormulation()

◆ priVars()

◆ saturation()

◆ solidState()

◆ temperature()

◆ update()

◆ updateTemperature()

◆ vaporTemperature()

◆ wettingPhase()

Member Data Documentation

◆ fluidState_

◆ solidState_