3.6-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | List of all members
Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true > Class Template Reference

Class for the face variables vector. Specialization for the case of storing the face variables globally. More...

#include <dumux/discretization/facecentered/staggered/elementvolumevariables.hh>

Description

template<class GVV>
class Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >

Class for the face variables vector. Specialization for the case of storing the face variables globally.

Public Types

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

Public Member Functions

 FaceCenteredStaggeredElementVolumeVariables (const GridVolumeVariables &gridVolumeVariables)
 
const VolumeVariablesoperator[] (const SubControlVolume &scv) const
 operator for the access with an scvf More...
 
const VolumeVariablesoperator[] (const std::size_t scvIdx) const
 
template<class SolutionVector >
ThisType bind (const typename FVElementGeometry::Element &element, const FVElementGeometry &fvGeometry, const SolutionVector &sol) &&
 bind the local view (r-value overload) This overload is called when an instance of this class is a temporary in the usage context This allows a usage like this: const auto view = localView(...).bind(element); More...
 
template<class SolutionVector >
void bind (const typename FVElementGeometry::Element &element, const FVElementGeometry &fvGeometry, const SolutionVector &sol) &
 
template<class SolutionVector >
ThisType bindElement (const typename FVElementGeometry::Element &element, const FVElementGeometry &fvGeometry, const SolutionVector &sol) &&
 bind the local view (r-value overload) This overload is called when an instance of this class is a temporary in the usage context This allows a usage like this: const auto view = localView(...).bind(element); More...
 
template<class SolutionVector >
void bindElement (const typename FVElementGeometry::Element &element, const FVElementGeometry &fvGeometry, const SolutionVector &sol) &
 
const GridVolumeVariablesgridVolVars () const
 The global volume variables object we are a restriction of. More...
 
bool hasVolVars (const std::size_t scvIdx) const
 Returns true if volVars exist for the given scv index. More...
 

Member Typedef Documentation

◆ GridVolumeVariables

template<class GVV >
using Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >::GridVolumeVariables = GVV

export type of the grid volume variables

◆ VolumeVariables

template<class GVV >
using Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >::VolumeVariables = typename GridVolumeVariables::VolumeVariables

export type of the volume variables

Constructor & Destructor Documentation

◆ FaceCenteredStaggeredElementVolumeVariables()

template<class GVV >
Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >::FaceCenteredStaggeredElementVolumeVariables ( const GridVolumeVariables gridVolumeVariables)
inline

Member Function Documentation

◆ bind() [1/2]

template<class GVV >
template<class SolutionVector >
void Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >::bind ( const typename FVElementGeometry::Element &  element,
const FVElementGeometry &  fvGeometry,
const SolutionVector &  sol 
) &
inline

For compatibility reasons with the case of not storing the face vars. function to be called before assembling an element, preparing the vol vars within the stencil

◆ bind() [2/2]

template<class GVV >
template<class SolutionVector >
ThisType Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >::bind ( const typename FVElementGeometry::Element &  element,
const FVElementGeometry &  fvGeometry,
const SolutionVector &  sol 
) &&
inline

bind the local view (r-value overload) This overload is called when an instance of this class is a temporary in the usage context This allows a usage like this: const auto view = localView(...).bind(element);

◆ bindElement() [1/2]

template<class GVV >
template<class SolutionVector >
void Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >::bindElement ( const typename FVElementGeometry::Element &  element,
const FVElementGeometry &  fvGeometry,
const SolutionVector &  sol 
) &
inline

Binding of an element, prepares only the face variables of the element specialization for Staggered models

◆ bindElement() [2/2]

template<class GVV >
template<class SolutionVector >
ThisType Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >::bindElement ( const typename FVElementGeometry::Element &  element,
const FVElementGeometry &  fvGeometry,
const SolutionVector &  sol 
) &&
inline

bind the local view (r-value overload) This overload is called when an instance of this class is a temporary in the usage context This allows a usage like this: const auto view = localView(...).bind(element);

◆ gridVolVars()

template<class GVV >
const GridVolumeVariables & Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >::gridVolVars ( ) const
inline

The global volume variables object we are a restriction of.

◆ hasVolVars()

template<class GVV >
bool Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >::hasVolVars ( const std::size_t  scvIdx) const
inline

Returns true if volVars exist for the given scv index.

◆ operator[]() [1/2]

template<class GVV >
const VolumeVariables & Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >::operator[] ( const std::size_t  scvIdx) const
inline

operator for the access with an index needed for cc methods for the access to the boundary volume variables

◆ operator[]() [2/2]

template<class GVV >
const VolumeVariables & Dumux::FaceCenteredStaggeredElementVolumeVariables< GVV, true >::operator[] ( const SubControlVolume &  scv) const
inline

operator for the access with an scvf


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