AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
axom::bump::views::UniformCoordsetView< DataType, NDIMS > Class Template Reference

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/bump/views/UniformCoordsetView.hpp>

Public Types

using LogicalIndex = axom::StackArray< axom::IndexType, NDIMS >
 
using ExtentsType = axom::StackArray< double, NDIMS >
 
using IndexType = axom::IndexType
 
using value_type = DataType
 
using PointType = axom::primal::Point< DataType, NDIMS >
 

Public Member Functions

AXOM_HOST_DEVICE UniformCoordsetView ()
 Constructor. More...
 
AXOM_HOST_DEVICE UniformCoordsetView (const LogicalIndex &dims, const ExtentsType &origin, const ExtentsType &spacing)
 Constructor. More...
 
AXOM_HOST_DEVICE const StructuredIndexing< IndexType, NDIMS > & indexing () const
 Return the indexing for the coordset so we know its logical sizes. More...
 
AXOM_HOST_DEVICE const ExtentsType & origin () const
 Return the coordset origin. More...
 
AXOM_HOST_DEVICE const ExtentsType & spacing () const
 Return the coordset spacing. More...
 
AXOM_HOST_DEVICE PointType getPoint (const LogicalIndex &vertex_index) const
 Return the requested point from the coordset. More...
 
AXOM_HOST_DEVICE PointType operator[] (const LogicalIndex &vertex_index) const
 Return the requested point from the coordset. More...
 
AXOM_HOST_DEVICE PointType operator[] (IndexType vertex_index) const
 Return the requested point from the coordset. More...
 
AXOM_HOST_DEVICE IndexType size () const
 Return the number of points in the coordset. More...
 
AXOM_HOST_DEVICE IndexType numberOfNodes () const
 

Static Public Member Functions

constexpr static AXOM_HOST_DEVICE int dimension ()
 

Public Attributes

StructuredIndexing< IndexType, NDIMS > m_indexing
 
ExtentsType m_origin
 
ExtentsType m_spacing
 

Member Typedef Documentation

◆ LogicalIndex

template<typename DataType , int NDIMS = 2>
using axom::bump::views::UniformCoordsetView< DataType, NDIMS >::LogicalIndex = axom::StackArray<axom::IndexType, NDIMS>

◆ ExtentsType

template<typename DataType , int NDIMS = 2>
using axom::bump::views::UniformCoordsetView< DataType, NDIMS >::ExtentsType = axom::StackArray<double, NDIMS>

◆ IndexType

template<typename DataType , int NDIMS = 2>
using axom::bump::views::UniformCoordsetView< DataType, NDIMS >::IndexType = axom::IndexType

◆ value_type

template<typename DataType , int NDIMS = 2>
using axom::bump::views::UniformCoordsetView< DataType, NDIMS >::value_type = DataType

◆ PointType

template<typename DataType , int NDIMS = 2>
using axom::bump::views::UniformCoordsetView< DataType, NDIMS >::PointType = axom::primal::Point<DataType, NDIMS>

Constructor & Destructor Documentation

◆ UniformCoordsetView() [1/2]

template<typename DataType , int NDIMS = 2>
AXOM_HOST_DEVICE axom::bump::views::UniformCoordsetView< DataType, NDIMS >::UniformCoordsetView ( )
inline

Constructor.

◆ UniformCoordsetView() [2/2]

template<typename DataType , int NDIMS = 2>
AXOM_HOST_DEVICE axom::bump::views::UniformCoordsetView< DataType, NDIMS >::UniformCoordsetView ( const LogicalIndex &  dims,
const ExtentsType &  origin,
const ExtentsType &  spacing 
)
inline

Constructor.

Parameters
dimsThe logical dimensions of the coordset.
originThe origin of the coordset's coordinate system.
spacingThe spacing inbetween points.

Member Function Documentation

◆ dimension()

template<typename DataType , int NDIMS = 2>
constexpr static AXOM_HOST_DEVICE int axom::bump::views::UniformCoordsetView< DataType, NDIMS >::dimension ( )
inlinestaticconstexpr

◆ size()

template<typename DataType , int NDIMS = 2>
AXOM_HOST_DEVICE IndexType axom::bump::views::UniformCoordsetView< DataType, NDIMS >::size ( ) const
inline

Return the number of points in the coordset.

Returns
The number of points in the coordset.

References axom::bump::views::UniformCoordsetView< DataType, NDIMS >::m_indexing.

◆ numberOfNodes()

template<typename DataType , int NDIMS = 2>
AXOM_HOST_DEVICE IndexType axom::bump::views::UniformCoordsetView< DataType, NDIMS >::numberOfNodes ( ) const
inline

References axom::bump::views::UniformCoordsetView< DataType, NDIMS >::m_indexing.

◆ indexing()

template<typename DataType , int NDIMS = 2>
AXOM_HOST_DEVICE const StructuredIndexing<IndexType, NDIMS>& axom::bump::views::UniformCoordsetView< DataType, NDIMS >::indexing ( ) const
inline

Return the indexing for the coordset so we know its logical sizes.

Returns
The indexing that contains the mesh logical sizes.

References axom::bump::views::UniformCoordsetView< DataType, NDIMS >::m_indexing.

◆ origin()

template<typename DataType , int NDIMS = 2>
AXOM_HOST_DEVICE const ExtentsType& axom::bump::views::UniformCoordsetView< DataType, NDIMS >::origin ( ) const
inline

Return the coordset origin.

Returns
The coordset origin.

References axom::bump::views::UniformCoordsetView< DataType, NDIMS >::m_origin.

◆ spacing()

template<typename DataType , int NDIMS = 2>
AXOM_HOST_DEVICE const ExtentsType& axom::bump::views::UniformCoordsetView< DataType, NDIMS >::spacing ( ) const
inline

Return the coordset spacing.

Returns
The coordset spacing.

References axom::bump::views::UniformCoordsetView< DataType, NDIMS >::m_spacing.

◆ getPoint()

template<typename DataType , int NDIMS = 2>
AXOM_HOST_DEVICE PointType axom::bump::views::UniformCoordsetView< DataType, NDIMS >::getPoint ( const LogicalIndex &  vertex_index) const
inline

Return the requested point from the coordset.

Parameters
vertex_indexThe logical index of the point to return.
Returns
A point that corresponds to vertex_index.

References axom::bump::views::UniformCoordsetView< DataType, NDIMS >::m_origin, and axom::bump::views::UniformCoordsetView< DataType, NDIMS >::m_spacing.

◆ operator[]() [1/2]

template<typename DataType , int NDIMS = 2>
AXOM_HOST_DEVICE PointType axom::bump::views::UniformCoordsetView< DataType, NDIMS >::operator[] ( const LogicalIndex &  vertex_index) const
inline

Return the requested point from the coordset.

Parameters
vertex_indexThe logical index of the point to return.
Returns
A point that corresponds to vertex_index.

References axom::bump::views::UniformCoordsetView< DataType, NDIMS >::getPoint().

◆ operator[]() [2/2]

template<typename DataType , int NDIMS = 2>
AXOM_HOST_DEVICE PointType axom::bump::views::UniformCoordsetView< DataType, NDIMS >::operator[] ( IndexType  vertex_index) const
inline

Return the requested point from the coordset.

Parameters
vertex_indexThe index of the point to return.
Returns
A point that corresponds to vertex_index.

References axom::bump::views::UniformCoordsetView< DataType, NDIMS >::getPoint(), and axom::bump::views::UniformCoordsetView< DataType, NDIMS >::m_indexing.

Member Data Documentation

◆ m_indexing

template<typename DataType , int NDIMS = 2>
StructuredIndexing<IndexType, NDIMS> axom::bump::views::UniformCoordsetView< DataType, NDIMS >::m_indexing

◆ m_origin

template<typename DataType , int NDIMS = 2>
ExtentsType axom::bump::views::UniformCoordsetView< DataType, NDIMS >::m_origin

◆ m_spacing

template<typename DataType , int NDIMS = 2>
ExtentsType axom::bump::views::UniformCoordsetView< DataType, NDIMS >::m_spacing
The documentation for this class was generated from the following file: