Entries are cache data for cursors.
More...
#include <vtkHyperTreeGridEntry.h>
|
| void | PrintSelf (ostream &os, vtkIndent indent) |
| | Display info about the entry.
|
| |
| void | Dump (ostream &os) |
| | Dump information.
|
| |
| | vtkHyperTreeGridEntry () |
| | Constructor.
|
| |
| | vtkHyperTreeGridEntry (vtkHyperTreeGridEntry const &)=default |
| |
| vtkHyperTreeGridEntry & | operator= (vtkHyperTreeGridEntry const &)=default |
| |
| | vtkHyperTreeGridEntry (vtkIdType index) |
| | Constructor.
|
| |
| | ~vtkHyperTreeGridEntry ()=default |
| | Destructor.
|
| |
| vtkHyperTree * | Initialize (vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false) |
| | Initialize cursor at root of given tree index in grid.
|
| |
| void | Initialize (vtkIdType index) |
| | Initialize cursor at root of given tree index in grid.
|
| |
| void | Copy (const vtkHyperTreeGridEntry *entry) |
| | Copy function.
|
| |
| vtkIdType | GetVertexId () const |
| | Return the index of the current vertex in the tree.
|
| |
| vtkIdType | GetGlobalNodeIndex (const vtkHyperTree *tree) const |
| | Return the global index for the current cell (cf.
|
| |
| void | SetGlobalIndexStart (vtkHyperTree *tree, vtkIdType index) |
| | Set the global index for the root cell of the HyperTree.
|
| |
| void | SetGlobalIndexFromLocal (vtkHyperTree *tree, vtkIdType index) |
| | Set the global index for the current cell of the HyperTree.
|
| |
| void | SetMask (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, bool state) |
| | Set the blanking mask is empty or not.
|
| |
| bool | IsMasked (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree) const |
| | Determine whether blanking mask is empty or not.
|
| |
| bool | IsLeaf (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, unsigned int level) const |
| | Is the cursor pointing to a leaf?
|
| |
| void | SubdivideLeaf (const vtkHyperTreeGrid *grid, vtkHyperTree *tree, unsigned int level) |
| | Change the current cell's status: if leaf then becomes coarse and all its children are created, cf.
|
| |
| bool | IsTerminalNode (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, unsigned int level) const |
| | Is the cursor pointing to a coarse with all children being leaves?
|
| |
| bool | IsRoot () const |
| | Is the cursor at HyperTree root?
|
| |
| void | ToChild (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, unsigned int level, unsigned char ichild) |
| | Move the cursor to i-th child of the current cell.
|
| |
Entries are cache data for cursors.
Entries are relevant for cursor/supercursor developers. Filters developers should have a look at cursors/supercursors documentation. (cf. vtkHyperTreeGridNonOrientedCursor). When writing a new cursor or supercursor the choice of the entry is very important: it will drive the performance and memory cost. This is even more important for supercursors which have several neighbors: 6x for VonNeuman and 26x for Moore.
Several types of Entries exist:
- vtkHyperTreeGridEntry This cache only memorizes the current cell index in one HyperTree. Using the index, this entry provides several services such as: is the cell coarse or leaf, get or set global index (to access field value, cf. vtkHyperTree), descend into selected child, subdivise the cell. Equivalent services are available for all entries.
- vtkHyperTreeGridGeometryEntry This cache adds the origin coordinates of the cell atop vtkHyperTreeGridEntry. Getter is provided, as well as services related to the bounding box and cell center.
- vtkHyperTreeGridLevelEntry This cache adds the following information with their getters atop vtkHyperTreeGridEntry: pointer to the HyperTree, level of the current cell.
- vtkHyperTreeGridGeometryLevelEntry This cache is a combination of vtkHyperTreeGridLevelEntry and vtkHyperTreeGridLevelEntry: it provides all combined services.
- See also
- vtkHyperTreeGridEntry vtkHyperTreeGridLevelEntry vtkHyperTreeGridGeometryEntry vtkHyperTreeGridGeometryLevelEntry vtkHyperTreeGridOrientedCursor vtkHyperTreeGridNonOrientedCursor
- Thanks:
- This class was written by Jacques-Bernard Lekien, Jerome Dubois and Guenole Harel, CEA 2018. This work was supported by Commissariat a l'Energie Atomique CEA, DAM, DIF, F-91297 Arpajon, France.
Definition at line 61 of file vtkHyperTreeGridEntry.h.
◆ vtkHyperTreeGridEntry() [1/3]
| vtkHyperTreeGridEntry::vtkHyperTreeGridEntry |
( |
| ) |
|
|
inline |
◆ vtkHyperTreeGridEntry() [2/3]
◆ vtkHyperTreeGridEntry() [3/3]
| vtkHyperTreeGridEntry::vtkHyperTreeGridEntry |
( |
vtkIdType |
index | ) |
|
|
inline |
◆ ~vtkHyperTreeGridEntry()
| vtkHyperTreeGridEntry::~vtkHyperTreeGridEntry |
( |
| ) |
|
|
default |
◆ PrintSelf()
| void vtkHyperTreeGridEntry::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
| |
Display info about the entry.
◆ Dump()
| void vtkHyperTreeGridEntry::Dump |
( |
ostream & |
os | ) |
|
◆ operator=()
◆ Initialize() [1/2]
Initialize cursor at root of given tree index in grid.
◆ Initialize() [2/2]
| void vtkHyperTreeGridEntry::Initialize |
( |
vtkIdType |
index | ) |
|
|
inline |
◆ Copy()
◆ GetVertexId()
| vtkIdType vtkHyperTreeGridEntry::GetVertexId |
( |
| ) |
const |
|
inline |
◆ GetGlobalNodeIndex()
Return the global index for the current cell (cf.
vtkHyperTree).
- Precondition
- not_tree: tree
◆ SetGlobalIndexStart()
Set the global index for the root cell of the HyperTree.
- Precondition
- not_tree: tree
◆ SetGlobalIndexFromLocal()
Set the global index for the current cell of the HyperTree.
- Precondition
- not_tree: tree
◆ SetMask()
Set the blanking mask is empty or not.
- Precondition
- not_tree: tree
◆ IsMasked()
Determine whether blanking mask is empty or not.
- Precondition
- not_tree: tree
◆ IsLeaf()
Is the cursor pointing to a leaf?
- Precondition
- not_tree: tree Return true if level == grid->GetDepthLimiter()
◆ SubdivideLeaf()
Change the current cell's status: if leaf then becomes coarse and all its children are created, cf.
HyperTree.
- Precondition
- not_tree: tree
-
depth_limiter: level == grid->GetDepthLimiter()
-
is_masked: IsMasked
◆ IsTerminalNode()
Is the cursor pointing to a coarse with all children being leaves?
- Precondition
- not_tree: tree
◆ IsRoot()
| bool vtkHyperTreeGridEntry::IsRoot |
( |
| ) |
const |
|
inline |
◆ ToChild()
Move the cursor to i-th child of the current cell.
- Precondition
- not_tree: tree
-
not_leaf: !IsLeaf()
-
valid_child: ichild>=0 && ichild<this->GetNumberOfChildren()
-
depth_limiter: level == grid->GetDepthLimiter()
-
is_masked: !IsMasked()
◆ Index
The documentation for this class was generated from the following file: