GEOSX
Public Types | Public Member Functions | List of all members
geosx::EmbeddedSurfaceToCellStencil Class Reference

#include <EmbeddedSurfaceToCellStencil.hpp>

Inheritance diagram for geosx::EmbeddedSurfaceToCellStencil:
Inheritance graph
[legend]

Public Types

using StencilWrapper = EmbeddedSurfaceToCellStencilWrapper
 Type of kernel wrapper for in-kernel update.
 
- Public Types inherited from geosx::EmbeddedSurfaceToCellStencil_Traits
using IndexContainerType = array2d< localIndex >
 The array type that will be used to store the indices of the stencil contributors.
 
using IndexContainerViewType = arrayView2d< localIndex >
 The array view type for the stencil indices.
 
using IndexContainerViewConstType = arrayView2d< localIndex const >
 The array view to const type for the stencil indices.
 
using WeightContainerType = array2d< real64 >
 The array type that is used to store the weights of the stencil contributors.
 
using WeightContainerViewType = arrayView2d< real64 >
 The array view type for the stencil weights.
 
using WeightContainerViewConstType = arrayView2d< real64 const >
 The array view to const type for the stencil weights.
 

Public Member Functions

 EmbeddedSurfaceToCellStencil ()
 Default constructor.
 
virtual void move (LvArray::MemorySpace const space) override final
 Move the data arrays associated with the stencil to a specified memory space. More...
 
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 final
 Add an entry to the stencil. More...
 
void add (localIndex const numPts, R1Tensor const *const cellCenterToEdgeCenter, localIndex const connectorIndex)
 Add an entry to the stencil. More...
 
StencilWrapper createStencilWrapper () const
 Create an update kernel wrapper. More...
 
virtual localIndex size () const override final
 Return the stencil size. More...
 
constexpr localIndex stencilSize (localIndex index) const
 Give the number of points in a stencil entry. More...
 
- Public Member Functions inherited from geosx::StencilBase< EmbeddedSurfaceToCellStencil_Traits, EmbeddedSurfaceToCellStencil >
 StencilBase (StencilBase const &)=default
 Constructor.
 
 StencilBase (StencilBase &&)=default
 Move constructor.
 
virtual ~StencilBase ()=default
 Destructor.
 
virtual void reserve (localIndex const size)
 Reserve the size of the stencil. 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...
 
EmbeddedSurfaceToCellStencil_Traits ::IndexContainerViewConstType getElementRegionIndices () const
 Const access to the element regions indices. More...
 
EmbeddedSurfaceToCellStencil_Traits ::IndexContainerViewConstType getElementSubRegionIndices () const
 Const access to the element subregions indices. More...
 
EmbeddedSurfaceToCellStencil_Traits ::IndexContainerViewConstType getElementIndices () const
 Const access to the element indices. More...
 
EmbeddedSurfaceToCellStencil_Traits ::WeightContainerViewConstType getWeights () const
 Const access to the stencil weights. More...
 

Additional Inherited Members

- Static Public Attributes inherited from geosx::EmbeddedSurfaceToCellStencil_Traits
static constexpr localIndex NUM_POINT_IN_FLUX = 2
 Number of points the flux is between (always 2 for TPFA)
 
static constexpr localIndex MAX_STENCIL_SIZE = 2
 Maximum number of points in a stencil (this is 2 for TPFA)
 
static constexpr localIndex MAX_NUM_OF_CONNECTIONS = 1
 Maximum number of connections in a stencil.
 
- Protected Attributes inherited from geosx::StencilBase< EmbeddedSurfaceToCellStencil_Traits, EmbeddedSurfaceToCellStencil >
EmbeddedSurfaceToCellStencil_Traits ::IndexContainerType m_elementRegionIndices
 The container for the element region indices for each point in each stencil.
 
EmbeddedSurfaceToCellStencil_Traits ::IndexContainerType m_elementSubRegionIndices
 The container for the element sub region indices for each point in each stencil.
 
EmbeddedSurfaceToCellStencil_Traits ::IndexContainerType m_elementIndices
 The container for the element indices for each point in each stencil.
 
EmbeddedSurfaceToCellStencil_Traits ::WeightContainerType m_weights
 The container for the weights for each point in each stencil.
 
map< localIndex, localIndexm_connectorIndices
 The map that provides the stencil index given the index of the underlying connector object.
 

Detailed Description

Provides management of the interior stencil points for a face elements when using Two-Point flux approximation.

Definition at line 168 of file EmbeddedSurfaceToCellStencil.hpp.

Member Function Documentation

◆ add() [1/2]

virtual void geosx::EmbeddedSurfaceToCellStencil::add ( localIndex const  numPts,
localIndex const *const  elementRegionIndices,
localIndex const *const  elementSubRegionIndices,
localIndex const *const  elementIndices,
real64 const *const  weights,
localIndex const  connectorIndex 
)
finaloverridevirtual

Add an entry to the stencil.

Parameters
[in]numPtsThe number of points in the stencil entry
[in]elementRegionIndicesThe element region indices for each point in the stencil entry
[in]elementSubRegionIndicesThe element sub-region indices for each point in the stencil entry
[in]elementIndicesThe element indices for each point in the stencil entry
[in]weightsThe weights each point in the stencil entry
[in]connectorIndexThe index of the connector element that the stencil acts across

Implements geosx::StencilBase< EmbeddedSurfaceToCellStencil_Traits, EmbeddedSurfaceToCellStencil >.

◆ add() [2/2]

void geosx::EmbeddedSurfaceToCellStencil::add ( localIndex const  numPts,
R1Tensor const *const  cellCenterToEdgeCenter,
localIndex const  connectorIndex 
)

Add an entry to the stencil.

Parameters
[in]numPtsThe number of points in the stencil entry
[in]cellCenterToEdgeCentervectors pointing from the cell center to the edge center
[in]connectorIndexThe index of the connector element that the stencil acts across

◆ createStencilWrapper()

StencilWrapper geosx::EmbeddedSurfaceToCellStencil::createStencilWrapper ( ) const
inline

Create an update kernel wrapper.

Returns
the wrapper

Definition at line 205 of file EmbeddedSurfaceToCellStencil.hpp.

◆ move()

virtual void geosx::EmbeddedSurfaceToCellStencil::move ( LvArray::MemorySpace const  space)
finaloverridevirtual

Move the data arrays associated with the stencil to a specified memory space.

Parameters
spaceThe target memory space.
Note
The existence of this function indicates we need to redesign the stencil classes.

Reimplemented from geosx::StencilBase< EmbeddedSurfaceToCellStencil_Traits, EmbeddedSurfaceToCellStencil >.

◆ size()

virtual localIndex geosx::EmbeddedSurfaceToCellStencil::size ( ) const
inlinefinaloverridevirtual

Return the stencil size.

Returns
the stencil size

Implements geosx::StencilBase< EmbeddedSurfaceToCellStencil_Traits, EmbeddedSurfaceToCellStencil >.

Definition at line 218 of file EmbeddedSurfaceToCellStencil.hpp.

◆ stencilSize()

constexpr localIndex geosx::EmbeddedSurfaceToCellStencil::stencilSize ( localIndex  index) const
inline

Give the number of points in a stencil entry.

Parameters
[in]indexof the stencil entry for which to query the size
Returns
the size of a stencil entry

Definition at line 226 of file EmbeddedSurfaceToCellStencil.hpp.


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