version 3.8
Public Types | Public Member Functions | List of all members
Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa > Class Template Reference

#include <dumux/porousmediumflow/fluxvariablescache.hh>

Inheritance diagram for Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >:

Description

template<class TypeTag>
class Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >

Specialization of the flux variables cache for the cell centered finite volume mpfa scheme. Stores data which is commonly used by all the different types of processes.

Public Types

using Scalar = GetPropType< TypeTag, Properties::Scalar >
 export type used for scalar values More...
 

Public Member Functions

bool isUpdated () const
 Returns whether or not this cache has been updated. More...
 
template<bool doSecondary = considerSecondary, std::enable_if_t<!doSecondary, int > = 0>
constexpr bool usesSecondaryIv () const
 
template<bool doSecondary = considerSecondary, std::enable_if_t< doSecondary, int > = 0>
bool usesSecondaryIv () const
 
GridIndexType ivIndexInContainer () const
 Returns the index of the iv (this scvf is embedded in) in its container. More...
 
unsigned int ivLocalFaceIndex () const
 Returns interaction volume-local face index. More...
 
unsigned int indexInOutsideFaces () const
 Returns index of the face among "outside" faces of iv-local "positive" face. More...
 
void setUpdateStatus (bool status)
 Sets the update status. When set to true, consecutive updates will be skipped. More...
 
void setSecondaryIvUsage (bool status)
 Sets if this cache is associated with a secondary iv. More...
 
void setIvIndexInContainer (GridIndexType ivIndex)
 Sets the index of the iv (this scvf is embedded in) in its container. More...
 
void setIvLocalFaceIndex (unsigned int idx)
 Sets the iv-local face index. More...
 
void setIndexInOutsideFaces (unsigned int idx)
 Sets the index of the face among the "positive" face's outside scvfs. More...
 

Member Typedef Documentation

◆ Scalar

template<class TypeTag >
using Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::Scalar = GetPropType<TypeTag, Properties::Scalar>

Member Function Documentation

◆ indexInOutsideFaces()

template<class TypeTag >
unsigned int Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::indexInOutsideFaces ( ) const
inline

◆ isUpdated()

template<class TypeTag >
bool Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::isUpdated ( ) const
inline

◆ ivIndexInContainer()

template<class TypeTag >
GridIndexType Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::ivIndexInContainer ( ) const
inline

◆ ivLocalFaceIndex()

template<class TypeTag >
unsigned int Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::ivLocalFaceIndex ( ) const
inline

◆ setIndexInOutsideFaces()

template<class TypeTag >
void Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::setIndexInOutsideFaces ( unsigned int  idx)
inline

◆ setIvIndexInContainer()

template<class TypeTag >
void Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::setIvIndexInContainer ( GridIndexType  ivIndex)
inline

◆ setIvLocalFaceIndex()

template<class TypeTag >
void Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::setIvLocalFaceIndex ( unsigned int  idx)
inline

◆ setSecondaryIvUsage()

template<class TypeTag >
void Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::setSecondaryIvUsage ( bool  status)
inline

◆ setUpdateStatus()

template<class TypeTag >
void Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::setUpdateStatus ( bool  status)
inline

◆ usesSecondaryIv() [1/2]

template<class TypeTag >
template<bool doSecondary = considerSecondary, std::enable_if_t<!doSecondary, int > = 0>
constexpr bool Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::usesSecondaryIv ( ) const
inlineconstexpr

Returns whether or not this cache is associated with a secondary interaction volume Specialization for deactivated secondary interaction volumes

◆ usesSecondaryIv() [2/2]

template<class TypeTag >
template<bool doSecondary = considerSecondary, std::enable_if_t< doSecondary, int > = 0>
bool Dumux::PorousMediumFluxVariablesCacheImplementation< TypeTag, DiscretizationMethods::CCMpfa >::usesSecondaryIv ( ) const
inline

Returns whether or not this cache is associated with a secondary interaction volume Specialization for activated secondary interaction volumes

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