geos::StencilWrapperBase< TRAITS > Class Template Reference

#include <StencilBase.hpp>

Inheritance diagram for geos::StencilWrapperBase< TRAITS >:

Public Member Functions
	StencilWrapperBase (typename TRAITS::IndexContainerType const &elementRegionIndices, typename TRAITS::IndexContainerType const &elementSubRegionIndices, typename TRAITS::IndexContainerType const &elementIndices, typename TRAITS::WeightContainerType const &weights)
	Constructor. More...
TRAITS::IndexContainerViewConstType	getElementRegionIndices () const
	Const access to the element regions indices. More...
TRAITS::IndexContainerViewConstType	getElementSubRegionIndices () const
	Const access to the element subregions indices. More...
TRAITS::IndexContainerViewConstType	getElementIndices () const
	Const access to the element indices. More...
TRAITS::WeightContainerViewConstType	getWeights () const
	Const access to the stencil weights. More...

Protected Attributes
TRAITS::IndexContainerViewConstType	m_elementRegionIndices
	The container for the element region indices for each point in each stencil.
TRAITS::IndexContainerViewConstType	m_elementSubRegionIndices
	The container for the element sub region indices for each point in each stencil.
TRAITS::IndexContainerViewConstType	m_elementIndices
	The container for the element indices for each point in each stencil.
TRAITS::WeightContainerViewType	m_weights
	The container for the weights for each point in each stencil.

Detailed Description

template<typename TRAITS>
class geos::StencilWrapperBase< TRAITS >

Class to provide access to the computation of stencil weights that may be called from a kernel function.

Definition at line 80 of file StencilBase.hpp.

Constructor & Destructor Documentation

StencilWrapperBase()

template<typename TRAITS >

geos::StencilWrapperBase< TRAITS >::StencilWrapperBase ( typename TRAITS::IndexContainerType const &  elementRegionIndices, typename TRAITS::IndexContainerType const &  elementSubRegionIndices, typename TRAITS::IndexContainerType const &  elementIndices, typename TRAITS::WeightContainerType const &  weights  )

inline

Constructor.

Parameters

elementRegionIndices	The container for the element region indices for each point in each stencil
elementSubRegionIndices	The container for the element sub region indices for each point in each stencil
elementIndices	The container for the element indices for each point in each stencil
weights	The container for the weights for each point in each stencil

Definition at line 91 of file StencilBase.hpp.

Member Function Documentation

getElementIndices()

template<typename TRAITS >

TRAITS::IndexContainerViewConstType geos::StencilWrapperBase< TRAITS >::getElementIndices ( ) const

inline

Const access to the element indices.

Returns

A view to const

Definition at line 120 of file StencilBase.hpp.

getElementRegionIndices()

template<typename TRAITS >

TRAITS::IndexContainerViewConstType geos::StencilWrapperBase< TRAITS >::getElementRegionIndices ( ) const

inline

Const access to the element regions indices.

Returns

A view to const

Definition at line 106 of file StencilBase.hpp.

getElementSubRegionIndices()

template<typename TRAITS >

TRAITS::IndexContainerViewConstType geos::StencilWrapperBase< TRAITS >::getElementSubRegionIndices ( ) const

inline

Const access to the element subregions indices.

Returns

A view to const

Definition at line 113 of file StencilBase.hpp.

getWeights()

template<typename TRAITS >

TRAITS::WeightContainerViewConstType geos::StencilWrapperBase< TRAITS >::getWeights ( ) const

inline

Const access to the stencil weights.

Returns

A view to const

Definition at line 127 of file StencilBase.hpp.

---

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

• coreComponents/finiteVolume/StencilBase.hpp