LevelEntry is a cache data for cursors requiring level info. More...

#include <vtkHyperTreeGridLevelEntry.h>

Collaboration diagram for vtkHyperTreeGridLevelEntry:

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent)
	Display info about the entry.

void	Dump (ostream &os)
	Dump information.

	vtkHyperTreeGridLevelEntry ()
	Constructor.

	vtkHyperTreeGridLevelEntry (vtkHyperTreeGridLevelEntry *entry)
	Constructor.

	vtkHyperTreeGridLevelEntry (vtkHyperTree *tree, unsigned int level, vtkIdType index)
	Constructor.

	vtkHyperTreeGridLevelEntry (vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
	Constructor.

	~vtkHyperTreeGridLevelEntry ()=default
	Destructor.

void	Reset ()
	Reset function.

void	Initialize (vtkHyperTree *tree, unsigned int level, vtkIdType index)
	Initialize cursor from explicit required data.

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

void	Copy (const vtkHyperTreeGridLevelEntry *entry)
	Copy function.

vtkSmartPointer< vtkHyperTreeGridNonOrientedCursor >	GetHyperTreeGridNonOrientedCursor (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 () const
	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.

Protected Attributes
vtkHyperTree *	Tree
	pointer to the HyperTree containing the current cell.

unsigned int	Level
	level of the current cell in the HyperTree.

vtkIdType	Index
	index of the current cell in the HyperTree.

Detailed Description

LevelEntry is a cache data for cursors requiring 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 48 of file vtkHyperTreeGridLevelEntry.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeGridLevelEntry() [1/4]

vtkHyperTreeGridLevelEntry::vtkHyperTreeGridLevelEntry ( )

inline

Constructor.

Definition at line 64 of file vtkHyperTreeGridLevelEntry.h.

◆ vtkHyperTreeGridLevelEntry() [2/4]

vtkHyperTreeGridLevelEntry::vtkHyperTreeGridLevelEntry ( vtkHyperTreeGridLevelEntry * entry )

inline

Constructor.

Definition at line 74 of file vtkHyperTreeGridLevelEntry.h.

◆ vtkHyperTreeGridLevelEntry() [3/4]

vtkHyperTreeGridLevelEntry::vtkHyperTreeGridLevelEntry	(	vtkHyperTree *	tree,
		unsigned int	level,
		vtkIdType	index
	)

inline

Constructor.

Definition at line 84 of file vtkHyperTreeGridLevelEntry.h.

◆ vtkHyperTreeGridLevelEntry() [4/4]

vtkHyperTreeGridLevelEntry::vtkHyperTreeGridLevelEntry	(	vtkHyperTreeGrid *	grid,
		vtkIdType	treeIndex,
		bool	create = `false`
	)

Constructor.

◆ ~vtkHyperTreeGridLevelEntry()

vtkHyperTreeGridLevelEntry::~vtkHyperTreeGridLevelEntry ( )

default

Destructor.

Member Function Documentation

◆ PrintSelf()

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

Display info about the entry.

◆ Dump()

void vtkHyperTreeGridLevelEntry::Dump ( ostream & os )

Dump information.

◆ Reset()

void vtkHyperTreeGridLevelEntry::Reset ( )

inline

Reset function.

Definition at line 104 of file vtkHyperTreeGridLevelEntry.h.

◆ Initialize() [1/2]

void vtkHyperTreeGridLevelEntry::Initialize	(	vtkHyperTree *	tree,
		unsigned int	level,
		vtkIdType	index
	)

inline

Initialize cursor from explicit required data.

Definition at line 114 of file vtkHyperTreeGridLevelEntry.h.

◆ Initialize() [2/2]

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

Initialize cursor at root of given tree index in grid.

◆ Copy()

void vtkHyperTreeGridLevelEntry::Copy ( const vtkHyperTreeGridLevelEntry * entry )

inline

Copy function.

Definition at line 129 of file vtkHyperTreeGridLevelEntry.h.

◆ GetHyperTreeGridNonOrientedCursor()

vtkSmartPointer< vtkHyperTreeGridNonOrientedCursor > vtkHyperTreeGridLevelEntry::GetHyperTreeGridNonOrientedCursor ( vtkHyperTreeGrid * grid )

Create a vtkHyperTreeGridNonOrientedCursor from input grid and current entry data.

◆ GetVertexId()

vtkIdType vtkHyperTreeGridLevelEntry::GetVertexId ( ) const

inline

Return the index of the current vertex in the tree.

Definition at line 146 of file vtkHyperTreeGridLevelEntry.h.

◆ GetGlobalNodeIndex()

vtkIdType vtkHyperTreeGridLevelEntry::GetGlobalNodeIndex ( ) const

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

◆ SetGlobalIndexStart()

void vtkHyperTreeGridLevelEntry::SetGlobalIndexStart ( vtkIdType index )

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

Precondition: not_tree: tree

◆ SetGlobalIndexFromLocal()

void vtkHyperTreeGridLevelEntry::SetGlobalIndexFromLocal ( vtkIdType index )

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

Precondition: not_tree: tree

◆ SetMask()

void vtkHyperTreeGridLevelEntry::SetMask	(	const vtkHyperTreeGrid *	grid,
		bool	state
	)

Set the blanking mask is empty or not.

Precondition: not_tree: tree

◆ IsMasked()

bool vtkHyperTreeGridLevelEntry::IsMasked ( const vtkHyperTreeGrid * grid ) const

Determine whether blanking mask is empty or not.

Precondition: not_tree: tree

◆ IsLeaf()

bool vtkHyperTreeGridLevelEntry::IsLeaf ( const vtkHyperTreeGrid * grid ) const

Is the cursor pointing to a leaf?

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

◆ SubdivideLeaf()

void vtkHyperTreeGridLevelEntry::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 vtkHyperTreeGridLevelEntry::IsTerminalNode ( const vtkHyperTreeGrid * grid ) const

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

Precondition: not_tree: tree

◆ IsRoot()

bool vtkHyperTreeGridLevelEntry::IsRoot ( ) const

inline

Is the cursor at tree root?

Definition at line 203 of file vtkHyperTreeGridLevelEntry.h.

◆ ToChild()

void vtkHyperTreeGridLevelEntry::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 * vtkHyperTreeGridLevelEntry::GetTree ( ) const

inline

Get HyperTree from current cache entry.

Definition at line 218 of file vtkHyperTreeGridLevelEntry.h.

◆ GetLevel()

unsigned int vtkHyperTreeGridLevelEntry::GetLevel ( ) const

inline

Get level info from current cache entry.

Definition at line 223 of file vtkHyperTreeGridLevelEntry.h.

Member Data Documentation

◆ Tree

vtkHyperTree* vtkHyperTreeGridLevelEntry::Tree

protected

pointer to the HyperTree containing the current cell.

Definition at line 229 of file vtkHyperTreeGridLevelEntry.h.

◆ Level

unsigned int vtkHyperTreeGridLevelEntry::Level

protected

level of the current cell in the HyperTree.

Definition at line 234 of file vtkHyperTreeGridLevelEntry.h.

◆ Index

vtkIdType vtkHyperTreeGridLevelEntry::Index

protected

index of the current cell in the HyperTree.

Definition at line 239 of file vtkHyperTreeGridLevelEntry.h.

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

Common/DataModel/vtkHyperTreeGridLevelEntry.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ vtkHyperTreeGridLevelEntry() [1/4]

◆ vtkHyperTreeGridLevelEntry() [2/4]

◆ vtkHyperTreeGridLevelEntry() [3/4]

◆ vtkHyperTreeGridLevelEntry() [4/4]

◆ ~vtkHyperTreeGridLevelEntry()

Member Function Documentation

◆ PrintSelf()

◆ Dump()

◆ Reset()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ Copy()

◆ GetHyperTreeGridNonOrientedCursor()

◆ GetVertexId()

◆ GetGlobalNodeIndex()

◆ SetGlobalIndexStart()

◆ SetGlobalIndexFromLocal()

◆ SetMask()

◆ IsMasked()

◆ IsLeaf()

◆ SubdivideLeaf()

◆ IsTerminalNode()

◆ IsRoot()

◆ ToChild()

◆ GetTree()

◆ GetLevel()

Member Data Documentation

◆ Tree

◆ Level

◆ Index