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

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

Inheritance diagram for Dumux::OnePVolumeVariables< Traits >:

Description

template<class Traits>
class Dumux::OnePVolumeVariables< Traits >

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

Template Parameters

Traits Class encapsulating types to be used by the vol vars

Public Types
using	FluidSystem = typename Traits::FluidSystem
	Export the underlying fluid system. More...

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

using	Indices = typename Traits::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	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...

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

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

Scalar	pressure (int phaseIdx=0) const
	Returns the effective pressure \(\mathrm{[Pa]}\) of a given phase within the control volume. More...

Scalar	saturation (int phaseIdx=0) const
	Returns the saturation. More...

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

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

Scalar	mobility (int phaseIdx=0) const
	Returns the mobility \(\mathrm{[1/(Pa s)]}\). More...

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

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

const FluidState &	fluidState () const
	Returns the fluid state of the control volume. 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_

PermeabilityType	permeability_

Member Typedef Documentation

◆ FluidState

template<class Traits >

using Dumux::OnePVolumeVariables< Traits >::FluidState = typename Traits::FluidState

Export the fluid state type.

◆ FluidSystem

template<class Traits >

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

Export the underlying fluid system.

◆ Indices

template<class Traits >

using Dumux::OnePVolumeVariables< Traits >::Indices = typename Traits::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::OnePVolumeVariables< Traits >::SolidState = typename Traits::SolidState

Export type of solid state.

◆ SolidSystem

template<class Traits >

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

Export type of solid system.

Member Function Documentation

◆ completeFluidState()

template<class Traits >

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

void Dumux::OnePVolumeVariables< 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::OnePVolumeVariables< Traits >::density ( int phaseIdx = 0 ) const

inline

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

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

inline

Returns the fluid state of the control volume.

◆ mobility()

template<class Traits >

Scalar Dumux::OnePVolumeVariables< Traits >::mobility ( int phaseIdx = 0 ) const

inline

Returns the mobility \(\mathrm{[1/(Pa s)]}\).

This function enables the use of ImplicitDarcyFluxVariables with the 1p fully implicit model, ALTHOUGH the term mobility is usually not employed in the one phase context.

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::OnePVolumeVariables< Traits >::permeability ( ) const

inline

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

◆ porosity()

template<class Traits >

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

inline

Returns the average porosity \(\mathrm{[-]}\) within the control volume.

◆ pressure()

template<class Traits >

Scalar Dumux::OnePVolumeVariables< Traits >::pressure ( int phaseIdx = 0 ) const

inline

Returns the effective pressure \(\mathrm{[Pa]}\) of a given phase within the control volume.

◆ 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::OnePVolumeVariables< Traits >::saturation ( int phaseIdx = 0 ) const

inline

Returns the saturation.

◆ solidState()

template<class Traits >

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

inline

Returns the phase state for the control volume.

◆ temperature()

template<class Traits >

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

inline

Returns the temperature \(\mathrm{[K]}\) 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::OnePVolumeVariables< 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::OnePVolumeVariables< Traits >::viscosity ( int phaseIdx = 0 ) const

inline

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

Member Data Documentation

◆ fluidState_

template<class Traits >

FluidState Dumux::OnePVolumeVariables< Traits >::fluidState_

protected

◆ permeability_

template<class Traits >

PermeabilityType Dumux::OnePVolumeVariables< Traits >::permeability_

protected

◆ solidState_

template<class Traits >

SolidState Dumux::OnePVolumeVariables< Traits >::solidState_

protected

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

porousmediumflow/1p/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

◆ completeFluidState()

◆ density()

◆ extrusionFactor()

◆ fluidState()

◆ mobility()

◆ numFluidComponents()

◆ numFluidPhases()

◆ permeability()

◆ porosity()

◆ pressure()

◆ priVar()

◆ priVars()

◆ saturation()

◆ solidState()

◆ temperature()

◆ update()

◆ viscosity()

Member Data Documentation

◆ fluidState_

◆ permeability_

◆ solidState_