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

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

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

Static Public Member Functions
static GridPt	reconstructGridPt (const GridPt &pt, int offset)
	Reconstruct a grid point from a brood's base point and an offset. More...

Constructor & Destructor Documentation

Brood()

template<typename GridPt >

axom::spin::Brood< GridPt, GridPt >::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

Member Function Documentation

base()

template<typename GridPt >

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

inline

Accessor for the base point of the entire brood.

offset()

template<typename GridPt >

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

inline

Accessor for the index of the point within the brood.

reconstructGridPt()

template<typename GridPt >

static GridPt axom::spin::Brood< GridPt, GridPt >::reconstructGridPt ( const GridPt &  pt, int  offset  )

inlinestatic

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

References 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