#include <dumux/porousmediumflow/mpnc/volumevariables.hh>

Inheritance diagram for Dumux::MPNCVolumeVariablesImplementation< Traits, false >:

Public Types
using	Indices = typename Traits::ModelTraits::Indices
	Export the type encapsulating primary variable indices. More...

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

using	FluidState = typename Traits::FluidState
	Export the fluid state type. 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...

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	saturation (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	molarity (const int phaseIdx, int compIdx) const
	Returns the concentration \(\mathrm{[mol/m^3]}\) of a component in the phase. More...

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

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

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

Scalar	temperature () const
	Returns the temperature inside the sub-control volume. More...

Scalar	temperature (const int phaseIdx) const

Scalar	enthalpy (const int phaseIdx) const
	Return enthalpy \(\mathrm{[kg/m^3]}\) the of the fluid phase. More...

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

Scalar	fluidThermalConductivity (const int phaseIdx) const
	Returns the thermal conductivity \(\mathrm{[W/(m*K)]}\) of a fluid phase in the sub-control volume. More...

Scalar	fugacity (const int compIdx) const
	Returns the fugacity \(\mathrm{[kg/m^3]}\) the of the component. More...

Scalar	averageMolarMass (const int phaseIdx) const
	Returns the average molar mass \(\mathrm{[kg/m^3]}\) the of the phase. More...

Scalar	mobility (const unsigned int phaseIdx) const
	Returns the effective mobility of a given phase within the control volume. More...

Scalar	viscosity (const unsigned int phaseIdx) const
	Returns the viscosity of a given phase within the control volume. More...

Scalar	relativePermeability (const unsigned int phaseIdx) const
	Returns the relative permeability of a given phase within the control volume. More...

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

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

bool	isPhaseActive (const unsigned int phaseIdx) const
	Returns true if the fluid state is in the active set for a phase,. 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	phaseNcp (const unsigned int phaseIdx) const
	Returns the value of the NCP-function for a phase. More...

Scalar	phasePresentIneq (const FluidState &fluidState, const unsigned int phaseIdx) const
	Returns the value of the inequality where a phase is present. More...

Scalar	phaseNotPresentIneq (const FluidState &fluidState, const unsigned int phaseIdx) const
	Returns the value of the inequality where a phase is not present. 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...

Static Public Attributes
static constexpr int	numFluidComps = ParentType::numFluidComponents()
	Return number of components considered by the model. More...

Protected Attributes
Scalar	porosity_
	Effective porosity within the control volume. More...

std::array< Scalar, ModelTraits::numFluidPhases()>	relativePermeability_
	Effective relative permeability within the control volume. More...

PermeabilityType	permeability_

FluidState	fluidState_
	Mass fractions of each component within each phase. More...

SolidState	solidState_

DiffusionCoefficients	effectiveDiffCoeff_

Member Typedef Documentation

◆ FluidState

template<class Traits >

using Dumux::MPNCVolumeVariablesImplementation< Traits, false >::FluidState = typename Traits::FluidState

Export the fluid state type.

◆ FluidSystem

template<class Traits >

using Dumux::MPNCVolumeVariablesImplementation< Traits, false >::FluidSystem = typename Traits::FluidSystem

Export the underlying fluid system.

◆ Indices

template<class Traits >

using Dumux::MPNCVolumeVariablesImplementation< Traits, false >::Indices = typename Traits::ModelTraits::Indices

Export the type encapsulating primary variable 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::MPNCVolumeVariablesImplementation< Traits, false >::SolidState = typename Traits::SolidState

Export type of solid state.

◆ SolidSystem

template<class Traits >

using Dumux::MPNCVolumeVariablesImplementation< Traits, false >::SolidSystem = typename Traits::SolidSystem

Export type of solid system.

Member Function Documentation

◆ averageMolarMass()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::averageMolarMass ( const int phaseIdx ) const

inline

Returns the average molar mass \(\mathrm{[kg/m^3]}\) the of the phase.

◆ completeFluidState()

template<class Traits >

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

void Dumux::MPNCVolumeVariablesImplementation< Traits, false >::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::MPNCVolumeVariablesImplementation< Traits, false >::density ( const int phaseIdx ) const

inline

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

Parameters

phaseIdx The phase index

◆ diffusionCoefficient()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::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 >

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

inline

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

◆ enthalpy()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::enthalpy ( const int phaseIdx ) const

inline

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

◆ 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::MPNCVolumeVariablesImplementation< Traits, false >::fluidState ( ) const

inline

Returns the fluid configuration at the given primary variables.

◆ fluidThermalConductivity()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::fluidThermalConductivity ( const int phaseIdx ) const

inline

Returns the thermal conductivity \(\mathrm{[W/(m*K)]}\) of a fluid phase in the sub-control volume.

◆ fugacity()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::fugacity ( const int compIdx ) const

inline

Returns the fugacity \(\mathrm{[kg/m^3]}\) the of the component.

◆ internalEnergy()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::internalEnergy ( const int phaseIdx ) const

inline

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

◆ isPhaseActive()

template<class Traits >

bool Dumux::MPNCVolumeVariablesImplementation< Traits, false >::isPhaseActive ( const unsigned int phaseIdx ) const

inline

Returns true if the fluid state is in the active set for a phase,.

Parameters

phaseIdx The local index of the phases

◆ massFraction()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::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 >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::mobility ( const unsigned int phaseIdx ) const

inline

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

Parameters

phaseIdx The local index of the phases

◆ molarDensity()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::molarDensity ( const int phaseIdx ) const

inline

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

Parameters

phaseIdx The phase index

◆ molarity()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::molarity	(	const int	phaseIdx,
		int	compIdx
	)		const

inline

Returns the concentration \(\mathrm{[mol/m^3]}\) of a component in the phase.

Parameters

phaseIdx	The phase index
compIdx	The index of the component

◆ moleFraction()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::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::MPNCVolumeVariablesImplementation< Traits, false >::numFluidPhases ( )

inlinestaticconstexpr

Return number of phases considered by the model.

◆ permeability()

template<class Traits >

const PermeabilityType & Dumux::MPNCVolumeVariablesImplementation< Traits, false >::permeability ( ) const

inline

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

◆ phaseNcp()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::phaseNcp ( const unsigned int phaseIdx ) const

inline

Returns the value of the NCP-function for a phase.

 \param phaseIdx The local index of the phases

◆ phaseNotPresentIneq()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::phaseNotPresentIneq	(	const FluidState &	fluidState,
		const unsigned int	phaseIdx
	)		const

inline

Returns the value of the inequality where a phase is not present.

Parameters

phaseIdx	The local index of the phases
fluidState	Container for all the secondary variables concerning the fluids

◆ phasePresentIneq()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::phasePresentIneq	(	const FluidState &	fluidState,
		const unsigned int	phaseIdx
	)		const

inline

Returns the value of the inequality where a phase is present.

Parameters

phaseIdx	The local index of the phases
fluidState	Container for all the secondary variables concerning the fluids

◆ porosity()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::porosity ( ) const

inline

Returns the average porosity within the control volume.

◆ pressure()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::pressure ( const int phaseIdx ) const

inline

Returns the effective pressure \(\mathrm{[Pa]}\) 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

◆ priVars()

template<class Traits >

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

inlineinherited

Returns the vector of primary variables.

◆ relativePermeability()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::relativePermeability ( const unsigned int phaseIdx ) const

inline

Returns the relative permeability of a given phase within the control volume.

Parameters

phaseIdx The local index of the phases

◆ saturation()

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::saturation ( 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 >

const SolidState & Dumux::MPNCVolumeVariablesImplementation< Traits, false >::solidState ( ) const

inline

Returns the phase state for the control-volume.

◆ temperature() [1/2]

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::temperature ( ) const

inline

Returns the temperature 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.

◆ temperature() [2/2]

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::temperature ( const int phaseIdx ) const

inline

◆ update()

template<class Traits >

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

void Dumux::MPNCVolumeVariablesImplementation< Traits, false >::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::MPNCVolumeVariablesImplementation< Traits, false >::viscosity ( const unsigned int phaseIdx ) const

inline

Returns the viscosity of a given phase within the control volume.

Member Data Documentation

◆ effectiveDiffCoeff_

template<class Traits >

DiffusionCoefficients Dumux::MPNCVolumeVariablesImplementation< Traits, false >::effectiveDiffCoeff_

protected

◆ fluidState_

template<class Traits >

FluidState Dumux::MPNCVolumeVariablesImplementation< Traits, false >::fluidState_

protected

Mass fractions of each component within each phase.

◆ numFluidComps

template<class Traits >

constexpr int Dumux::MPNCVolumeVariablesImplementation< Traits, false >::numFluidComps = ParentType::numFluidComponents()

staticconstexpr

Return number of components considered by the model.

◆ permeability_

template<class Traits >

PermeabilityType Dumux::MPNCVolumeVariablesImplementation< Traits, false >::permeability_

protected

◆ porosity_

template<class Traits >

Scalar Dumux::MPNCVolumeVariablesImplementation< Traits, false >::porosity_

protected

Effective porosity within the control volume.

◆ relativePermeability_

template<class Traits >

std::array<Scalar, ModelTraits::numFluidPhases()> Dumux::MPNCVolumeVariablesImplementation< Traits, false >::relativePermeability_

protected

Effective relative permeability within the control volume.

◆ solidState_

template<class Traits >

SolidState Dumux::MPNCVolumeVariablesImplementation< Traits, false >::solidState_

protected

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

porousmediumflow/mpnc/volumevariables.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Member Typedef Documentation

◆ FluidState

◆ FluidSystem

◆ Indices

◆ PrimaryVariables

◆ SolidState

◆ SolidSystem

Member Function Documentation

◆ averageMolarMass()

◆ completeFluidState()

◆ density()

◆ diffusionCoefficient()

◆ effectiveDiffusionCoefficient()

◆ enthalpy()

◆ extrusionFactor()

◆ fluidState()

◆ fluidThermalConductivity()

◆ fugacity()

◆ internalEnergy()

◆ isPhaseActive()

◆ massFraction()

◆ mobility()

◆ molarDensity()

◆ molarity()

◆ moleFraction()

◆ numFluidComponents()

◆ numFluidPhases()

◆ permeability()

◆ phaseNcp()

◆ phaseNotPresentIneq()

◆ phasePresentIneq()

◆ porosity()

◆ pressure()

◆ priVar()

◆ priVars()

◆ relativePermeability()

◆ saturation()

◆ solidState()

◆ temperature() [1/2]

◆ temperature() [2/2]

◆ update()

◆ viscosity()

Member Data Documentation

◆ effectiveDiffCoeff_

◆ fluidState_

◆ numFluidComps

◆ permeability_

◆ porosity_

◆ relativePermeability_

◆ solidState_