VTK  9.2.6
Public Member Functions | List of all members
vtkHyperTreeGridGeometryEntry Class Reference

JB. More...

#include <vtkHyperTreeGridGeometryEntry.h>

Public Member Functions

void PrintSelf (ostream &os, vtkIndent indent)
 Display info about the entry. More...
 
 vtkHyperTreeGridGeometryEntry ()
 Constructor. More...
 
 vtkHyperTreeGridGeometryEntry (vtkIdType index, const double *origin)
 Constructor. More...
 
 ~vtkHyperTreeGridGeometryEntry ()=default
 Destructor. More...
 
void Dump (ostream &os)
 Dump information. More...
 
vtkHyperTreeInitialize (vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
 Initialize cursor at root of given tree index in grid. More...
 
void Initialize (vtkIdType index, const double *origin)
 Initialize cursor from explicit required data. More...
 
void Copy (const vtkHyperTreeGridGeometryEntry *entry)
 Copy function. More...
 
vtkIdType GetVertexId () const
 Return the index of the current vertex in the tree. More...
 
vtkIdType GetGlobalNodeIndex (const vtkHyperTree *tree) const
 Return the global index (relative to the grid) of the current vertex in the tree. More...
 
void SetGlobalIndexStart (vtkHyperTree *tree, vtkIdType index)
 Set the global index for the root cell of the HyperTree. More...
 
void SetGlobalIndexFromLocal (vtkHyperTree *tree, vtkIdType index)
 Set the global index for the current cell of the HyperTree. More...
 
void SetMask (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, bool state)
 Set the blanking mask is empty or not. More...
 
bool IsMasked (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree) const
 Determine whether blanking mask is empty or not. More...
 
bool IsLeaf (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, unsigned int level) const
 Is the cursor pointing to a leaf? More...
 
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. More...
 
bool IsTerminalNode (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, unsigned int level) const
 Is the cursor pointing to a coarse with all childrens leaves ? More...
 
bool IsRoot () const
 Is the cursor at tree root? More...
 
void ToChild (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, unsigned int level, const double *sizeChild, unsigned char ichild)
 Move the cursor to child `child' of the current vertex. More...
 
double * GetOrigin ()
 Getter for origin coordinates of the current cell. More...
 
const double * GetOrigin () const
 
void GetBounds (const double *sizeChild, double bounds[6]) const
 Getter for bounding box of the current cell. More...
 
void GetPoint (const double *sizeChild, double point[3]) const
 Getter for center of the current cell. More...
 

Detailed Description

JB.

GeometryEntry is a cache data for cursors requiring coordinates

cf. vtkHyperTreeGridEntry

See also
vtkHyperTreeGridEntry vtkHyperTreeGridLevelEntry vtkHyperTreeGridGeometryEntry vtkHyperTreeGridGeometryLevelEntry vtkHyperTreeGridNonOrientedGeometryCursor 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 46 of file vtkHyperTreeGridGeometryEntry.h.

Constructor & Destructor Documentation

vtkHyperTreeGridGeometryEntry::vtkHyperTreeGridGeometryEntry ( )

Constructor.

vtkHyperTreeGridGeometryEntry::vtkHyperTreeGridGeometryEntry ( vtkIdType  index,
const double *  origin 
)
inline

Constructor.

Definition at line 62 of file vtkHyperTreeGridGeometryEntry.h.

vtkHyperTreeGridGeometryEntry::~vtkHyperTreeGridGeometryEntry ( )
default

Destructor.

Member Function Documentation

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

Display info about the entry.

void vtkHyperTreeGridGeometryEntry::Dump ( ostream &  os)

Dump information.

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

Initialize cursor at root of given tree index in grid.

void vtkHyperTreeGridGeometryEntry::Initialize ( vtkIdType  index,
const double *  origin 
)
inline

Initialize cursor from explicit required data.

Definition at line 89 of file vtkHyperTreeGridGeometryEntry.h.

void vtkHyperTreeGridGeometryEntry::Copy ( const vtkHyperTreeGridGeometryEntry entry)
inline

Copy function.

Definition at line 101 of file vtkHyperTreeGridGeometryEntry.h.

vtkIdType vtkHyperTreeGridGeometryEntry::GetVertexId ( ) const
inline

Return the index of the current vertex in the tree.

Definition at line 113 of file vtkHyperTreeGridGeometryEntry.h.

vtkIdType vtkHyperTreeGridGeometryEntry::GetGlobalNodeIndex ( const vtkHyperTree tree) const

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

Precondition
not_tree: tree
void vtkHyperTreeGridGeometryEntry::SetGlobalIndexStart ( vtkHyperTree tree,
vtkIdType  index 
)

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

Precondition
not_tree: tree
void vtkHyperTreeGridGeometryEntry::SetGlobalIndexFromLocal ( vtkHyperTree tree,
vtkIdType  index 
)

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

Precondition
not_tree: tree
void vtkHyperTreeGridGeometryEntry::SetMask ( const vtkHyperTreeGrid grid,
const vtkHyperTree tree,
bool  state 
)

Set the blanking mask is empty or not.

Precondition
not_tree: tree
bool vtkHyperTreeGridGeometryEntry::IsMasked ( const vtkHyperTreeGrid grid,
const vtkHyperTree tree 
) const

Determine whether blanking mask is empty or not.

Precondition
not_tree: tree
bool vtkHyperTreeGridGeometryEntry::IsLeaf ( const vtkHyperTreeGrid grid,
const vtkHyperTree tree,
unsigned int  level 
) const

Is the cursor pointing to a leaf?

Precondition
not_tree: tree Return true if level == grid->GetDepthLimiter()
void vtkHyperTreeGridGeometryEntry::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.

HyperTree.

Precondition
not_tree: tree
depth_limiter: level == grid->GetDepthLimiter()
is_masked: IsMasked
bool vtkHyperTreeGridGeometryEntry::IsTerminalNode ( const vtkHyperTreeGrid grid,
const vtkHyperTree tree,
unsigned int  level 
) const

Is the cursor pointing to a coarse with all childrens leaves ?

Precondition
not_tree: tree
bool vtkHyperTreeGridGeometryEntry::IsRoot ( ) const
inline

Is the cursor at tree root?

Definition at line 172 of file vtkHyperTreeGridGeometryEntry.h.

void vtkHyperTreeGridGeometryEntry::ToChild ( const vtkHyperTreeGrid grid,
const vtkHyperTree tree,
unsigned int  level,
const double *  sizeChild,
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()
double* vtkHyperTreeGridGeometryEntry::GetOrigin ( )
inline

Getter for origin coordinates of the current cell.

Definition at line 188 of file vtkHyperTreeGridGeometryEntry.h.

const double* vtkHyperTreeGridGeometryEntry::GetOrigin ( ) const
inline

Definition at line 189 of file vtkHyperTreeGridGeometryEntry.h.

void vtkHyperTreeGridGeometryEntry::GetBounds ( const double *  sizeChild,
double  bounds[6] 
) const
inline

Getter for bounding box of the current cell.

Definition at line 194 of file vtkHyperTreeGridGeometryEntry.h.

void vtkHyperTreeGridGeometryEntry::GetPoint ( const double *  sizeChild,
double  point[3] 
) const
inline

Getter for center of the current cell.

Definition at line 208 of file vtkHyperTreeGridGeometryEntry.h.


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