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.

	vtkHyperTreeGridGeometryLevelEntry ()
	Constructor.

	~vtkHyperTreeGridGeometryLevelEntry ()=default
	Destructor.

void	Dump (ostream &os)
	Dump information.

void	Initialize (vtkHyperTree tree, unsigned int level, vtkIdType index, const double origin)
	Initialize cache entry from explicit required data.

vtkHyperTree *	Initialize (vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
	Initialize cache entry at root of given tree index in grid.

void	Reset ()
	Reset function.

void	Copy (const vtkHyperTreeGridGeometryLevelEntry *entry)
	Copy function.

vtkSmartPointer< vtkHyperTreeGridOrientedGeometryCursor >	GetHyperTreeGridOrientedGeometryCursor (vtkHyperTreeGrid *grid)
	Create a vtkHyperTreeGridOrientedCursor from input grid and current entry data.

vtkSmartPointer< vtkHyperTreeGridNonOrientedGeometryCursor >	GetHyperTreeGridNonOrientedGeometryCursor (vtkHyperTreeGrid *grid)
	Create a vtkHyperTreeGridNonOrientedCursor from input grid and current entry data.

vtkIdType	GetVertexId () const
	Return the index of the current vertex in the tree.

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

void	SetGlobalIndexStart (vtkIdType index)
	Set the global index for the root cell of the HyperTree.

void	SetGlobalIndexFromLocal (vtkIdType index)
	Set the global index for the current cell of the HyperTree.

void	SetMask (const vtkHyperTreeGrid *grid, bool state)
	Set the blanking mask is empty or not.

bool	IsMasked (const vtkHyperTreeGrid *grid) const
	Determine whether blanking mask is empty or not.

bool	IsLeaf (const vtkHyperTreeGrid *grid) const
	Is the cursor pointing to a leaf?

void	SubdivideLeaf (const vtkHyperTreeGrid *grid)
	Change the current cell's status: if leaf then becomes coarse and all its children are created, cf.

bool	IsTerminalNode (const vtkHyperTreeGrid *grid) const
	Is the cursor pointing to a coarse with all childrens being leaves ?

bool	IsRoot ()
	Is the cursor at tree root?

void	ToChild (const vtkHyperTreeGrid *grid, unsigned char ichild)
	Move the cursor to child ‘child’ of the current vertex.

vtkHyperTree *	GetTree () const
	Get HyperTree from current cache entry.

unsigned int	GetLevel () const
	Get level info from current cache entry.

double *	GetOrigin ()
	Getter for origin coordinates of the current cell.

const double *	GetOrigin () const

void	GetBounds (double bounds[6]) const
	Getter for bounding box of the current cell.

void	GetPoint (double point[3]) const
	Getter for center of the current cell.

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 52 of file vtkHyperTreeGridGeometryLevelEntry.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeGridGeometryLevelEntry()

vtkHyperTreeGridGeometryLevelEntry::vtkHyperTreeGridGeometryLevelEntry ( )

inline

Constructor.

Definition at line 63 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ ~vtkHyperTreeGridGeometryLevelEntry()

vtkHyperTreeGridGeometryLevelEntry::~vtkHyperTreeGridGeometryLevelEntry ( )

default

Destructor.

Member Function Documentation

◆ PrintSelf()

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

Display info about the entry.

◆ 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 87 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 106 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ Copy()

void vtkHyperTreeGridGeometryLevelEntry::Copy ( const vtkHyperTreeGridGeometryLevelEntry * entry )

inline

Copy function.

Definition at line 115 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 124 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 138 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 151 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 childrens being leaves ?

Precondition: not_tree: tree

◆ IsRoot()

bool vtkHyperTreeGridGeometryLevelEntry::IsRoot ( )

inline

Is the cursor at tree root?

Definition at line 209 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 224 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ GetLevel()

unsigned int vtkHyperTreeGridGeometryLevelEntry::GetLevel ( ) const

inline

Get level info from current cache entry.

Definition at line 229 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ GetOrigin() [1/2]

double * vtkHyperTreeGridGeometryLevelEntry::GetOrigin ( )

inline

Getter for origin coordinates of the current cell.

Definition at line 234 of file vtkHyperTreeGridGeometryLevelEntry.h.

◆ GetOrigin() [2/2]

const double * vtkHyperTreeGridGeometryLevelEntry::GetOrigin ( ) const

inline

Definition at line 235 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:

Common/DataModel/vtkHyperTreeGridGeometryLevelEntry.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ vtkHyperTreeGridGeometryLevelEntry()

◆ ~vtkHyperTreeGridGeometryLevelEntry()

Member Function Documentation

◆ PrintSelf()

◆ Dump()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ Reset()

◆ Copy()

◆ GetHyperTreeGridOrientedGeometryCursor()

◆ GetHyperTreeGridNonOrientedGeometryCursor()

◆ GetVertexId()

◆ GetGlobalNodeIndex()

◆ SetGlobalIndexStart()

◆ SetGlobalIndexFromLocal()

◆ SetMask()

◆ IsMasked()

◆ IsLeaf()

◆ SubdivideLeaf()

◆ IsTerminalNode()

◆ IsRoot()

◆ ToChild()

◆ GetTree()

◆ GetLevel()

◆ GetOrigin() [1/2]

◆ GetOrigin() [2/2]

◆ GetBounds()

◆ GetPoint()