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 | List of all members
axom::bump::views::RectilinearCoordsetView3< DataType > Class Template Reference

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

Public Types

using LogicalIndex = axom::StackArray< axom::IndexType, 3 >
 
using IndexType = axom::IndexType
 
using value_type = DataType
 
using PointType = axom::primal::Point< DataType, 3 >
 

Public Member Functions

AXOM_HOST_DEVICE RectilinearCoordsetView3 ()
 Constructor. More...
 
AXOM_HOST_DEVICE RectilinearCoordsetView3 (const axom::ArrayView< DataType > &x, const axom::ArrayView< DataType > &y, const axom::ArrayView< DataType > &z)
 Constructor. More...
 
AXOM_HOST_DEVICE const StructuredIndexing< IndexType, 3 > & indexing () const
 Return the indexing for the coordset so we know its logical sizes. More...
 
AXOM_HOST_DEVICE axom::ArrayView< DataType > getCoordinates (size_t dim) const
 Get a coordinate array view for a dimension. More...
 
AXOM_HOST_DEVICE PointType getPoint (LogicalIndex vertex_index) const
 Return the requested point from the coordset. More...
 
AXOM_HOST_DEVICE PointType getPoint (IndexType vertex_index) const
 Return the requested point from the coordset. More...
 
AXOM_HOST_DEVICE PointType operator[] (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 nodes in the coordset. More...
 
AXOM_HOST_DEVICE IndexType numberOfNodes () const
 

Static Public Member Functions

constexpr static AXOM_HOST_DEVICE int dimension ()
 

Member Typedef Documentation

◆ LogicalIndex

template<typename DataType >
using axom::bump::views::RectilinearCoordsetView3< DataType >::LogicalIndex = axom::StackArray<axom::IndexType, 3>

◆ IndexType

template<typename DataType >
using axom::bump::views::RectilinearCoordsetView3< DataType >::IndexType = axom::IndexType

◆ value_type

template<typename DataType >
using axom::bump::views::RectilinearCoordsetView3< DataType >::value_type = DataType

◆ PointType

template<typename DataType >
using axom::bump::views::RectilinearCoordsetView3< DataType >::PointType = axom::primal::Point<DataType, 3>

Constructor & Destructor Documentation

◆ RectilinearCoordsetView3() [1/2]

template<typename DataType >
AXOM_HOST_DEVICE axom::bump::views::RectilinearCoordsetView3< DataType >::RectilinearCoordsetView3 ( )
inline

Constructor.

◆ RectilinearCoordsetView3() [2/2]

template<typename DataType >
AXOM_HOST_DEVICE axom::bump::views::RectilinearCoordsetView3< DataType >::RectilinearCoordsetView3 ( const axom::ArrayView< DataType > &  x,
const axom::ArrayView< DataType > &  y,
const axom::ArrayView< DataType > &  z 
)
inline

Constructor.

Parameters
xThe first coordinate component.
yThe second coordinate component.
zThe third coordinate component.

References axom::ArrayView< T, DIM, SPACE >::size().

Member Function Documentation

◆ dimension()

template<typename DataType >
constexpr static AXOM_HOST_DEVICE int axom::bump::views::RectilinearCoordsetView3< DataType >::dimension ( )
inlinestaticconstexpr

◆ size()

template<typename DataType >
AXOM_HOST_DEVICE IndexType axom::bump::views::RectilinearCoordsetView3< DataType >::size ( ) const
inline

Return the number of nodes in the coordset.

Returns
The number of nodes in the coordset.

◆ numberOfNodes()

template<typename DataType >
AXOM_HOST_DEVICE IndexType axom::bump::views::RectilinearCoordsetView3< DataType >::numberOfNodes ( ) const
inline

◆ indexing()

template<typename DataType >
AXOM_HOST_DEVICE const StructuredIndexing<IndexType, 3>& axom::bump::views::RectilinearCoordsetView3< DataType >::indexing ( ) const
inline

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

Returns
The indexing that contains the mesh logical sizes.

◆ getCoordinates()

template<typename DataType >
AXOM_HOST_DEVICE axom::ArrayView<DataType> axom::bump::views::RectilinearCoordsetView3< DataType >::getCoordinates ( size_t  dim) const
inline

Get a coordinate array view for a dimension.

Parameters
dimThe dimension of the coordinate to return.
Returns
A coordinate array view for the specified dimension.

References SLIC_ASSERT.

◆ getPoint() [1/2]

template<typename DataType >
AXOM_HOST_DEVICE PointType axom::bump::views::RectilinearCoordsetView3< DataType >::getPoint ( 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.

◆ getPoint() [2/2]

template<typename DataType >
AXOM_HOST_DEVICE PointType axom::bump::views::RectilinearCoordsetView3< DataType >::getPoint ( 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.

◆ operator[]() [1/2]

template<typename DataType >
AXOM_HOST_DEVICE PointType axom::bump::views::RectilinearCoordsetView3< DataType >::operator[] ( 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.

◆ operator[]() [2/2]

template<typename DataType >
AXOM_HOST_DEVICE PointType axom::bump::views::RectilinearCoordsetView3< DataType >::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.
The documentation for this class was generated from the following file: