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

#include <dumux/porenetwork/1pnc/volumevariables.hh>

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

Description

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

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

Note: The default value for the phase index given in the fluid property interfaces is not used, but is only here to enable calling these functions without handing in a phase index (as in a single-phasic context there is only one phase).

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

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

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

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...

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 fluid configuration at the given primary variables. More...

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

Scalar	averageMolarMass (int phaseIdx=0) const
	Returns the average molar mass \(\mathrm{[kg/mol]}\) of the fluid phase. More...

Scalar	density (int phaseIdx=0) const
	Returns density \(\mathrm{[kg/m^3]}\) the of the fluid phase. More...

Scalar	molarDensity (int phaseIdx=0) const
	Returns molar density \(\mathrm{[mol/m^3]}\) the of the fluid phase. More...

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

Scalar	moleFraction (int phaseIdx, int compIdx) const
	Returns the mole fraction \(\mathrm{[mol/mol]}\) of a component in the phase. More...

Scalar	massFraction (int phaseIdx, int compIdx) const
	Returns the mass fraction of a component in the phase. More...

Scalar	massFraction (int compIdx) const
	Returns the mass fraction of a component in the phase. More...

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

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

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

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

Scalar	porosity () const
	Returns the average porosity \(\mathrm{[-]}\) within the control volume. 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...

Scalar	molarity (int compIdx) const
	Returns the molarity of a component in the phase. 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 bool	useMoles ()
	Returns whether moles or masses are balanced. 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 Attributes
Scalar	poreInscribedRadius_

Scalar	poreVolume_

FluidState	fluidState_

SolidState	solidState_

Member Typedef Documentation

◆ FluidState

template<class Traits >

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

inherited

Export fluid state type.

◆ FluidSystem

template<class Traits >

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

inherited

Export fluid system type.

◆ Indices

template<class Traits >

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

inherited

Export 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::OnePNCVolumeVariables< Traits >::SolidState = typename Traits::SolidState

inherited

Export type of solid state.

◆ SolidSystem

template<class Traits >

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

inherited

Export type of solid system.

Member Function Documentation

◆ averageMolarMass()

template<class Traits >

Scalar Dumux::OnePNCVolumeVariables< Traits >::averageMolarMass ( int phaseIdx = 0 ) const

inlineinherited

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

Parameters

phaseIdx The phase index

◆ completeFluidState()

template<class Traits >

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

void Dumux::OnePNCVolumeVariables< 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

◆ density()

template<class Traits >

Scalar Dumux::OnePNCVolumeVariables< Traits >::density ( int phaseIdx = 0 ) const

inlineinherited

Returns density \(\mathrm{[kg/m^3]}\) the of the fluid phase.

Note: the phase index passed to this function is for compatibility reasons with multi-phasic models.

◆ diffusionCoefficient()

template<class Traits >

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

inlineinherited

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

◆ effectiveDiffusionCoefficient()

template<class Traits >

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

inlineinherited

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 >

const FluidState & Dumux::OnePNCVolumeVariables< Traits >::fluidState ( ) const

inlineinherited

Returns the fluid configuration at the given primary variables.

◆ massFraction() [1/2]

template<class Traits >

Scalar Dumux::OnePNCVolumeVariables< Traits >::massFraction ( int compIdx ) const

inlineinherited

Returns the mass fraction of a component in the phase.

Parameters

compIdx The index of the component

◆ massFraction() [2/2]

template<class Traits >

Scalar Dumux::OnePNCVolumeVariables< Traits >::massFraction	(	int	phaseIdx,
		int	compIdx
	)		const

inlineinherited

Returns the mass fraction of a component in the phase.

Parameters

phaseIdx	The index of the fluid phase
compIdx	The index of the component

Note: The phase index passed to this function is for compatibility reasons with multi-phasic models.

◆ mobility()

template<class Traits >

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

inlineinherited

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

The term mobility is usually not employed in the one phase context. The method is here for compatibility reasons with other models.

Note: The phase index passed to this function is for compatibility reasons with multi-phasic models.

◆ molarDensity()

template<class Traits >

Scalar Dumux::OnePNCVolumeVariables< Traits >::molarDensity ( int phaseIdx = 0 ) const

inlineinherited

Returns molar density \(\mathrm{[mol/m^3]}\) the of the fluid phase.

Note: the phase index passed to this function is for compatibility reasons with multi-phasic models.

◆ molarity()

template<class Traits >

Scalar Dumux::OnePNCVolumeVariables< Traits >::molarity ( int compIdx ) const

inlineinherited

Returns the molarity of a component in the phase.

Parameters

compIdx The index of the component

◆ moleFraction()

template<class Traits >

Scalar Dumux::OnePNCVolumeVariables< Traits >::moleFraction	(	int	phaseIdx,
		int	compIdx
	)		const

inlineinherited

Returns the mole fraction \(\mathrm{[mol/mol]}\) of a component in the phase.

Parameters

phaseIdx	The index of the fluid phase
compIdx	The index of the component

Note: The phase index passed to this function is for compatibility reasons with multi-phasic models.

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

inlineinherited

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

◆ poreInscribedRadius()

template<class Traits >

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

inline

Returns the pore's inscribed radius.

◆ poreVolume()

template<class Traits >

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

inline

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

◆ porosity()

template<class Traits >

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

inlineinherited

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

◆ pressure()

template<class Traits >

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

inlineinherited

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

Parameters

phaseIdx The phase index

Note: The phase index passed to this function is for compatibility reasons with multi-phasic models.

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

inlineinherited

Returns the saturation.

This method is here for compatibility reasons with other models. The saturation is always 1.0 in a one-phasic context.

◆ solidState()

template<class Traits >

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

inlineinherited

Returns the phase state for the control volume.

◆ temperature()

template<class Traits >

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

inlineinherited

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

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::OnePNCVolumeVariables< 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

◆ useMoles()

template<class Traits >

static constexpr bool Dumux::OnePNCVolumeVariables< Traits >::useMoles ( )

inlinestaticconstexprinherited

Returns whether moles or masses are balanced.

◆ viscosity()

template<class Traits >

Scalar Dumux::OnePNCVolumeVariables< Traits >::viscosity ( int phaseIdx = 0 ) const

inlineinherited

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

Note: The phase index passed to this function is for compatibility reasons with multi-phasic models.

Member Data Documentation

◆ fluidState_

template<class Traits >

FluidState Dumux::OnePNCVolumeVariables< Traits >::fluidState_

protectedinherited

◆ poreInscribedRadius_

template<class Traits >

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

protected

◆ poreVolume_

template<class Traits >

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

protected

◆ solidState_

template<class Traits >

SolidState Dumux::OnePNCVolumeVariables< Traits >::solidState_

protectedinherited

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

porenetwork/1pnc/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

◆ averageMolarMass()

◆ completeFluidState()

◆ density()

◆ diffusionCoefficient()

◆ effectiveDiffusionCoefficient()

◆ extrusionFactor()

◆ fluidState()

◆ massFraction() [1/2]

◆ massFraction() [2/2]

◆ mobility()

◆ molarDensity()

◆ molarity()

◆ moleFraction()

◆ numFluidComponents()

◆ numFluidPhases()

◆ permeability()

◆ poreInscribedRadius()

◆ poreVolume()

◆ porosity()

◆ pressure()

◆ priVar()

◆ priVars()

◆ saturation()

◆ solidState()

◆ temperature()

◆ update()

◆ useMoles()

◆ viscosity()

Member Data Documentation

◆ fluidState_

◆ poreInscribedRadius_

◆ poreVolume_

◆ solidState_