DuMuX: Dumux::StaggeredGridVariablesView< ActualGridVariables > Class Template Reference

3.2-git

DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media

Loading...

Searching...

No Matches

Base class for cell center of face specific auxiliary GridVariables classes. Provides a common interface and a pointer to the actual grid variables. More...

#include <dumux/discretization/staggered/gridvariables.hh>

Inheritance diagram for Dumux::StaggeredGridVariablesView< ActualGridVariables >:

Inheritance graph

Description

template<class ActualGridVariables>
class Dumux::StaggeredGridVariablesView< ActualGridVariables >

Base class for cell center of face specific auxiliary GridVariables classes. Provides a common interface and a pointer to the actual grid variables.

Public Types
using	GridVolumeVariables = typename ActualGridVariables::GridVolumeVariables
using	GridFaceVariables = typename ActualGridVariables::GridFaceVariables
using	GridFluxVariablesCache = typename ActualGridVariables::GridFluxVariablesCache
using	VolumeVariables = typename GridVolumeVariables::VolumeVariables
	export type of the volume variables
using	PrimaryVariables = typename VolumeVariables::PrimaryVariables
	export primary variable type
using	GridGeometry = typename ActualGridVariables::GridGeometry

Public Member Functions
	StaggeredGridVariablesView (ActualGridVariables *gridVariables)
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 GridFaceVariables &	curGridFaceVars () const
	return the current face variables
const GridFaceVariables &	prevGridFaceVars () const
	return the previous face variables
GridFaceVariables &	curGridFaceVars ()
	return the current face variables
GridFaceVariables &	prevGridFaceVars ()
	return the previous face variables
const GridGeometry &	gridGeometry () const
	return the fv grid geometry
const ActualGridVariables &	gridVariables () const
ActualGridVariables &	gridVariables ()

Protected Attributes
ActualGridVariables *	gridVariables_

Member Typedef Documentation

◆ GridFaceVariables

template<class ActualGridVariables>

using Dumux::StaggeredGridVariablesView< ActualGridVariables >::GridFaceVariables = typename ActualGridVariables::GridFaceVariables

◆ GridFluxVariablesCache

template<class ActualGridVariables>

using Dumux::StaggeredGridVariablesView< ActualGridVariables >::GridFluxVariablesCache = typename ActualGridVariables::GridFluxVariablesCache

◆ GridGeometry

template<class ActualGridVariables>

using Dumux::StaggeredGridVariablesView< ActualGridVariables >::GridGeometry = typename ActualGridVariables::GridGeometry

◆ GridVolumeVariables

template<class ActualGridVariables>

using Dumux::StaggeredGridVariablesView< ActualGridVariables >::GridVolumeVariables = typename ActualGridVariables::GridVolumeVariables

◆ PrimaryVariables

template<class ActualGridVariables>

using Dumux::StaggeredGridVariablesView< ActualGridVariables >::PrimaryVariables = typename VolumeVariables::PrimaryVariables

export primary variable type

◆ VolumeVariables

template<class ActualGridVariables>

using Dumux::StaggeredGridVariablesView< ActualGridVariables >::VolumeVariables = typename GridVolumeVariables::VolumeVariables

export type of the volume variables

Constructor & Destructor Documentation

◆ StaggeredGridVariablesView()

template<class ActualGridVariables>

Dumux::StaggeredGridVariablesView< ActualGridVariables >::StaggeredGridVariablesView ( ActualGridVariables * gridVariables )

inlineexplicit

Member Function Documentation

◆ curGridFaceVars() [1/2]

template<class ActualGridVariables>

GridFaceVariables & Dumux::StaggeredGridVariablesView< ActualGridVariables >::curGridFaceVars ( )

inline

return the current face variables

◆ curGridFaceVars() [2/2]

template<class ActualGridVariables>

const GridFaceVariables & Dumux::StaggeredGridVariablesView< ActualGridVariables >::curGridFaceVars ( ) const

inline

return the current face variables

◆ curGridVolVars() [1/2]

template<class ActualGridVariables>

GridVolumeVariables & Dumux::StaggeredGridVariablesView< ActualGridVariables >::curGridVolVars ( )

inline

return the current volume variables

◆ curGridVolVars() [2/2]

template<class ActualGridVariables>

const GridVolumeVariables & Dumux::StaggeredGridVariablesView< ActualGridVariables >::curGridVolVars ( ) const

inline

return the current volume variables

◆ gridFluxVarsCache() [1/2]

template<class ActualGridVariables>

GridFluxVariablesCache & Dumux::StaggeredGridVariablesView< ActualGridVariables >::gridFluxVarsCache ( )

inline

return the flux variables cache

◆ gridFluxVarsCache() [2/2]

template<class ActualGridVariables>

const GridFluxVariablesCache & Dumux::StaggeredGridVariablesView< ActualGridVariables >::gridFluxVarsCache ( ) const

inline

return the flux variables cache

◆ gridGeometry()

template<class ActualGridVariables>

const GridGeometry & Dumux::StaggeredGridVariablesView< ActualGridVariables >::gridGeometry ( ) const

inline

return the fv grid geometry

◆ gridVariables() [1/2]

template<class ActualGridVariables>

ActualGridVariables & Dumux::StaggeredGridVariablesView< ActualGridVariables >::gridVariables ( )

inline

◆ gridVariables() [2/2]

template<class ActualGridVariables>

const ActualGridVariables & Dumux::StaggeredGridVariablesView< ActualGridVariables >::gridVariables ( ) const

inline

◆ prevGridFaceVars() [1/2]

template<class ActualGridVariables>

GridFaceVariables & Dumux::StaggeredGridVariablesView< ActualGridVariables >::prevGridFaceVars ( )

inline

return the previous face variables

◆ prevGridFaceVars() [2/2]

template<class ActualGridVariables>

const GridFaceVariables & Dumux::StaggeredGridVariablesView< ActualGridVariables >::prevGridFaceVars ( ) const

inline

return the previous face variables

◆ prevGridVolVars() [1/2]

template<class ActualGridVariables>

GridVolumeVariables & Dumux::StaggeredGridVariablesView< ActualGridVariables >::prevGridVolVars ( )

inline

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

◆ prevGridVolVars() [2/2]

template<class ActualGridVariables>

const GridVolumeVariables & Dumux::StaggeredGridVariablesView< ActualGridVariables >::prevGridVolVars ( ) const

inline

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

Member Data Documentation

◆ gridVariables_

template<class ActualGridVariables>

ActualGridVariables* Dumux::StaggeredGridVariablesView< ActualGridVariables >::gridVariables_

protected

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

discretization/staggered/gridvariables.hh