3.2-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
Dumux::NonEquilibriumGridVariables< TypeTag > Class Template Reference
Porous-Medium Flow Models » NonEquilibrium

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

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

Inheritance diagram for Dumux::NonEquilibriumGridVariables< TypeTag >:
Inheritance graph

Description

template<class TypeTag>
class Dumux::NonEquilibriumGridVariables< TypeTag >

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

Public Types

using GridGeometry
 export type of the finite volume grid geometry
using GridVolumeVariables
 export type of the finite volume grid geometry
using VolumeVariables
 export type of the volume variables
using PrimaryVariables
 export primary variable type
using Scalar
 export scalar type (TODO get it directly from the volvars)
using GridFluxVariablesCache
 export type of the finite volume grid geometry

Public Member Functions

template<class Problem>
 NonEquilibriumGridVariables (std::shared_ptr< Problem > problem, std::shared_ptr< const GridGeometry > gridGeometry)
 Constructor.
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.
void init (const SolutionVector &curSol)
 initialize all variables (stationary case)
void update (const SolutionVector &curSol, bool forceFluxCacheUpdate=false)
 update all variables
void updateAfterGridAdaption (const SolutionVector &curSol)
 update all variables after grid adaption
void advanceTimeStep ()
 Sets the current state as the previous for next time step.
void resetTimeStep (const SolutionVector &solution)
 resets state to the one before time integration
const GridFluxVariablesCache & gridFluxVarsCache () const
 return the flux variables cache
GridFluxVariablesCache & gridFluxVarsCache ()
 return the flux variables cache
const GridVolumeVariables & curGridVolVars () const
 return the current volume variables
GridVolumeVariables & curGridVolVars ()
 return the current volume variables
const GridVolumeVariables & prevGridVolVars () const
 return the volume variables of the previous time step (for instationary problems)
GridVolumeVariables & prevGridVolVars ()
 return the volume variables of the previous time step (for instationary problems)
const GridGeometry & gridGeometry () const
 return the finite volume grid geometry

Protected Attributes

std::shared_ptr< const GridGeometry > gridGeometry_
 pointer to the constant grid geometry

Member Typedef Documentation

◆ GridFluxVariablesCache

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

export type of the finite volume grid geometry

◆ GridGeometry

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

export type of the finite volume grid geometry

◆ GridVolumeVariables

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

export type of the finite volume grid geometry

◆ PrimaryVariables

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

export primary variable type

◆ Scalar

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

export scalar type (TODO get it directly from the volvars)

◆ VolumeVariables

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

export type of the volume variables

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

Constructor.

Member Function Documentation

◆ advanceTimeStep()

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

Sets the current state as the previous for next time step.

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

return the current volume variables

◆ curGridVolVars() [2/2]

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

return the current volume variables

◆ gridFluxVarsCache() [1/2]

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

return the flux variables cache

◆ gridFluxVarsCache() [2/2]

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

return the flux variables cache

◆ gridGeometry()

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

return the finite volume grid geometry

◆ init()

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

initialize all variables (stationary case)

◆ prevGridVolVars() [1/2]

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

return the volume variables of the previous time step (for instationary problems)

◆ prevGridVolVars() [2/2]

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

return the volume variables of the previous time step (for instationary problems)

◆ resetTimeStep()

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

resets state to the one before time integration

◆ update()

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

update all variables

◆ updateAfterGridAdaption()

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

update all variables after grid adaption

◆ volumeDarcyMagVelocity()

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

Access to the averaged (magnitude of) velocity for each vertex.

Parameters
phaseIdxThe index of the fluid phase
dofIdxGlobalThe 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

pointer to the constant grid geometry

The documentation for this class was generated from the following file:
Generated by doxygen 1.16.1