Dumux::CCMpfaDualGridNodalIndexSet< T > Class Template Reference

Nodal index set for mpfa schemes, constructed around grid vertices. More...

#include <dumux/discretization/cellcentered/mpfa/dualgridindexset.hh>

Description

template<class T>
class Dumux::CCMpfaDualGridNodalIndexSet< T >

Template Parameters

T	The traits class to be used

Public Types
using	Traits = T
	Export the traits type. More...
using	LocalIndexType = LI
	Export the index types used. More...
using	GridIndexType = GI
using	NodalGridStencilType = typename T::template NodalScvDataStorage< GI >
	Export the stencil types used. More...
using	NodalLocalStencilType = typename T::template NodalScvDataStorage< LI >
using	NodalGridScvfStencilType = typename T::template NodalScvfDataStorage< GI >
using	ScvfNeighborLocalIndexSet = typename T::template ScvfNeighborDataStorage< LI >
	Data structure to store the neighboring scv indices of an scvf (grid/local indices) More...

Public Member Functions
	CCMpfaDualGridNodalIndexSet ()
	Constructor. More...
template<typename SubControlVolumeFace >
void	insert (const SubControlVolumeFace &scvf)
	Inserts data for a given scvf. More...
void	insert (const GridIndexType scvfIdx, const GridIndexType insideScvIdx, const bool boundary)
	Inserts scvf data. More...
std::size_t	numScvs () const
	returns the number of scvs around the node More...
std::size_t	numScvfs () const
	returns the number of scvfs around the node More...
std::size_t	numBoundaryScvfs () const
	returns the number of boundary scvfs around the node More...
const NodalGridStencilType &	gridScvIndices () const
	returns the grid scv indices connected to this dual grid node More...
const NodalGridScvfStencilType &	gridScvfIndices () const
	returns the grid scvf indices connected to this dual grid node More...
bool	scvfIsOnBoundary (unsigned int i) const
	returns whether or not the i-th scvf is on a domain boundary More...
GridIndexType	gridScvIndex (unsigned int i) const
	returns the grid scv idx of the i-th scv More...
GridIndexType	gridScvfIndex (unsigned int i) const
	returns the index of the i-th scvf More...
GridIndexType	gridScvfIndex (unsigned int i, unsigned int j) const
	returns the grid index of the j-th scvf embedded in the i-th scv More...
LocalIndexType	localScvfIndex (unsigned int i, unsigned int j) const
	returns the node-local index of the j-th scvf embedded in the i-th scv More...
LocalIndexType	insideScvLocalIndex (unsigned int i) const
	returns the node-local index of the inside scv of the i-th scvf More...

Member Typedef Documentation

GridIndexType

template<class T >

using Dumux::CCMpfaDualGridNodalIndexSet< T >::GridIndexType = GI

LocalIndexType

template<class T >

using Dumux::CCMpfaDualGridNodalIndexSet< T >::LocalIndexType = LI

NodalGridScvfStencilType

template<class T >

using Dumux::CCMpfaDualGridNodalIndexSet< T >::NodalGridScvfStencilType = typename T::template NodalScvfDataStorage< GI >

NodalGridStencilType

template<class T >

using Dumux::CCMpfaDualGridNodalIndexSet< T >::NodalGridStencilType = typename T::template NodalScvDataStorage< GI >

NodalLocalStencilType

template<class T >

using Dumux::CCMpfaDualGridNodalIndexSet< T >::NodalLocalStencilType = typename T::template NodalScvDataStorage< LI >

ScvfNeighborLocalIndexSet

template<class T >

using Dumux::CCMpfaDualGridNodalIndexSet< T >::ScvfNeighborLocalIndexSet = typename T::template ScvfNeighborDataStorage< LI >

Traits

template<class T >

using Dumux::CCMpfaDualGridNodalIndexSet< T >::Traits = T

Constructor & Destructor Documentation

CCMpfaDualGridNodalIndexSet()

template<class T >

Dumux::CCMpfaDualGridNodalIndexSet< T >::CCMpfaDualGridNodalIndexSet ( )

inline

Member Function Documentation

gridScvfIndex() [1/2]

template<class T >

GridIndexType Dumux::CCMpfaDualGridNodalIndexSet< T >::gridScvfIndex ( unsigned int  i ) const

inline

gridScvfIndex() [2/2]

template<class T >

GridIndexType Dumux::CCMpfaDualGridNodalIndexSet< T >::gridScvfIndex ( unsigned int  i, unsigned int  j  ) const

inline

gridScvfIndices()

template<class T >

const NodalGridScvfStencilType & Dumux::CCMpfaDualGridNodalIndexSet< T >::gridScvfIndices ( ) const

inline

gridScvIndex()

template<class T >

GridIndexType Dumux::CCMpfaDualGridNodalIndexSet< T >::gridScvIndex ( unsigned int  i ) const

inline

gridScvIndices()

template<class T >

const NodalGridStencilType & Dumux::CCMpfaDualGridNodalIndexSet< T >::gridScvIndices ( ) const

inline

insert() [1/2]

template<class T >

void Dumux::CCMpfaDualGridNodalIndexSet< T >::insert ( const GridIndexType  scvfIdx, const GridIndexType  insideScvIdx, const bool  boundary  )

inline

insert() [2/2]

template<class T >

template<typename SubControlVolumeFace >

void Dumux::CCMpfaDualGridNodalIndexSet< T >::insert ( const SubControlVolumeFace &  scvf )

inline

insideScvLocalIndex()

template<class T >

LocalIndexType Dumux::CCMpfaDualGridNodalIndexSet< T >::insideScvLocalIndex ( unsigned int  i ) const

inline

localScvfIndex()

template<class T >

LocalIndexType Dumux::CCMpfaDualGridNodalIndexSet< T >::localScvfIndex ( unsigned int  i, unsigned int  j  ) const

inline

numBoundaryScvfs()

template<class T >

std::size_t Dumux::CCMpfaDualGridNodalIndexSet< T >::numBoundaryScvfs ( ) const

inline

numScvfs()

template<class T >

std::size_t Dumux::CCMpfaDualGridNodalIndexSet< T >::numScvfs ( ) const

inline

numScvs()

template<class T >

std::size_t Dumux::CCMpfaDualGridNodalIndexSet< T >::numScvs ( ) const

inline

scvfIsOnBoundary()

template<class T >

bool Dumux::CCMpfaDualGridNodalIndexSet< T >::scvfIsOnBoundary ( unsigned int  i ) const

inline

---

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

• dualgridindexset.hh