Handles the non-geometric operations for our octree such as refinement, finding the parents and children of a node and determining whether a leaf node exists. More...
#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/spin/OctreeBase.hpp>
Classes | |
| class | BlockIndex |
| Inner class encapsulating the index of an octree block. More... | |
Public Types | |
| using | CoordType = axom::IndexType |
| using | GridPt = primal::Point< CoordType, DIM > |
| using | GridVec = primal::Vector< CoordType, DIM > |
| using | MAX_LEVEL_SIZE = slam::policies::CompileTimeSize< CoordType, std::numeric_limits< CoordType >::digits > |
| using | OctreeLevels = slam::OrderedSet< CoordType, CoordType, MAX_LEVEL_SIZE > |
| using | OctreeLevelType = OctreeLevel< DIM, BlockDataType > |
| using | LeafIndicesLevelMap = slam::Map< OctreeLevelType * > |
Public Member Functions | |
| OctreeBase () | |
| ~OctreeBase () | |
| OctreeBase destructor. More... | |
| int | maxLeafLevel () const |
| The max level for leaf blocks of the octree. More... | |
| int | maxInternalLevel () const |
| The max level for internal blocks of the octree. More... | |
| BlockIndex | parent (const GridPt &pt, int level) const |
| Finds the grid index and level of the current octree block's parent. More... | |
| BlockIndex | parent (const BlockIndex &block) const |
| Finds the BlockIndex of the given block's parent. More... | |
| BlockIndex | child (const GridPt &pt, int level, int childIndex) const |
| Finds the BlockIndex of the given block's child. More... | |
| BlockIndex | child (const BlockIndex &block, int childIndex) const |
| Finds the BlockIndex of the given block's child. More... | |
| OctreeLevelType & | getOctreeLevel (int lev) |
| Accessor for a reference to the octree level instance at level lev. More... | |
| const OctreeLevelType & | getOctreeLevel (int lev) const |
| Const accessor for a reference to the octree level instance at level lev. More... | |
| bool | isLevelValid (int lev) const |
| Predicate to determine if level lev is in the range. More... | |
| bool | isLeaf (const GridPt &pt, int lev) const |
| Determine whether the octree contains a leaf block associated with grid point pt at level lev. More... | |
| bool | isLeaf (const BlockIndex &block) const |
| Determine whether the octree contains a leaf block associated with this BlockIndex. More... | |
| bool | isInternal (const GridPt &pt, int lev) const |
| Determine whether the octree contains an internal block associated with grid point pt at level lev. More... | |
| bool | isInternal (const BlockIndex &block) const |
| Determine whether the octree contains an internal block associated with this BlockIndex. More... | |
| bool | hasBlock (const GridPt &pt, int lev) const |
| Determine whether the octree contains a block (internal or leaf) associated with grid point pt at level lev. More... | |
| bool | hasBlock (const BlockIndex &block) const |
| Determine whether the octree contains a block (internal or leaf) associated with this BlockIndex. More... | |
| bool | inBounds (const GridPt &pt, int lev) const |
| Determine whether the octree block associated with grid point pt and level lev is a possible block in this octree. More... | |
| bool | inBounds (const BlockIndex &block) const |
| Determine whether the octree block associated with BlockIndex is a possible block in this octree. More... | |
| void | refineLeaf (const BlockIndex &leafBlock) |
| Refines the given leaf block in the octree. More... | |
| BlockDataType & | operator[] (const BlockIndex &block) |
| Accessor to the data associated with block. More... | |
| const BlockDataType & | operator[] (const BlockIndex &block) const |
| Const accessor to the data associated with block. More... | |
| BlockIndex | coveringLeafBlock (const BlockIndex &blk, bool checkInBounds=true) const |
| Finds the finest octree leaf covering BlockIndex blk. More... | |
Static Public Member Functions | |
| static CoordType | maxCoordAtLevel (int level) |
| Utility function to find the number of (possible) grid cells at a given level or resolution. More... | |
| static BlockIndex | root () |
Protected Member Functions | |
| TreeBlockStatus | blockStatus (const GridPt &pt, int lev) const |
| Helper function to determine the status of a BlockIndex within an octree instance. More... | |
| TreeBlockStatus | blockStatus (const BlockIndex &blk) const |
| Helper function to determine the status of a BlockIndex within an octree instance. More... | |
Protected Attributes | |
| OctreeLevels | m_levels |
| LeafIndicesLevelMap | m_leavesLevelMap |
Detailed Description
template<int DIM, typename BlockDataType>
class axom::spin::OctreeBase< DIM, BlockDataType >
Handles the non-geometric operations for our octree such as refinement, finding the parents and children of a node and determining whether a leaf node exists.
There are two concepts here: A set of nested dyadic integer grids – A grid at level n has 2^n cells in each of the DIM dimensions and an adaptive octree defined by a subset of the grid cells from these nested grids. The former is a conceptual aid in the sense that it is implicitly encoded.
An octree block at level l is refined by adding its 2^DIM children blocks at level (l+1). The root of the octree covers the entire domains and has no parent. The leaf blocks of the octree have no children. The interior of the children do not overlap, and their union covers that of their parent block. Non-leaf blocks are referred to as 'internal'
Requirements for BlockDataType: it must be default constructible and provide an isLeaf() predicate as well as a setInternal() function that changes its state from representing a leaf block to an internal block.
Member Typedef Documentation
◆ CoordType
| using axom::spin::OctreeBase< DIM, BlockDataType >::CoordType = axom::IndexType |
◆ GridPt
| using axom::spin::OctreeBase< DIM, BlockDataType >::GridPt = primal::Point<CoordType, DIM> |
◆ GridVec
| using axom::spin::OctreeBase< DIM, BlockDataType >::GridVec = primal::Vector<CoordType, DIM> |
◆ MAX_LEVEL_SIZE
| using axom::spin::OctreeBase< DIM, BlockDataType >::MAX_LEVEL_SIZE = slam::policies::CompileTimeSize<CoordType, std::numeric_limits<CoordType>::digits> |
◆ OctreeLevels
| using axom::spin::OctreeBase< DIM, BlockDataType >::OctreeLevels = slam::OrderedSet<CoordType, CoordType, MAX_LEVEL_SIZE> |
◆ OctreeLevelType
| using axom::spin::OctreeBase< DIM, BlockDataType >::OctreeLevelType = OctreeLevel<DIM, BlockDataType> |
◆ LeafIndicesLevelMap
| using axom::spin::OctreeBase< DIM, BlockDataType >::LeafIndicesLevelMap = slam::Map<OctreeLevelType*> |
Constructor & Destructor Documentation
◆ OctreeBase()
|
inline |
Sets up an octree containing only the root block
References axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::level(), axom::spin::OctreeBase< DIM, BlockDataType >::m_leavesLevelMap, axom::spin::OctreeBase< DIM, BlockDataType >::maxLeafLevel(), axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::pt(), and axom::spin::OctreeBase< DIM, BlockDataType >::root().
◆ ~OctreeBase()
|
inline |
Member Function Documentation
◆ maxLeafLevel()
|
inline |
The max level for leaf blocks of the octree.
References axom::spin::OctreeBase< DIM, BlockDataType >::m_levels, and axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy, InterfacePolicy >::size().
◆ maxInternalLevel()
|
inline |
The max level for internal blocks of the octree.
References axom::spin::OctreeBase< DIM, BlockDataType >::m_levels, and axom::slam::OrderedSet< PosType, ElemType, SizePolicy, OffsetPolicy, StridePolicy, IndirectionPolicy, SubsettingPolicy, InterfacePolicy >::size().
◆ maxCoordAtLevel()
|
inlinestatic |
Utility function to find the number of (possible) grid cells at a given level or resolution.
- Parameters
-
[in] level The level or resolution.
- Precondition
- \( 0 \le lev */ static GridPt maxGridCellAtLevel(int level) { return GridPt(maxCoordAtLevel(level)); } /** \brief Finds the highest coordinate value at a given level or resolution \param [in] level The level or resolution. \pre \) 0 \le lev
◆ root()
|
inlinestatic |
Auxiliary function to return the root of the octree
- Note
- The root block has no parent. Its parent is an invalid BlockIndex. I.e. octree.parent( octree.root()).isValid() = false.
◆ parent() [1/2]
|
inline |
Finds the grid index and level of the current octree block's parent.
- Note
- The root level is 0 and its children are at level 1
- The root node has no parent. The returned level will be '-1'
- Parameters
-
[in] pt The grid index of the block whose parent we want to find. [in] level The level of the block whose parent we want to find.
- Returns
- The parent of the provided octree leaf.
References axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::parent().
◆ parent() [2/2]
|
inline |
Finds the BlockIndex of the given block's parent.
- Parameters
-
[in] block The block whose parent we want to find
- Returns
- The BlockIndex of the parent of the provided octree leaf.
References axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::parent().
◆ child() [1/2]
|
inline |
Finds the BlockIndex of the given block's child.
- Parameters
-
[in] pt The grid index of the block whose child we want to find. [in] level The level of the block whose child we want to find. [in] childIndex The index of the child to find
- Precondition
- \( 0 \le childIndex < 2^{DIM} \)
- Returns
- The BlockIndex of the child of the provided octree leaf.
References axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::child().
◆ child() [2/2]
|
inline |
Finds the BlockIndex of the given block's child.
- Parameters
-
[in] block The block whose child we want to find [in] childIndex The index of the child to find
- Precondition
- \( 0 \le childIndex < 2^{DIM} \)
- Returns
- The BlockIndex of the child of the provided octree leaf.
References axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::child().
◆ getOctreeLevel() [1/2]
|
inline |
Accessor for a reference to the octree level instance at level lev.
References axom::spin::OctreeBase< DIM, BlockDataType >::m_leavesLevelMap.
◆ getOctreeLevel() [2/2]
|
inline |
Const accessor for a reference to the octree level instance at level lev.
References axom::spin::OctreeBase< DIM, BlockDataType >::m_leavesLevelMap.
◆ isLevelValid()
|
inline |
Predicate to determine if level lev is in the range.
- Note
- lev is in range if 0 <= lev <= maxLeafLevel()
References axom::spin::OctreeBase< DIM, BlockDataType >::maxLeafLevel().
◆ isLeaf() [1/2]
|
inline |
Determine whether the octree contains a leaf block associated with grid point pt at level lev.
- Parameters
-
[in] pt The grid point to check [in] lev The level of the grid point
- Returns
- true if the associated block is a leaf in the octree, false otherwise
References axom::spin::OctreeBase< DIM, BlockDataType >::getOctreeLevel(), axom::spin::OctreeLevel< DIM, BlockDataType >::isLeaf(), and axom::spin::OctreeBase< DIM, BlockDataType >::isLevelValid().
◆ isLeaf() [2/2]
|
inline |
Determine whether the octree contains a leaf block associated with this BlockIndex.
- Parameters
-
[in] block The BlockIndex of the tree to check
- Returns
- true if the associated block is a leaf in the octree, false otherwise
References axom::spin::OctreeBase< DIM, BlockDataType >::getOctreeLevel(), axom::spin::OctreeLevel< DIM, BlockDataType >::isLeaf(), axom::spin::OctreeBase< DIM, BlockDataType >::isLevelValid(), axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::level(), and axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::pt().
◆ isInternal() [1/2]
|
inline |
Determine whether the octree contains an internal block associated with grid point pt at level lev.
- Parameters
-
[in] pt The grid point to check [in] lev The level of the grid point
- Returns
- true if the associated block is an internal block of the octree, false otherwise
References axom::spin::OctreeBase< DIM, BlockDataType >::getOctreeLevel(), axom::spin::OctreeLevel< DIM, BlockDataType >::isInternal(), and axom::spin::OctreeBase< DIM, BlockDataType >::isLevelValid().
◆ isInternal() [2/2]
|
inline |
Determine whether the octree contains an internal block associated with this BlockIndex.
- Parameters
-
[in] block The BlockIndex of the tree to check
- Returns
- true if the associated block is an internal block of the octree, false otherwise
References axom::spin::OctreeBase< DIM, BlockDataType >::getOctreeLevel(), axom::spin::OctreeLevel< DIM, BlockDataType >::isInternal(), axom::spin::OctreeBase< DIM, BlockDataType >::isLevelValid(), axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::level(), and axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::pt().
◆ hasBlock() [1/2]
|
inline |
Determine whether the octree contains a block (internal or leaf) associated with grid point pt at level lev.
- Parameters
-
[in] pt The grid point to check [in] lev The level of the grid point
- Returns
- true if the associated block is in the octree, false otherwise
References axom::spin::OctreeBase< DIM, BlockDataType >::isLevelValid(), axom::spin::OctreeBase< DIM, BlockDataType >::m_leavesLevelMap, and SLIC_ASSERT.
◆ hasBlock() [2/2]
|
inline |
Determine whether the octree contains a block (internal or leaf) associated with this BlockIndex.
- Parameters
-
[in] block The BlockIndex of the tree to check
- Returns
- true if the associated block is a block of the octree, false otherwise
References axom::spin::OctreeBase< DIM, BlockDataType >::hasBlock(), axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::level(), and axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::pt().
◆ inBounds() [1/2]
|
inline |
Determine whether the octree block associated with grid point pt and level lev is a possible block in this octree.
- Note
- A block index is out of bounds if its level is not in the tree, or its grid point is out of the range of possible grid points for its level
References axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::inBounds(), and axom::spin::OctreeBase< DIM, BlockDataType >::isLevelValid().
◆ inBounds() [2/2]
|
inline |
Determine whether the octree block associated with BlockIndex is a possible block in this octree.
- Note
- A block index is out of bounds if its level is not in the tree, or its grid point is out of the range of possible grid points for its level
References axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::inBounds(), axom::spin::OctreeBase< DIM, BlockDataType >::isLevelValid(), and axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::level().
◆ refineLeaf()
|
inline |
Refines the given leaf block in the octree.
Marks leafBlock as internal (non-leaf) and adds its children to the tree
- Precondition
- leafBlock is a valid leaf block in the octree.
References axom::spin::OctreeLevel< DIM, BlockDataType >::addAllChildren(), axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::childLevel(), axom::spin::OctreeBase< DIM, BlockDataType >::getOctreeLevel(), axom::spin::OctreeBase< DIM, BlockDataType >::isLeaf(), axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::level(), axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::pt(), and SLIC_ASSERT.
◆ operator[]() [1/2]
|
inline |
Accessor to the data associated with block.
- Parameters
-
block A block (internal or leaf) in the tree
- Precondition
- block is a leaf in the tree
References axom::spin::OctreeBase< DIM, BlockDataType >::hasBlock(), axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::level(), axom::spin::OctreeBase< DIM, BlockDataType >::m_leavesLevelMap, axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::pt(), SLIC_ASSERT, and SLIC_ASSERT_MSG.
◆ operator[]() [2/2]
|
inline |
Const accessor to the data associated with block.
- Parameters
-
block A block (internal or leaf) in the tree
- Precondition
- block is a leaf in the tree
References axom::spin::OctreeBase< DIM, BlockDataType >::hasBlock(), axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::level(), axom::spin::OctreeBase< DIM, BlockDataType >::m_leavesLevelMap, axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::pt(), SLIC_ASSERT, and SLIC_ASSERT_MSG.
◆ coveringLeafBlock()
|
inline |
Finds the finest octree leaf covering BlockIndex blk.
- Parameters
-
blk A BlockIndex, not necessarily in the octree checkInBounds A flag to determine if we should check that the block lies within the octree bounds (default=true)
- Postcondition
- The returned block, if valid, is blk or one of its ancestor blocks.
- Returns
- The blockIndex of the finest octree leaf covering blk, if it exists, BlockIndex::invalid_index otherwise (e.g. blk is an internal block of the tree or is out of bounds)
References axom::spin::BlockNotInTree, axom::spin::OctreeBase< DIM, BlockDataType >::blockStatus(), axom::spin::OctreeBase< DIM, BlockDataType >::hasBlock(), axom::spin::OctreeBase< DIM, BlockDataType >::inBounds(), axom::spin::InternalBlock, axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::invalid_index(), axom::spin::OctreeBase< DIM, BlockDataType >::isLeaf(), axom::spin::LeafBlock, axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::parent(), SLIC_ASSERT, and SLIC_ASSERT_MSG.
◆ blockStatus() [1/2]
|
inlineprotected |
Helper function to determine the status of a BlockIndex within an octree instance.
- Note
- This function is meant to help with implementing basic octree functionality and is not meant to be exposed in the public API
- Parameters
-
pt The grid point of the block index that we are testing lev The level of the block index that we are testing
References axom::spin::BlockNotInTree, axom::spin::OctreeBase< DIM, BlockDataType >::isLevelValid(), axom::spin::OctreeBase< DIM, BlockDataType >::m_leavesLevelMap, and SLIC_ASSERT.
◆ blockStatus() [2/2]
|
inlineprotected |
Helper function to determine the status of a BlockIndex within an octree instance.
- Note
- This function is meant to help with implementing basic octree functionality and is not meant to be exposed in the public API
- Parameters
-
blk The block index we are testing
References axom::spin::OctreeBase< DIM, BlockDataType >::blockStatus(), axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::level(), and axom::spin::OctreeBase< DIM, BlockDataType >::BlockIndex::pt().
Member Data Documentation
◆ m_levels
|
protected |
◆ m_leavesLevelMap
|
protected |
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/spin/OctreeBase.hpp
