version 3.9.0
Loading...
Searching...
No Matches
Dumux::NonEquilibriumGridVariables< TypeTag > Class Template Reference

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
 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 GridFluxVariablesCachegridFluxVarsCache () const
 return the flux variables cache
 
GridFluxVariablesCachegridFluxVarsCache ()
 return the flux variables cache
 
const GridVolumeVariablescurGridVolVars () const
 return the current volume variables
 
GridVolumeVariablescurGridVolVars ()
 return the current volume variables
 
const GridVolumeVariablesprevGridVolVars () const
 return the volume variables of the previous time step (for instationary problems)
 
GridVolumeVariablesprevGridVolVars ()
 return the volume variables of the previous time step (for instationary problems)
 
const GridGeometrygridGeometry () const
 return the finite volume grid geometry
 

Protected Attributes

std::shared_ptr< const GridGeometrygridGeometry_
 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

◆ GridGeometry

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

◆ GridVolumeVariables

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

◆ PrimaryVariables

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

◆ Scalar

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

◆ VolumeVariables

using Dumux::FVGridVariables< GetPropType< TypeTag, Properties::GridGeometry >, GetPropType< TypeTag, Properties::GridVolumeVariables >, GetPropType< TypeTag, Properties::GridFluxVariablesCache > >::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
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

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