Volume variables for the single-phase, multi-component free-flow model. More...

#include <dumux/freeflow/compositional/volumevariables.hh>

Inheritance diagram for Dumux::FreeflowNCVolumeVariables< Traits >:

Description

template<class Traits>
class Dumux::FreeflowNCVolumeVariables< Traits >

Volume variables for the single-phase, multi-component free-flow model.

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

Public Member Functions
template<class ElementSolution , class Problem , class Element , class SubControlVolume >
void	update (const ElementSolution &elemSol, const Problem &problem, const Element &element, const SubControlVolume &scv)
	Update all quantities for a given control volume. More...

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

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

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

Scalar	effectiveViscosity () const
	Return the effective dynamic viscosity \(\mathrm{[Pa s]}\) of the fluid within the control volume. More...

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

Scalar	massFraction (int phaseIdx, int compIdx) const
	Returns the mass fraction of a component in the phase \(\mathrm{[-]}\). More...

Scalar	massFraction (int compIdx) const
	Returns the mass fraction of a component in the phase \(\mathrm{[-]}\). More...

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

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

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

Scalar	molarMass (int compIdx) const
	Returns the molar mass of a given component. More...

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

Scalar	diffusionCoefficient (int compIIdx, int compJIdx=0) const
	Returns the diffusion coefficient \(\mathrm{[m^2/s]}\). More...

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

Scalar	effectiveDiffusivity (int compIIdx, int compJIdx=0) const
	Returns the effective diffusion coefficient \(\mathrm{[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...

const FluidState &	fluidState () const
	Return the fluid state of the control volume. More...

Static Public Member Functions
template<class ElementSolution , class Problem , class Element , class SubControlVolume >
static void	completeFluidState (const ElementSolution &elemSol, const Problem &problem, const Element &element, const SubControlVolume &scv, FluidState &fluidState)
	Update the fluid state. More...

Protected Attributes
FluidState	fluidState_

DiffusionCoefficients	diffCoefficient_

Member Typedef Documentation

◆ FluidState

template<class Traits >

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

export the fluid state type

◆ FluidSystem

template<class Traits >

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

export the underlying fluid system

◆ Indices

template<class Traits >

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

export the indices type

Member Function Documentation

◆ averageMolarMass()

template<class Traits >

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

inline

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

Parameters

phaseIdx The phase index

◆ completeFluidState()

template<class Traits >

template<class ElementSolution , class Problem , class Element , class SubControlVolume >

static void Dumux::FreeflowNCVolumeVariables< Traits >::completeFluidState	(	const ElementSolution &	elemSol,
		const Problem &	problem,
		const Element &	element,
		const SubControlVolume &	scv,
		FluidState &	fluidState
	)

inlinestatic

Update the fluid state.

◆ density()

template<class Traits >

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

inline

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

◆ diffusionCoefficient() [1/2]

template<class Traits >

Scalar Dumux::FreeflowNCVolumeVariables< Traits >::diffusionCoefficient	(	int	compIIdx,
		int	compJIdx = `0`
	)		const

inline

Returns the diffusion coefficient \(\mathrm{[m^2/s]}\).

Parameters

compIIdx	the index of the component which diffusive
compJIdx	the index of the component with respect to which compIIdx diffuses

◆ diffusionCoefficient() [2/2]

template<class Traits >

Scalar Dumux::FreeflowNCVolumeVariables< Traits >::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::FreeflowNCVolumeVariables< Traits >::effectiveDiffusionCoefficient	(	int	phaseIdx,
		int	compIIdx,
		int	compJIdx
	)		const

inline

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

◆ effectiveDiffusivity()

template<class Traits >

Scalar Dumux::FreeflowNCVolumeVariables< Traits >::effectiveDiffusivity	(	int	compIIdx,
		int	compJIdx = `0`
	)		const

inline

Returns the effective diffusion coefficient \(\mathrm{[m^2/s]}\).

Parameters

compIIdx	the index of the component which diffusive
compJIdx	the index of the component with respect to which compIIdx diffuses

◆ effectiveViscosity()

template<class Traits >

Scalar Dumux::FreeflowNCVolumeVariables< Traits >::effectiveViscosity ( ) const

inline

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

◆ fluidState()

template<class Traits >

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

inline

Return the fluid state of the control volume.

◆ massFraction() [1/2]

template<class Traits >

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

inline

Returns the mass fraction of a component in the phase \(\mathrm{[-]}\).

Parameters

compIdx the index of the component

◆ massFraction() [2/2]

template<class Traits >

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

inline

Returns the mass fraction of a component in the phase \(\mathrm{[-]}\).

Parameters

phaseIdx	the index of the phase
compIdx	the index of the component

◆ molarDensity()

template<class Traits >

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

inline

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

◆ molarMass()

template<class Traits >

Scalar Dumux::FreeflowNCVolumeVariables< Traits >::molarMass ( int compIdx ) const

inline

Returns the molar mass of a given component.

Parameters

compIdx the index of the component

◆ moleFraction() [1/2]

template<class Traits >

Scalar Dumux::FreeflowNCVolumeVariables< Traits >::moleFraction ( int compIdx ) const

inline

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

Parameters

compIdx the index of the component

◆ moleFraction() [2/2]

template<class Traits >

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

inline

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

Parameters

phaseIdx	the index of the phase
compIdx	the index of the component

◆ pressure()

template<class Traits >

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

inline

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

◆ temperature()

template<class Traits >

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

inline

Return 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 ElementSolution , class Problem , class Element , class SubControlVolume >

void Dumux::FreeflowNCVolumeVariables< Traits >::update	(	const ElementSolution &	elemSol,
		const Problem &	problem,
		const Element &	element,
		const SubControlVolume &	scv
	)

inline

Update 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::FreeflowNCVolumeVariables< Traits >::viscosity ( int phaseIdx = 0 ) const

inline

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

Member Data Documentation

◆ diffCoefficient_

template<class Traits >

DiffusionCoefficients Dumux::FreeflowNCVolumeVariables< Traits >::diffCoefficient_

protected

◆ fluidState_

template<class Traits >

FluidState Dumux::FreeflowNCVolumeVariables< Traits >::fluidState_

protected

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

freeflow/compositional/volumevariables.hh

Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Member Typedef Documentation

◆ FluidState

◆ FluidSystem

◆ Indices

Member Function Documentation

◆ averageMolarMass()

◆ completeFluidState()

◆ density()

◆ diffusionCoefficient() [1/2]

◆ diffusionCoefficient() [2/2]

◆ effectiveDiffusionCoefficient()

◆ effectiveDiffusivity()

◆ effectiveViscosity()

◆ fluidState()

◆ massFraction() [1/2]

◆ massFraction() [2/2]

◆ molarDensity()

◆ molarMass()

◆ moleFraction() [1/2]

◆ moleFraction() [2/2]

◆ pressure()

◆ temperature()

◆ update()

◆ viscosity()

Member Data Documentation

◆ diffCoefficient_

◆ fluidState_