VTK  9.3.20240328
Public Member Functions | List of all members
vtkHyperTreeGridGeometryLevelEntry Class Reference

Cursor cache data with coordinates and level info. More...

#include <vtkHyperTreeGridGeometryLevelEntry.h>

Public Member Functions

void PrintSelf (ostream &os, vtkIndent indent)
 Display info about the entry. More...
 
 vtkHyperTreeGridGeometryLevelEntry ()
 Constructor. More...
 
 vtkHyperTreeGridGeometryLevelEntry (vtkHyperTreeGridGeometryLevelEntry const &)=default
 
vtkHyperTreeGridGeometryLevelEntryoperator= (vtkHyperTreeGridGeometryLevelEntry const &)=default
 
 ~vtkHyperTreeGridGeometryLevelEntry ()=default
 Destructor. More...
 
void Dump (ostream &os)
 Dump information. More...
 
void Initialize (vtkHyperTree *tree, unsigned int level, vtkIdType index, const double *origin)
 Initialize cache entry from explicit required data. More...
 
vtkHyperTreeInitialize (vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
 Initialize cache entry at root of given tree index in grid. More...
 
void Reset ()
 Reset function. More...
 
void Copy (const vtkHyperTreeGridGeometryLevelEntry *entry)
 Copy function. More...
 
vtkSmartPointer< vtkHyperTreeGridOrientedGeometryCursorGetHyperTreeGridOrientedGeometryCursor (vtkHyperTreeGrid *grid)
 Create a vtkHyperTreeGridOrientedCursor from input grid and current entry data. More...
 
vtkSmartPointer< vtkHyperTreeGridNonOrientedGeometryCursorGetHyperTreeGridNonOrientedGeometryCursor (vtkHyperTreeGrid *grid)
 Create a vtkHyperTreeGridNonOrientedCursor from input grid and current entry data. More...
 
vtkIdType GetVertexId () const
 Return the index of the current vertex in the tree. More...
 
vtkIdType GetGlobalNodeIndex () const
 Return the global index (relative to the grid) of the current vertex in the tree. More...
 
void SetGlobalIndexStart (vtkIdType index)
 Set the global index for the root cell of the HyperTree. More...
 
void SetGlobalIndexFromLocal (vtkIdType index)
 Set the global index for the current cell of the HyperTree. More...
 
void SetMask (const vtkHyperTreeGrid *grid, bool state)
 Set the blanking mask is empty or not. More...
 
bool IsMasked (const vtkHyperTreeGrid *grid) const
 Determine whether blanking mask is empty or not. More...
 
bool IsLeaf (const vtkHyperTreeGrid *grid) const
 Is the cursor pointing to a leaf? More...
 
void SubdivideLeaf (const vtkHyperTreeGrid *grid)
 Change the current cell's status: if leaf then becomes coarse and all its children are created, cf. More...
 
bool IsTerminalNode (const vtkHyperTreeGrid *grid) const
 Is the cursor pointing to a coarse with all children being leaves ? More...
 
bool IsRoot ()
 Is the cursor at tree root? More...
 
void ToChild (const vtkHyperTreeGrid *grid, unsigned char ichild)
 Move the cursor to child ‘child’ of the current vertex. More...
 
vtkHyperTreeGetTree () const
 Get HyperTree from current cache entry. More...
 
unsigned int GetLevel () const
 Get level info from current cache entry. More...
 
double * GetOrigin ()
 Getter for origin coordinates of the current cell. More...
 
const double * GetOrigin () const
 
void GetBounds (double bounds[6]) const
 Getter for bounding box of the current cell. More...
 
void GetPoint (double point[3]) const
 Getter for center of the current cell. More...
 

Detailed Description

Cursor cache data with coordinates and level info.

cf. vtkHyperTreeGridEntry

See also
vtkHyperTreeGridEntry vtkHyperTreeGridLevelEntry vtkHyperTreeGridGeometryEntry vtkHyperTreeGridGeometryLevelEntry vtkHyperTreeGridNonOrientedSuperCursor vtkHyperTreeGridNonOrientedSuperCursorLight
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 39 of file vtkHyperTreeGridGeometryLevelEntry.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeGridGeometryLevelEntry() [1/2]

vtkHyperTreeGridGeometryLevelEntry::vtkHyperTreeGridGeometryLevelEntry ( )
inline

Constructor.

Definition at line 50 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ vtkHyperTreeGridGeometryLevelEntry() [2/2]

vtkHyperTreeGridGeometryLevelEntry::vtkHyperTreeGridGeometryLevelEntry ( vtkHyperTreeGridGeometryLevelEntry const &  )
default

◆ ~vtkHyperTreeGridGeometryLevelEntry()

vtkHyperTreeGridGeometryLevelEntry::~vtkHyperTreeGridGeometryLevelEntry ( )
default

Destructor.

Member Function Documentation

◆ PrintSelf()

void vtkHyperTreeGridGeometryLevelEntry::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

Display info about the entry.

◆ operator=()

vtkHyperTreeGridGeometryLevelEntry& vtkHyperTreeGridGeometryLevelEntry::operator= ( vtkHyperTreeGridGeometryLevelEntry const &  )
default

◆ Dump()

void vtkHyperTreeGridGeometryLevelEntry::Dump ( ostream &  os)

Dump information.

◆ Initialize() [1/2]

void vtkHyperTreeGridGeometryLevelEntry::Initialize ( vtkHyperTree tree,
unsigned int  level,
vtkIdType  index,
const double *  origin 
)
inline

Initialize cache entry from explicit required data.

Definition at line 78 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ Initialize() [2/2]

vtkHyperTree* vtkHyperTreeGridGeometryLevelEntry::Initialize ( vtkHyperTreeGrid grid,
vtkIdType  treeIndex,
bool  create = false 
)

Initialize cache entry at root of given tree index in grid.

◆ Reset()

void vtkHyperTreeGridGeometryLevelEntry::Reset ( )
inline

Reset function.

Definition at line 97 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ Copy()

void vtkHyperTreeGridGeometryLevelEntry::Copy ( const vtkHyperTreeGridGeometryLevelEntry entry)
inline

Copy function.

Definition at line 106 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ GetHyperTreeGridOrientedGeometryCursor()

vtkSmartPointer<vtkHyperTreeGridOrientedGeometryCursor> vtkHyperTreeGridGeometryLevelEntry::GetHyperTreeGridOrientedGeometryCursor ( vtkHyperTreeGrid grid)
inline

Create a vtkHyperTreeGridOrientedCursor from input grid and current entry data.

Definition at line 115 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ GetHyperTreeGridNonOrientedGeometryCursor()

vtkSmartPointer<vtkHyperTreeGridNonOrientedGeometryCursor> vtkHyperTreeGridGeometryLevelEntry::GetHyperTreeGridNonOrientedGeometryCursor ( vtkHyperTreeGrid grid)
inline

Create a vtkHyperTreeGridNonOrientedCursor from input grid and current entry data.

Definition at line 129 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ GetVertexId()

vtkIdType vtkHyperTreeGridGeometryLevelEntry::GetVertexId ( ) const
inline

Return the index of the current vertex in the tree.

Precondition
not_tree: tree

Definition at line 142 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ GetGlobalNodeIndex()

vtkIdType vtkHyperTreeGridGeometryLevelEntry::GetGlobalNodeIndex ( ) const

Return the global index (relative to the grid) of the current vertex in the tree.

Precondition
not_tree: tree

◆ SetGlobalIndexStart()

void vtkHyperTreeGridGeometryLevelEntry::SetGlobalIndexStart ( vtkIdType  index)

Set the global index for the root cell of the HyperTree.

Precondition
not_tree: tree

◆ SetGlobalIndexFromLocal()

void vtkHyperTreeGridGeometryLevelEntry::SetGlobalIndexFromLocal ( vtkIdType  index)

Set the global index for the current cell of the HyperTree.

Precondition
not_tree: tree

◆ SetMask()

void vtkHyperTreeGridGeometryLevelEntry::SetMask ( const vtkHyperTreeGrid grid,
bool  state 
)

Set the blanking mask is empty or not.

Precondition
not_tree: tree

◆ IsMasked()

bool vtkHyperTreeGridGeometryLevelEntry::IsMasked ( const vtkHyperTreeGrid grid) const

Determine whether blanking mask is empty or not.

Precondition
not_tree: tree

◆ IsLeaf()

bool vtkHyperTreeGridGeometryLevelEntry::IsLeaf ( const vtkHyperTreeGrid grid) const

Is the cursor pointing to a leaf?

Precondition
not_tree: tree Return true if level == grid->GetDepthLimiter()

◆ SubdivideLeaf()

void vtkHyperTreeGridGeometryLevelEntry::SubdivideLeaf ( const vtkHyperTreeGrid grid)

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()

bool vtkHyperTreeGridGeometryLevelEntry::IsTerminalNode ( const vtkHyperTreeGrid grid) const

Is the cursor pointing to a coarse with all children being leaves ?

Precondition
not_tree: tree

◆ IsRoot()

bool vtkHyperTreeGridGeometryLevelEntry::IsRoot ( )
inline

Is the cursor at tree root?

Definition at line 200 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ ToChild()

void vtkHyperTreeGridGeometryLevelEntry::ToChild ( const vtkHyperTreeGrid grid,
unsigned char  ichild 
)

Move the cursor to child ‘child’ of the current vertex.

Precondition
not_tree: tree
not_leaf: !IsLeaf()
valid_child: ichild>=0 && ichild<this->GetNumberOfChildren()
depth_limiter: level == grid->GetDepthLimiter()
is_masked: !IsMasked()

◆ GetTree()

vtkHyperTree* vtkHyperTreeGridGeometryLevelEntry::GetTree ( ) const
inline

Get HyperTree from current cache entry.

Definition at line 215 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ GetLevel()

unsigned int vtkHyperTreeGridGeometryLevelEntry::GetLevel ( ) const
inline

Get level info from current cache entry.

Definition at line 220 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ GetOrigin() [1/2]

double* vtkHyperTreeGridGeometryLevelEntry::GetOrigin ( )
inline

Getter for origin coordinates of the current cell.

Definition at line 225 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ GetOrigin() [2/2]

const double* vtkHyperTreeGridGeometryLevelEntry::GetOrigin ( ) const
inline

Definition at line 226 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ GetBounds()

void vtkHyperTreeGridGeometryLevelEntry::GetBounds ( double  bounds[6]) const

Getter for bounding box of the current cell.

◆ GetPoint()

void vtkHyperTreeGridGeometryLevelEntry::GetPoint ( double  point[3]) const

Getter for center of the current cell.


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