Provides management of the boundary stencil points (stencils used to prescribe boundary conditions on domain boundaries, i.e. faces) More...

#include <BoundaryStencil.hpp>

Inheritance diagram for geos::BoundaryStencil:

[legend]

Classes
struct	Order
	Defines the order of element/face in the stencil. More...

Public Types
using	KernelWrapper = BoundaryStencilWrapper
	Type of kernel wrapper for in-kernel update.

Public Types inherited from geos::StencilTraits< CONTAINER, MAX_NUM_POINTS_IN_FLUX, MAX_STENCIL_SIZE, MAX_NUM_CONNECTIONS >
using	IndexContainerType = CONTAINER< localIndex >
	The array type that will be used to store the indices of the stencil contributors.

using	IndexContainerViewConstType = LvArray::typeManipulation::NestedViewTypeConst< IndexContainerType >
	The array view to const type for the stencil indices.

using	WeightContainerType = CONTAINER< real64 >
	The array type that is used to store the weights of the stencil contributors.

using	WeightContainerViewConstType = LvArray::typeManipulation::NestedViewTypeConst< WeightContainerType >
	The array view to const type for the stencil weights.

using	WeightContainerViewType = LvArray::typeManipulation::NestedViewType< WeightContainerType >
	The array view to type for the stencil weights.

Public Member Functions
	BoundaryStencil ()
	Constructor.

virtual void	add (localIndex const numPts, localIndex const const elementRegionIndices, localIndex const const elementSubRegionIndices, localIndex const const elementIndices, real64 const const weights, localIndex const connectorIndex) override
	Add an entry to the stencil. More...

void	addVectors (real64 const &transMultiplier, real64 const (&faceNormal)[3], real64 const (&cellToFaceVec)[3])
	Add the vectors need to compute the transmissiblity to the Stencil. More...

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

constexpr localIndex	stencilSize (localIndex const index) const
	Gives the number of points in a stencil entry. More...

KernelWrapper	createKernelWrapper () const
	Create an update kernel wrapper. More...

Public Member Functions inherited from geos::StencilBase< TwoPointStencilTraits, BoundaryStencil >
virtual	~StencilBase ()=default
	Destructor.

virtual void	reserve (localIndex const size)
	Reserve the size of the stencil. More...

virtual void	move (LvArray::MemorySpace const space)
	Move the data arrays associated with the stencil to a specified memory space. More...

virtual bool	zero (localIndex const connectorIndex)
	Zero weights for a stencil entry. More...

void	setName (string const &name)
	Set the name used in data movement logging callbacks. 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...

unordered_map< localIndex, localIndex > const &	getConnectorIndices () const
	Const access to stencil connector indices. More...

Additional Inherited Members
Static Public Attributes inherited from geos::StencilTraits< CONTAINER, MAX_NUM_POINTS_IN_FLUX, MAX_STENCIL_SIZE, MAX_NUM_CONNECTIONS >
static constexpr localIndex	maxNumPointsInFlux = MAX_NUM_POINTS_IN_FLUX
	Maximum number of points the flux.

static constexpr localIndex	maxStencilSize = MAX_STENCIL_SIZE
	Maximum number of points in a stencil.

static constexpr localIndex	maxNumConnections = MAX_NUM_CONNECTIONS
	Maximum number of connections in a stencil.

Protected Attributes inherited from geos::StencilBase< TwoPointStencilTraits, BoundaryStencil >
TRAITS::IndexContainerType	m_elementRegionIndices
	The container for the element region indices for each point in each stencil.

TRAITS::IndexContainerType	m_elementSubRegionIndices
	The container for the element sub region indices for each point in each stencil.

TRAITS::IndexContainerType	m_elementIndices
	The container for the element indices for each point in each stencil.

TRAITS::WeightContainerType	m_weights
	The container for the weights for each point in each stencil.

unordered_map< localIndex, localIndex >	m_connectorIndices
	The map that provides the stencil index given the index of the underlying connector object.

Detailed Description

Provides management of the boundary stencil points (stencils used to prescribe boundary conditions on domain boundaries, i.e. faces)

Definition at line 116 of file BoundaryStencil.hpp.

Member Function Documentation

◆ add()

virtual void geos::BoundaryStencil::add	(	localIndex const	numPts,
		localIndex const *const	elementRegionIndices,
		localIndex const *const	elementSubRegionIndices,
		localIndex const *const	elementIndices,
		real64 const *const	weights,
		localIndex const	connectorIndex
	)

overridevirtual

Add an entry to the stencil.

Parameters

[in]	numPts	The number of points in the stencil entry
[in]	elementRegionIndices	The element region indices for each point in the stencil entry
[in]	elementSubRegionIndices	The element sub-region indices for each point in the stencil entry
[in]	elementIndices	The element indices for each point in the stencil entry
[in]	weights	The weights each point in the stencil entry
[in]	connectorIndex	The index of the connector element that the stencil acts across

Implements geos::StencilBase< TwoPointStencilTraits, BoundaryStencil >.

◆ addVectors()

void geos::BoundaryStencil::addVectors	(	real64 const &	transMultiplier,
		real64 const (&)	faceNormal[3],
		real64 const (&)	cellToFaceVec[3]
	)

Add the vectors need to compute the transmissiblity to the Stencil.

Parameters

[in]	transMultiplier	the transmissibility multiplier
[in]	faceNormal	the normal to the face
[in]	cellToFaceVec	distance vector between the cell center and the face

◆ createKernelWrapper()

KernelWrapper geos::BoundaryStencil::createKernelWrapper ( ) const

Create an update kernel wrapper.

Returns: the wrapper

◆ size()

virtual localIndex geos::BoundaryStencil::size ( ) const

inlineoverridevirtual

Give the number of stencil entries.

Returns: The number of stencil entries

Implements geos::StencilBase< TwoPointStencilTraits, BoundaryStencil >.

Definition at line 154 of file BoundaryStencil.hpp.

◆ stencilSize()

constexpr localIndex geos::BoundaryStencil::stencilSize ( localIndex const index ) const

inlineconstexpr

Gives the number of points in a stencil entry.

Parameters

[in] index of the stencil entry for which to query the size

Returns: the size of a stencil entry

Definition at line 164 of file BoundaryStencil.hpp.

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

coreComponents/finiteVolume/BoundaryStencil.hpp

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add()

◆ addVectors()

◆ createKernelWrapper()

◆ size()

◆ stencilSize()