GeometryUnlimitedEntry is a cache data for cursors requiring coordinates. More...

#include <vtkHyperTreeGridGeometryUnlimitedEntry.h>

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

	vtkHyperTreeGridGeometryUnlimitedEntry ()
	Constructor. More...

	vtkHyperTreeGridGeometryUnlimitedEntry (vtkIdType index, const double *origin)
	Constructor assume construction from a real level. More...

	~vtkHyperTreeGridGeometryUnlimitedEntry ()=default
	Destructor. More...

void	Dump (ostream &os)
	Dump information. More...

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

void	Initialize (vtkIdType index, vtkIdType lastIndex, const double *origin)
	Initialize cursor from explicit required data. More...

void	Copy (const vtkHyperTreeGridGeometryUnlimitedEntry *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? Unlimited cursors allow to go deeper than a real leaf. More...

bool	IsRealLeaf (const vtkHyperTree *tree) const
	Is the cursor pointing to a real leaf of the underlying tree ? More...

bool	IsVirtualLeaf (const vtkHyperTree *tree) const
	Is the cursor pointing below a real leaf of the underlying tree ? More...

bool	IsTerminalNode (const vtkHyperTreeGrid grid, const vtkHyperTree tree, unsigned int level) const
	Is the cursor pointing to a coarse with all children 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

GeometryUnlimitedEntry is a cache data for cursors requiring coordinates.

cf. vtkHyperTreeGridEntry

See also: vtkHyperTreeGridEntry vtkHyperTreeGridLevelEntry vtkHyperTreeGridGeometryUnlimitedEntry 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 34 of file vtkHyperTreeGridGeometryUnlimitedEntry.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeGridGeometryUnlimitedEntry() [1/2]

vtkHyperTreeGridGeometryUnlimitedEntry::vtkHyperTreeGridGeometryUnlimitedEntry ( )

Constructor.

◆ vtkHyperTreeGridGeometryUnlimitedEntry() [2/2]

vtkHyperTreeGridGeometryUnlimitedEntry::vtkHyperTreeGridGeometryUnlimitedEntry	(	vtkIdType	index,
		const double *	origin
	)

Constructor assume construction from a real level.

◆ ~vtkHyperTreeGridGeometryUnlimitedEntry()

vtkHyperTreeGridGeometryUnlimitedEntry::~vtkHyperTreeGridGeometryUnlimitedEntry ( )

default

Destructor.

Member Function Documentation

◆ PrintSelf()

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

Display info about the entry.

◆ Dump()

void vtkHyperTreeGridGeometryUnlimitedEntry::Dump ( ostream & os )

Dump information.

◆ Initialize() [1/2]

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

Initialize cursor at root of given tree index in grid.

◆ Initialize() [2/2]

void vtkHyperTreeGridGeometryUnlimitedEntry::Initialize	(	vtkIdType	index,
		vtkIdType	lastIndex,
		const double *	origin
	)

inline

Initialize cursor from explicit required data.

Definition at line 71 of file vtkHyperTreeGridGeometryUnlimitedEntry.h.

◆ Copy()

void vtkHyperTreeGridGeometryUnlimitedEntry::Copy ( const vtkHyperTreeGridGeometryUnlimitedEntry * entry )

inline

Copy function.

Definition at line 84 of file vtkHyperTreeGridGeometryUnlimitedEntry.h.

◆ GetVertexId()

vtkIdType vtkHyperTreeGridGeometryUnlimitedEntry::GetVertexId ( ) const

inline

Return the index of the current vertex in the tree.

Definition at line 92 of file vtkHyperTreeGridGeometryUnlimitedEntry.h.

◆ GetGlobalNodeIndex()

vtkIdType vtkHyperTreeGridGeometryUnlimitedEntry::GetGlobalNodeIndex ( const vtkHyperTree * tree ) const

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

Precondition: not_tree: tree

◆ SetGlobalIndexStart()

void vtkHyperTreeGridGeometryUnlimitedEntry::SetGlobalIndexStart	(	vtkHyperTree *	tree,
		vtkIdType	index
	)

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

Precondition: not_tree: tree

◆ SetGlobalIndexFromLocal()

void vtkHyperTreeGridGeometryUnlimitedEntry::SetGlobalIndexFromLocal	(	vtkHyperTree *	tree,
		vtkIdType	index
	)

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

Precondition: not_tree: tree

◆ SetMask()

void vtkHyperTreeGridGeometryUnlimitedEntry::SetMask	(	const vtkHyperTreeGrid *	grid,
		const vtkHyperTree *	tree,
		bool	state
	)

Set the blanking mask is empty or not.

Precondition: not_tree: tree

◆ IsMasked()

bool vtkHyperTreeGridGeometryUnlimitedEntry::IsMasked	(	const vtkHyperTreeGrid *	grid,
		const vtkHyperTree *	tree
	)		const

Determine whether blanking mask is empty or not.

Precondition: not_tree: tree

◆ IsLeaf()

bool vtkHyperTreeGridGeometryUnlimitedEntry::IsLeaf	(	const vtkHyperTreeGrid *	grid,
		const vtkHyperTree *	tree,
		unsigned int	level
	)		const

Is the cursor pointing to a leaf? Unlimited cursors allow to go deeper than a real leaf.

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

◆ IsRealLeaf()

bool vtkHyperTreeGridGeometryUnlimitedEntry::IsRealLeaf ( const vtkHyperTree * tree ) const

Is the cursor pointing to a real leaf of the underlying tree ?

Precondition: not_tree: tree; not_virtual Return true if the cursor is exactly on a leaf (not above nor below)

◆ IsVirtualLeaf()

bool vtkHyperTreeGridGeometryUnlimitedEntry::IsVirtualLeaf ( const vtkHyperTree * tree ) const

Is the cursor pointing below a real leaf of the underlying tree ?

Precondition: not_tree: tree Return true if the cursor is pointing on a virtual cell, below a real leaf

◆ IsTerminalNode()

bool vtkHyperTreeGridGeometryUnlimitedEntry::IsTerminalNode	(	const vtkHyperTreeGrid *	grid,
		const vtkHyperTree *	tree,
		unsigned int	level
	)		const

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

Precondition: not_tree: tree

◆ IsRoot()

bool vtkHyperTreeGridGeometryUnlimitedEntry::IsRoot ( ) const

inline

Is the cursor at tree root?

Definition at line 158 of file vtkHyperTreeGridGeometryUnlimitedEntry.h.

◆ ToChild()

void vtkHyperTreeGridGeometryUnlimitedEntry::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()

◆ GetOrigin() [1/2]

double* vtkHyperTreeGridGeometryUnlimitedEntry::GetOrigin ( )

inline

Getter for origin coordinates of the current cell.

Definition at line 174 of file vtkHyperTreeGridGeometryUnlimitedEntry.h.

◆ GetOrigin() [2/2]

const double* vtkHyperTreeGridGeometryUnlimitedEntry::GetOrigin ( ) const

inline

Definition at line 175 of file vtkHyperTreeGridGeometryUnlimitedEntry.h.

◆ GetBounds()

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

inline

Getter for bounding box of the current cell.

Definition at line 180 of file vtkHyperTreeGridGeometryUnlimitedEntry.h.

◆ GetPoint()

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

inline

Getter for center of the current cell.

Definition at line 194 of file vtkHyperTreeGridGeometryUnlimitedEntry.h.

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

Common/DataModel/vtkHyperTreeGridGeometryUnlimitedEntry.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ vtkHyperTreeGridGeometryUnlimitedEntry() [1/2]

◆ vtkHyperTreeGridGeometryUnlimitedEntry() [2/2]

◆ ~vtkHyperTreeGridGeometryUnlimitedEntry()

Member Function Documentation

◆ PrintSelf()

◆ Dump()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ Copy()

◆ GetVertexId()

◆ GetGlobalNodeIndex()

◆ SetGlobalIndexStart()

◆ SetGlobalIndexFromLocal()

◆ SetMask()

◆ IsMasked()

◆ IsLeaf()

◆ IsRealLeaf()

◆ IsVirtualLeaf()

◆ IsTerminalNode()

◆ IsRoot()

◆ ToChild()

◆ GetOrigin() [1/2]

◆ GetOrigin() [2/2]

◆ GetBounds()

◆ GetPoint()