AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::quest::detail::InterleavedOrStridedPoints< T, NDIMS > Struct Template Reference

Utility class to enable processing an array of points whose layout is either interleaved or separated strided arrays. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/quest/ScatteredInterpolation.hpp>

Public Types

using CoordType = T
 
using PointType = primal::Point< CoordType, NDIMS >
 
using StridedPoints = primal::detail::ZipBase< PointType >
 
using InterleavedPoints = axom::ArrayView< PointType >
 

Public Member Functions

 InterleavedOrStridedPoints (conduit::Node &values)
 Constructor from a multi-component array Conduit node. More...
 
 InterleavedOrStridedPoints (const sidre::Group *values)
 Constructor from a multi-component array Sidre group node. More...
 
int size () const
 Returns the number of points in the array. More...
 
PointType operator[] (int idx) const
 Access the point at index idx in the array. More...
 

Static Public Attributes

static constexpr int DIM = NDIMS
 

Detailed Description

template<typename T, int NDIMS>
struct axom::quest::detail::InterleavedOrStridedPoints< T, NDIMS >

Utility class to enable processing an array of points whose layout is either interleaved or separated strided arrays.

Member Typedef Documentation

◆ CoordType

template<typename T , int NDIMS>
using axom::quest::detail::InterleavedOrStridedPoints< T, NDIMS >::CoordType = T

◆ PointType

template<typename T , int NDIMS>
using axom::quest::detail::InterleavedOrStridedPoints< T, NDIMS >::PointType = primal::Point<CoordType, NDIMS>

◆ StridedPoints

template<typename T , int NDIMS>
using axom::quest::detail::InterleavedOrStridedPoints< T, NDIMS >::StridedPoints = primal::detail::ZipBase<PointType>

◆ InterleavedPoints

template<typename T , int NDIMS>
using axom::quest::detail::InterleavedOrStridedPoints< T, NDIMS >::InterleavedPoints = axom::ArrayView<PointType>

Constructor & Destructor Documentation

◆ InterleavedOrStridedPoints() [1/2]

template<typename T , int NDIMS>
axom::quest::detail::InterleavedOrStridedPoints< T, NDIMS >::InterleavedOrStridedPoints ( conduit::Node &  values)
inlineexplicit

Constructor from a multi-component array Conduit node.

References SLIC_ASSERT.

◆ InterleavedOrStridedPoints() [2/2]

template<typename T , int NDIMS>
axom::quest::detail::InterleavedOrStridedPoints< T, NDIMS >::InterleavedOrStridedPoints ( const sidre::Group values)
inlineexplicit

Constructor from a multi-component array Sidre group node.

References axom::sidre::Group::createNativeLayout(), and SLIC_ASSERT.

Member Function Documentation

◆ size()

template<typename T , int NDIMS>
int axom::quest::detail::InterleavedOrStridedPoints< T, NDIMS >::size ( ) const
inline

Returns the number of points in the array.

◆ operator[]()

template<typename T , int NDIMS>
PointType axom::quest::detail::InterleavedOrStridedPoints< T, NDIMS >::operator[] ( int  idx) const
inline

Access the point at index idx in the array.

Member Data Documentation

◆ DIM

template<typename T , int NDIMS>
constexpr int axom::quest::detail::InterleavedOrStridedPoints< T, NDIMS >::DIM = NDIMS
staticconstexpr

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