This class stores the velocities which are used to compute Reynolds numbers for the source terms of non-equilibrium models.

#include <dumux/porousmediumflow/nonequilibrium/gridvariables.hh>

Inheritance diagram for Dumux::NonEquilibriumGridVariables< TypeTag >:

Public Types
using	GridGeometry = GetPropType< TypeTag, Properties::GridGeometry >
	export type of the finite volume grid geometry More...

using	GridVolumeVariables = GetPropType< TypeTag, Properties::GridVolumeVariables >
	export type of the finite volume grid geometry More...

using	VolumeVariables = typename GridVolumeVariables::VolumeVariables
	export type of the volume variables More...

using	PrimaryVariables = typename VolumeVariables::PrimaryVariables
	export primary variable type More...

using	Scalar = std::decay_t< decltype(std::declval< PrimaryVariables >()[0])>
	export scalar type (TODO get it directly from the volvars) More...

using	GridFluxVariablesCache = GetPropType< TypeTag, Properties::GridFluxVariablesCache >
	export type of the finite volume grid geometry More...

Public Member Functions
template<class Problem >
	NonEquilibriumGridVariables (std::shared_ptr< Problem > problem, std::shared_ptr< const GridGeometry > gridGeometry)
	Constructor. More...

template<class SolutionVector >
void	calcVelocityAverage (const SolutionVector &curSol)

const Scalar	volumeDarcyMagVelocity (const unsigned int phaseIdx, const unsigned int dofIdxGlobal) const
	Access to the averaged (magnitude of) velocity for each vertex. More...

void	init (const SolutionVector &curSol)
	initialize all variables (stationary case) More...

void	update (const SolutionVector &curSol, bool forceFluxCacheUpdate=false)
	update all variables More...

void	updateAfterGridAdaption (const SolutionVector &curSol)
	update all variables after grid adaption More...

void	advanceTimeStep ()
	Sets the current state as the previous for next time step. More...

void	resetTimeStep (const SolutionVector &solution)
	resets state to the one before time integration More...

const GridFluxVariablesCache &	gridFluxVarsCache () const
	return the flux variables cache More...

GridFluxVariablesCache &	gridFluxVarsCache ()
	return the flux variables cache More...

const GridVolumeVariables &	curGridVolVars () const
	return the current volume variables More...

GridVolumeVariables &	curGridVolVars ()
	return the current volume variables More...

const GridVolumeVariables &	prevGridVolVars () const
	return the volume variables of the previous time step (for instationary problems) More...

GridVolumeVariables &	prevGridVolVars ()
	return the volume variables of the previous time step (for instationary problems) More...

const GridGeometry &	gridGeometry () const
	return the finite volume grid geometry More...

Protected Attributes
std::shared_ptr< const GridGeometry >	gridGeometry_
	pointer to the constant grid geometry More...

Member Typedef Documentation

◆ GridFluxVariablesCache

using Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::GridFluxVariablesCache = GetPropType< TypeTag, Properties::GridFluxVariablesCache >

inherited

◆ GridGeometry

using Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::GridGeometry = GetPropType< TypeTag, Properties::GridGeometry >

inherited

◆ GridVolumeVariables

using Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::GridVolumeVariables = GetPropType< TypeTag, Properties::GridVolumeVariables >

inherited

◆ PrimaryVariables

using Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::PrimaryVariables = typename VolumeVariables::PrimaryVariables

inherited

◆ Scalar

using Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::Scalar = std::decay_t<decltype(std::declval<PrimaryVariables>()[0])>

inherited

◆ VolumeVariables

using Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::VolumeVariables = typename GridVolumeVariables::VolumeVariables

inherited

Constructor & Destructor Documentation

◆ NonEquilibriumGridVariables()

template<class TypeTag >

template<class Problem >

Dumux::NonEquilibriumGridVariables< TypeTag >::NonEquilibriumGridVariables	(	std::shared_ptr< Problem >	problem,
		std::shared_ptr< const GridGeometry >	gridGeometry
	)

inline

Member Function Documentation

◆ advanceTimeStep()

void Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::advanceTimeStep ( )

inlineinherited

Note: this has to be called at the end of each time step

◆ calcVelocityAverage()

template<class TypeTag >

template<class SolutionVector >

void Dumux::NonEquilibriumGridVariables< TypeTag >::calcVelocityAverage ( const SolutionVector & curSol )

inline

◆ curGridVolVars() [1/2]

GridVolumeVariables & Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::curGridVolVars ( )

inlineinherited

◆ curGridVolVars() [2/2]

const GridVolumeVariables & Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::curGridVolVars ( ) const

inlineinherited

◆ gridFluxVarsCache() [1/2]

GridFluxVariablesCache & Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::gridFluxVarsCache ( )

inlineinherited

◆ gridFluxVarsCache() [2/2]

const GridFluxVariablesCache & Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::gridFluxVarsCache ( ) const

inlineinherited

◆ gridGeometry()

const GridGeometry & Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::gridGeometry ( ) const

inlineinherited

◆ init()

void Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::init ( const SolutionVector & curSol )

inlineinherited

◆ prevGridVolVars() [1/2]

GridVolumeVariables & Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::prevGridVolVars ( )

inlineinherited

◆ prevGridVolVars() [2/2]

const GridVolumeVariables & Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::prevGridVolVars ( ) const

inlineinherited

◆ resetTimeStep()

void Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::resetTimeStep ( const SolutionVector & solution )

inlineinherited

◆ update()

void Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::update	(	const SolutionVector &	curSol,
		bool	forceFluxCacheUpdate = `false`
	)

inlineinherited

◆ updateAfterGridAdaption()

void Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::updateAfterGridAdaption ( const SolutionVector & curSol )

inlineinherited

◆ volumeDarcyMagVelocity()

template<class TypeTag >

const Scalar Dumux::NonEquilibriumGridVariables< TypeTag >::volumeDarcyMagVelocity	(	const unsigned int	phaseIdx,
		const unsigned int	dofIdxGlobal
	)		const

inline

Parameters

phaseIdx	The index of the fluid phase
dofIdxGlobal	The global index of the degree of freedom

Member Data Documentation

◆ gridGeometry_

std::shared_ptr<const GridGeometry> Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry > , GetPropType< TypeTag, Properties::GridVolumeVariables > , GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::gridGeometry_

protectedinherited

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

porousmediumflow/nonequilibrium/gridvariables.hh

Public Types

Public Member Functions

Protected Attributes

Member Typedef Documentation

◆ GridFluxVariablesCache

◆ GridGeometry

◆ GridVolumeVariables

◆ PrimaryVariables

◆ Scalar

◆ VolumeVariables

Constructor & Destructor Documentation

◆ NonEquilibriumGridVariables()

Member Function Documentation

◆ advanceTimeStep()

◆ calcVelocityAverage()

◆ curGridVolVars() [1/2]

◆ curGridVolVars() [2/2]

◆ gridFluxVarsCache() [1/2]

◆ gridFluxVarsCache() [2/2]

◆ gridGeometry()

◆ init()

◆ prevGridVolVars() [1/2]

◆ prevGridVolVars() [2/2]

◆ resetTimeStep()

◆ update()

◆ updateAfterGridAdaption()

◆ volumeDarcyMagVelocity()

Member Data Documentation

◆ gridGeometry_