axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType > Class Template Reference

Concrete instance of the BlockIteratorHelper class defined in the OctreeLevel base class. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/spin/DenseOctreeLevel.hpp>

Inherits ParentType.

Public Types
using	self = IteratorHelper< OctreeLevelType, ParentType >
using	BaseBlockItType = ParentType

Public Member Functions
	IteratorHelper (OctreeLevelType *octLevel, bool begin)
void	increment ()
	Increment to next block of the level. More...
GridPt	pt () const
	Access to point associated with the block pointed to by the iterator. More...
BlockDataType *	data ()
	Accessor for data associated with the iterator's block. More...
const BlockDataType *	data () const
	Const accessor for data associated with the iterator's block. More...
bool	equal (const BaseBlockItType *other)
	Predicate to determine if two block iterators are the same. More...

Detailed Description

template<int DIM, typename BlockDataType, typename MortonIndexType>
template<typename OctreeLevelType, typename ParentType>
class axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >

Concrete instance of the BlockIteratorHelper class defined in the OctreeLevel base class.

Note

ParenType must be either BlockIteratorHelper or ConstBlockIteratorHelper, both are defined in the OctreeLevel base class

Member Typedef Documentation

self

template<int DIM, typename BlockDataType , typename MortonIndexType >

template<typename OctreeLevelType , typename ParentType >

using axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >::self = IteratorHelper<OctreeLevelType, ParentType>

BaseBlockItType

template<int DIM, typename BlockDataType , typename MortonIndexType >

template<typename OctreeLevelType , typename ParentType >

using axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >::BaseBlockItType = ParentType

Constructor & Destructor Documentation

IteratorHelper()

template<int DIM, typename BlockDataType , typename MortonIndexType >

template<typename OctreeLevelType , typename ParentType >

axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >::IteratorHelper ( OctreeLevelType *  octLevel, bool  begin  )

inline

References axom::spin::OctreeLevel< DIM, BlockDataType >::begin(), axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >::data(), and axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >::increment().

Member Function Documentation

increment()

template<int DIM, typename BlockDataType , typename MortonIndexType >

template<typename OctreeLevelType , typename ParentType >

void axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >::increment ( )

inline

Increment to next block of the level.

References axom::spin::OctreeLevel< DIM, BlockDataType >::BROOD_SIZE, and axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >::data().

pt()

template<int DIM, typename BlockDataType , typename MortonIndexType >

template<typename OctreeLevelType , typename ParentType >

GridPt axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >::pt ( ) const

inline

Access to point associated with the block pointed to by the iterator.

References axom::spin::Brood< GridPt, MortonIndexType >::reconstructGridPt().

data() [1/2]

template<int DIM, typename BlockDataType , typename MortonIndexType >

template<typename OctreeLevelType , typename ParentType >

BlockDataType* axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >::data ( )

inline

Accessor for data associated with the iterator's block.

data() [2/2]

template<int DIM, typename BlockDataType , typename MortonIndexType >

template<typename OctreeLevelType , typename ParentType >

const BlockDataType* axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >::data ( ) const

inline

Const accessor for data associated with the iterator's block.

equal()

template<int DIM, typename BlockDataType , typename MortonIndexType >

template<typename OctreeLevelType , typename ParentType >

bool axom::spin::DenseOctreeLevel< DIM, BlockDataType, MortonIndexType >::IteratorHelper< OctreeLevelType, ParentType >::equal ( const BaseBlockItType *  other )

inline

Predicate to determine if two block iterators are the same.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/spin/DenseOctreeLevel.hpp