axom::spin::Brood< GridPt, MortonIndexType > Struct Template Reference

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

Public Types
enum	{ DIM = GridPt::DIMENSION , BROOD_BITMASK = (1 << DIM) - 1 }
using	MortonizerType = spin::Mortonizer< typename GridPt::CoordType, MortonIndexType, DIM >

Public Member Functions
	Brood (const GridPt &pt)
	Constructor for a brood offset relative to the given grid point pt. More...
const MortonIndexType &	base () const
	Accessor for the base point of the entire brood. More...
const int &	offset () const
	Accessor for the offset of the point within the brood. More...

Static Public Member Functions
static GridPt	reconstructGridPt (MortonIndexType morton, int offset)
	Reconstruct a grid point from a brood's Morton index and an offset. More...

Member Typedef Documentation

MortonizerType

template<typename GridPt , typename MortonIndexType >

using axom::spin::Brood< GridPt, MortonIndexType >::MortonizerType = spin::Mortonizer<typename GridPt::CoordType, MortonIndexType, DIM>

Member Enumeration Documentation

anonymous enum

template<typename GridPt , typename MortonIndexType >

anonymous enum

Enumerator
DIM
BROOD_BITMASK

Constructor & Destructor Documentation

Brood()

template<typename GridPt , typename MortonIndexType >

axom::spin::Brood< GridPt, MortonIndexType >::Brood ( const GridPt &  pt )

inline

Constructor for a brood offset relative to the given grid point pt.

Parameters

[in]

pt

The grid point within the octree level

References axom::spin::Brood< GridPt, MortonIndexType >::BROOD_BITMASK, and axom::spin::Brood< GridPt, MortonIndexType >::DIM.

Member Function Documentation

base()

template<typename GridPt , typename MortonIndexType >

const MortonIndexType& axom::spin::Brood< GridPt, MortonIndexType >::base ( ) const

inline

Accessor for the base point of the entire brood.

Returns

MortonIndex of the base point

offset()

template<typename GridPt , typename MortonIndexType >

const int& axom::spin::Brood< GridPt, MortonIndexType >::offset ( ) const

inline

Accessor for the offset of the point within the brood.

reconstructGridPt()

template<typename GridPt , typename MortonIndexType >

static GridPt axom::spin::Brood< GridPt, MortonIndexType >::reconstructGridPt ( MortonIndexType  morton, int  offset  )

inlinestatic

Reconstruct a grid point from a brood's Morton index and an offset.

References axom::spin::Brood< GridPt, MortonIndexType >::DIM, and axom::spin::Brood< GridPt, MortonIndexType >::offset().

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/spin/Brood.hpp