#include <StencilBase.hpp>

Public Member Functions
	StencilWrapperBase (typename LEAFCLASSTRAITS::IndexContainerType const &elementRegionIndices, typename LEAFCLASSTRAITS::IndexContainerType const &elementSubRegionIndices, typename LEAFCLASSTRAITS::IndexContainerType const &elementIndices, typename LEAFCLASSTRAITS::WeightContainerType const &weights)
	Constructor. More...

LEAFCLASSTRAITS::IndexContainerViewConstType	getElementRegionIndices () const
	Const access to the element regions indices. More...

LEAFCLASSTRAITS::IndexContainerViewConstType	getElementSubRegionIndices () const
	Const access to the element subregions indices. More...

LEAFCLASSTRAITS::IndexContainerViewConstType	getElementIndices () const
	Const access to the element indices. More...

LEAFCLASSTRAITS::WeightContainerViewConstType	getWeights () const
	Const access to the stencil weights. More...

virtual localIndex	size () const =0
	Give the number of stencil entries. More...

Protected Attributes
LEAFCLASSTRAITS::IndexContainerViewConstType	m_elementRegionIndices
	The container for the element region indices for each point in each stencil.

LEAFCLASSTRAITS::IndexContainerViewConstType	m_elementSubRegionIndices
	The container for the element sub region indices for each point in each stencil.

LEAFCLASSTRAITS::IndexContainerViewConstType	m_elementIndices
	The container for the element indices for each point in each stencil.

LEAFCLASSTRAITS::WeightContainerViewConstType	m_weights
	The container for the weights for each point in each stencil.

Detailed Description

template<typename LEAFCLASSTRAITS>
class geosx::StencilWrapperBase< LEAFCLASSTRAITS >

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

Definition at line 35 of file StencilBase.hpp.

Constructor & Destructor Documentation

◆ StencilWrapperBase()

template<typename LEAFCLASSTRAITS>

geosx::StencilWrapperBase< LEAFCLASSTRAITS >::StencilWrapperBase	(	typename LEAFCLASSTRAITS::IndexContainerType const &	elementRegionIndices,
		typename LEAFCLASSTRAITS::IndexContainerType const &	elementSubRegionIndices,
		typename LEAFCLASSTRAITS::IndexContainerType const &	elementIndices,
		typename LEAFCLASSTRAITS::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 45 of file StencilBase.hpp.

Member Function Documentation

◆ getElementIndices()

template<typename LEAFCLASSTRAITS>

LEAFCLASSTRAITS::IndexContainerViewConstType geosx::StencilWrapperBase< LEAFCLASSTRAITS >::getElementIndices ( ) const

inline

Const access to the element indices.

Returns: A view to const

Definition at line 71 of file StencilBase.hpp.

◆ getElementRegionIndices()

template<typename LEAFCLASSTRAITS>

LEAFCLASSTRAITS::IndexContainerViewConstType geosx::StencilWrapperBase< LEAFCLASSTRAITS >::getElementRegionIndices ( ) const

inline

Const access to the element regions indices.

Returns: A view to const

Definition at line 59 of file StencilBase.hpp.

◆ getElementSubRegionIndices()

template<typename LEAFCLASSTRAITS>

LEAFCLASSTRAITS::IndexContainerViewConstType geosx::StencilWrapperBase< LEAFCLASSTRAITS >::getElementSubRegionIndices ( ) const

inline

Const access to the element subregions indices.

Returns: A view to const

Definition at line 65 of file StencilBase.hpp.

◆ getWeights()

template<typename LEAFCLASSTRAITS>

LEAFCLASSTRAITS::WeightContainerViewConstType geosx::StencilWrapperBase< LEAFCLASSTRAITS >::getWeights ( ) const

inline

Const access to the stencil weights.

Returns: A view to const

Definition at line 77 of file StencilBase.hpp.

◆ size()

template<typename LEAFCLASSTRAITS>

virtual localIndex geosx::StencilWrapperBase< LEAFCLASSTRAITS >::size ( ) const

pure virtual

Give the number of stencil entries.

Returns: The number of stencil entries

Implemented in geosx::SurfaceElementStencilWrapper, geosx::CellElementStencilTPFAWrapper, geosx::FaceElementToCellStencilWrapper, and geosx::EmbeddedSurfaceToCellStencilWrapper.

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

coreComponents/finiteVolume/StencilBase.hpp

Public Member Functions

Protected Attributes

Detailed Description

template<typename LEAFCLASSTRAITS> class geosx::StencilWrapperBase< LEAFCLASSTRAITS >

Constructor & Destructor Documentation

◆ StencilWrapperBase()

Member Function Documentation

◆ getElementIndices()

◆ getElementRegionIndices()

◆ getElementSubRegionIndices()

◆ getWeights()

◆ size()

template<typename LEAFCLASSTRAITS>
class geosx::StencilWrapperBase< LEAFCLASSTRAITS >