3.5-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | Static Public Attributes | List of all members
Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits > Class Template Reference

Flux variables cache class for staggered models. Specialization in case of storing the flux cache. More...

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

Description

template<class P, class FVC, class FVCF, int upwindSchemeOrder, class TheTraits>
class Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >

Flux variables cache class for staggered models. Specialization in case of storing the flux cache.

Public Types

using Traits = TheTraits
 the flux var cache traits More...
 
using FluxVariablesCache = typename Traits::FluxVariablesCache
 export the flux variable cache type More...
 
using Scalar = typename FluxVariablesCache::Scalar
 
using UpwindScheme = StaggeredUpwindMethods< Scalar, upwindSchemeOrder >
 export upwind scheme More...
 
using LocalView = typename Traits::template LocalView< ThisType, cachingEnabled >
 export the type of the local view More...
 

Public Member Functions

 StaggeredGridFluxVariablesCache (const Problem &problem)
 
template<class GridGeometry , class GridVolumeVariables , class SolutionVector >
void update (const GridGeometry &gridGeometry, const GridVolumeVariables &gridVolVars, const SolutionVector &sol, bool forceUpdate=false)
 
const UpwindSchemestaggeredUpwindMethods () const
 Return the StaggeredUpwindMethods. More...
 
const Problem & problem () const
 
const FluxVariablesCacheoperator[] (std::size_t scvfIdx) const
 
FluxVariablesCacheoperator[] (std::size_t scvfIdx)
 

Static Public Attributes

static constexpr bool useHigherOrder = upwindSchemeOrder > 1
 
static constexpr bool cachingEnabled = true
 make it possible to query if caching is enabled More...
 

Member Typedef Documentation

◆ FluxVariablesCache

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
using Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::FluxVariablesCache = typename Traits::FluxVariablesCache

export the flux variable cache type

◆ LocalView

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
using Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::LocalView = typename Traits::template LocalView<ThisType, cachingEnabled>

export the type of the local view

◆ Scalar

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
using Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::Scalar = typename FluxVariablesCache::Scalar

◆ Traits

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
using Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::Traits = TheTraits

the flux var cache traits

◆ UpwindScheme

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
using Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::UpwindScheme = StaggeredUpwindMethods<Scalar, upwindSchemeOrder>

export upwind scheme

Constructor & Destructor Documentation

◆ StaggeredGridFluxVariablesCache()

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::StaggeredGridFluxVariablesCache ( const Problem &  problem)
inline

Member Function Documentation

◆ operator[]() [1/2]

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
FluxVariablesCache & Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::operator[] ( std::size_t  scvfIdx)
inline

◆ operator[]() [2/2]

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
const FluxVariablesCache & Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::operator[] ( std::size_t  scvfIdx) const
inline

◆ problem()

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
const Problem & Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::problem ( ) const
inline

◆ staggeredUpwindMethods()

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
const UpwindScheme & Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::staggeredUpwindMethods ( ) const
inline

◆ update()

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
template<class GridGeometry , class GridVolumeVariables , class SolutionVector >
void Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::update ( const GridGeometry &  gridGeometry,
const GridVolumeVariables &  gridVolVars,
const SolutionVector &  sol,
bool  forceUpdate = false 
)
inline

Member Data Documentation

◆ cachingEnabled

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
constexpr bool Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::cachingEnabled = true
staticconstexpr

make it possible to query if caching is enabled

◆ useHigherOrder

template<class P , class FVC , class FVCF , int upwindSchemeOrder, class TheTraits >
constexpr bool Dumux::StaggeredGridFluxVariablesCache< P, FVC, FVCF, true, upwindSchemeOrder, TheTraits >::useHigherOrder = upwindSchemeOrder > 1
staticconstexpr

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