Meta data that describes the structure of an AMR data set. More...

#include <vtkAMRInformation.h>

Inheritance diagram for vtkAMRInformation:

Collaboration diagram for vtkAMRInformation:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAMRInformation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

bool	operator== (const vtkAMRInformation &other) const

void	Initialize (int numLevels, const int *blocksPerLevel)
	Initialize the meta information numLevels is the number of levels blocksPerLevel[i] is the number of blocks at level i.

unsigned int	GetNumberOfLevels () const
	Return the number of levels.

unsigned int	GetNumberOfDataSets (unsigned int level) const
	Returns the number of datasets at the given levelx.

unsigned int	GetTotalNumberOfBlocks ()
	Returns total number of datasets.

int	GetIndex (unsigned int level, unsigned int id) const
	Returns the single index from a pair of indices.

void	ComputeIndexPair (unsigned int index, unsigned int &level, unsigned int &id)
	Returns the an index pair given a single index.

const double *	GetBounds ()
	Returns the bounds of the entire domain.

void	GetBounds (unsigned int level, unsigned int id, double *bb)
	Returns the bounding box of a given box.

bool	GetOrigin (unsigned int level, unsigned int id, double *origin)
	Returns the origin of the grid at (level,id)

void	GetSpacing (unsigned int level, double spacing[3])
	Return the spacing at the given fiven.

bool	HasSpacing (unsigned int level)

bool	GetCoarsenedAMRBox (unsigned int level, unsigned int id, vtkAMRBox &box) const
	return the amr box coarsened to the previous level

void	GenerateRefinementRatio ()
	This method computes the refinement ratio at each level.

bool	HasRefinementRatio ()
	Returns whether refinement ratio has been set (either by calling GenerateRefinementRatio() or by calling SetRefinementRatio()

void	SetRefinementRatio (unsigned int level, int ratio)
	Set the refinement ratio at a level.

int	GetRefinementRatio (unsigned int level) const
	Returns the refinement of a given level.

void	SetSpacing (unsigned int level, const double *h)
	Set the spacing at a given level.

bool	HasChildrenInformation ()
	Return whether parent child information has been generated.

unsigned int *	GetParents (unsigned int level, unsigned int index, unsigned int &numParents)
	Return a pointer to Parents of a block.

unsigned int *	GetChildren (unsigned int level, unsigned int index, unsigned int &numChildren)
	Return a pointer to Children of a block.

void	PrintParentChildInfo (unsigned int level, unsigned int index)
	Prints the parents and children of a requested block (Debug Routine)

void	GenerateParentChildInformation ()
	Generate the parent/child relationships - needed to be called before GetParents or GetChildren can be used!

bool	Audit ()
	Checks whether the meta data is internally consistent.

bool	FindCell (double q[3], unsigned int level, unsigned int index, int &cellIdx)
	Given a point q, find whether q is bounded by the data set at (level,index).

bool	FindGrid (double q[3], int level, unsigned int &gridId)
	find the grid that contains the point q at the specified level

bool	FindGrid (double q[3], unsigned int &level, unsigned int &gridId)
	Given a point q, find the highest level grid that contains it.

const std::vector< int > &	GetNumBlocks () const
	Returns internal arrays.

std::vector< std::vector< unsigned int > > &	GetChildrenAtLevel (unsigned int i)

void	DeepCopy (vtkAMRInformation *other)


virtual int	GetGridDescription ()
	returns the value of vtkUniformGrid::GridDescription() of any block

void	SetGridDescription (int description)
	returns the value of vtkUniformGrid::GridDescription() of any block


void	GetOrigin (double origin[3])
	Get the AMR dataset origin The origin is essentially the minimum of all the grids.

double *	GetOrigin ()
	Get the AMR dataset origin The origin is essentially the minimum of all the grids.

void	SetOrigin (const double *origin)
	Get the AMR dataset origin The origin is essentially the minimum of all the grids.


void	SetAMRBox (unsigned int level, unsigned int id, const vtkAMRBox &box)
	Methods to set and get the AMR box at a given position.

const vtkAMRBox &	GetAMRBox (unsigned int level, unsigned int id) const
	Methods to set and get the AMR box at a given position.


int	GetAMRBlockSourceIndex (int index)
	Get/Set the SourceIndex of a block.

void	SetAMRBlockSourceIndex (int index, int sourceId)
	Get/Set the SourceIndex of a block.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkAMRInformation *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAMRInformation *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Meta data that describes the structure of an AMR data set.

vtkAMRInformation encapsulates the following meta information for an AMR data set

a list of vtkAMRBox objects
Refinement ratio between AMR levels
Grid spacing for each level
The file block index for each block
parent child information, if requested

See also: vtkOverlappingAMR, vtkAMRBox

Definition at line 36 of file vtkAMRInformation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkAMRInformation::Superclass

Definition at line 40 of file vtkAMRInformation.h.

Member Function Documentation

◆ New()

static vtkAMRInformation * vtkAMRInformation::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkAMRInformation::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkAMRInformation::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkAMRInformation * vtkAMRInformation::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAMRInformation::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkAMRInformation * vtkAMRInformation::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObjectBase.

◆ operator==()

bool vtkAMRInformation::operator== ( const vtkAMRInformation & other ) const

◆ Initialize()

void vtkAMRInformation::Initialize	(	int	numLevels,
		const int *	blocksPerLevel
	)

Initialize the meta information numLevels is the number of levels blocksPerLevel[i] is the number of blocks at level i.

◆ GetGridDescription()

virtual int vtkAMRInformation::GetGridDescription ( )

virtual

returns the value of vtkUniformGrid::GridDescription() of any block

◆ SetGridDescription()

void vtkAMRInformation::SetGridDescription ( int description )

returns the value of vtkUniformGrid::GridDescription() of any block

◆ GetOrigin() [1/3]

void vtkAMRInformation::GetOrigin ( double origin[3] )

Get the AMR dataset origin The origin is essentially the minimum of all the grids.

◆ GetOrigin() [2/3]

double * vtkAMRInformation::GetOrigin ( )

Get the AMR dataset origin The origin is essentially the minimum of all the grids.

◆ SetOrigin()

void vtkAMRInformation::SetOrigin ( const double * origin )

Get the AMR dataset origin The origin is essentially the minimum of all the grids.

◆ GetNumberOfLevels()

unsigned int vtkAMRInformation::GetNumberOfLevels ( ) const

inline

Return the number of levels.

Definition at line 74 of file vtkAMRInformation.h.

◆ GetNumberOfDataSets()

unsigned int vtkAMRInformation::GetNumberOfDataSets ( unsigned int level ) const

Returns the number of datasets at the given levelx.

◆ GetTotalNumberOfBlocks()

unsigned int vtkAMRInformation::GetTotalNumberOfBlocks ( )

inline

Returns total number of datasets.

Definition at line 87 of file vtkAMRInformation.h.

◆ GetIndex()

int vtkAMRInformation::GetIndex	(	unsigned int	level,
		unsigned int	id
	)		const

inline

Returns the single index from a pair of indices.

Definition at line 92 of file vtkAMRInformation.h.

◆ ComputeIndexPair()

void vtkAMRInformation::ComputeIndexPair	(	unsigned int	index,
		unsigned int &	level,
		unsigned int &	id
	)

Returns the an index pair given a single index.

◆ GetBounds() [1/2]

const double * vtkAMRInformation::GetBounds ( )

Returns the bounds of the entire domain.

◆ GetBounds() [2/2]

void vtkAMRInformation::GetBounds	(	unsigned int	level,
		unsigned int	id,
		double *	bb
	)

Returns the bounding box of a given box.

◆ GetOrigin() [3/3]

bool vtkAMRInformation::GetOrigin	(	unsigned int	level,
		unsigned int	id,
		double *	origin
	)

Returns the origin of the grid at (level,id)

◆ GetSpacing()

void vtkAMRInformation::GetSpacing	(	unsigned int	level,
		double	spacing[3]
	)

Return the spacing at the given fiven.

◆ HasSpacing()

bool vtkAMRInformation::HasSpacing ( unsigned int level )

◆ SetAMRBox()

void vtkAMRInformation::SetAMRBox	(	unsigned int	level,
		unsigned int	id,
		const vtkAMRBox &	box
	)

Methods to set and get the AMR box at a given position.

◆ GetAMRBox()

const vtkAMRBox & vtkAMRInformation::GetAMRBox	(	unsigned int	level,
		unsigned int	id
	)		const

Methods to set and get the AMR box at a given position.

◆ GetCoarsenedAMRBox()

bool vtkAMRInformation::GetCoarsenedAMRBox	(	unsigned int	level,
		unsigned int	id,
		vtkAMRBox &	box
	)		const

return the amr box coarsened to the previous level

◆ GetAMRBlockSourceIndex()

int vtkAMRInformation::GetAMRBlockSourceIndex ( int index )

Get/Set the SourceIndex of a block.

Typically, this is a file-type specific index that can be used by a reader to load a particular file block

◆ SetAMRBlockSourceIndex()

void vtkAMRInformation::SetAMRBlockSourceIndex	(	int	index,
		int	sourceId
	)

Get/Set the SourceIndex of a block.

Typically, this is a file-type specific index that can be used by a reader to load a particular file block

◆ GenerateRefinementRatio()

void vtkAMRInformation::GenerateRefinementRatio ( )

This method computes the refinement ratio at each level.

At each level, l, the refinement ratio r_l is computed by r_l = D_{l} / D_{l+1}, where D_{l+1} and D_{l} are the grid spacings at the next and current level respectively.

.SECTION Assumptions 1) Within each level, the refinement ratios are the same for all blocks. 2) The refinement ratio is uniform along each dimension of the block.

◆ HasRefinementRatio()

bool vtkAMRInformation::HasRefinementRatio ( )

Returns whether refinement ratio has been set (either by calling GenerateRefinementRatio() or by calling SetRefinementRatio()

◆ SetRefinementRatio()

void vtkAMRInformation::SetRefinementRatio	(	unsigned int	level,
		int	ratio
	)

Set the refinement ratio at a level.

This method should be called for all levels, if called at all.

◆ GetRefinementRatio()

int vtkAMRInformation::GetRefinementRatio ( unsigned int level ) const

Returns the refinement of a given level.

◆ SetSpacing()

void vtkAMRInformation::SetSpacing	(	unsigned int	level,
		const double *	h
	)

Set the spacing at a given level.

◆ HasChildrenInformation()

bool vtkAMRInformation::HasChildrenInformation ( )

Return whether parent child information has been generated.

◆ GetParents()

unsigned int * vtkAMRInformation::GetParents	(	unsigned int	level,
		unsigned int	index,
		unsigned int &	numParents
	)

Return a pointer to Parents of a block.

The first entry is the number of parents the block has followed by its parent ids in level-1. If none exits it returns nullptr.

◆ GetChildren()

unsigned int * vtkAMRInformation::GetChildren	(	unsigned int	level,
		unsigned int	index,
		unsigned int &	numChildren
	)

Return a pointer to Children of a block.

The first entry is the number of children the block has followed by its children ids in level+1. If none exits it returns nullptr.

◆ PrintParentChildInfo()

void vtkAMRInformation::PrintParentChildInfo	(	unsigned int	level,
		unsigned int	index
	)

Prints the parents and children of a requested block (Debug Routine)

◆ GenerateParentChildInformation()

void vtkAMRInformation::GenerateParentChildInformation ( )

Generate the parent/child relationships - needed to be called before GetParents or GetChildren can be used!

◆ Audit()

bool vtkAMRInformation::Audit ( )

Checks whether the meta data is internally consistent.

◆ FindCell()

bool vtkAMRInformation::FindCell	(	double	q[3],
		unsigned int	level,
		unsigned int	index,
		int &	cellIdx
	)

Given a point q, find whether q is bounded by the data set at (level,index).

If it is, set cellIdx to the cell index and return true; otherwise return false

◆ FindGrid() [1/2]

bool vtkAMRInformation::FindGrid	(	double	q[3],
		int	level,
		unsigned int &	gridId
	)

find the grid that contains the point q at the specified level

◆ FindGrid() [2/2]

bool vtkAMRInformation::FindGrid	(	double	q[3],
		unsigned int &	level,
		unsigned int &	gridId
	)

Given a point q, find the highest level grid that contains it.

◆ GetNumBlocks()

const std::vector< int > & vtkAMRInformation::GetNumBlocks ( ) const

inline

Returns internal arrays.

Definition at line 232 of file vtkAMRInformation.h.

◆ GetChildrenAtLevel()

std::vector< std::vector< unsigned int > > & vtkAMRInformation::GetChildrenAtLevel ( unsigned int i )

inline

Definition at line 234 of file vtkAMRInformation.h.

◆ DeepCopy()

void vtkAMRInformation::DeepCopy ( vtkAMRInformation * other )

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

Common/DataModel/vtkAMRInformation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ operator==()

◆ Initialize()

◆ GetGridDescription()

◆ SetGridDescription()

◆ GetOrigin() [1/3]

◆ GetOrigin() [2/3]

◆ SetOrigin()

◆ GetNumberOfLevels()

◆ GetNumberOfDataSets()

◆ GetTotalNumberOfBlocks()

◆ GetIndex()

◆ ComputeIndexPair()

◆ GetBounds() [1/2]

◆ GetBounds() [2/2]

◆ GetOrigin() [3/3]

◆ GetSpacing()

◆ HasSpacing()

◆ SetAMRBox()

◆ GetAMRBox()

◆ GetCoarsenedAMRBox()

◆ GetAMRBlockSourceIndex()

◆ SetAMRBlockSourceIndex()

◆ GenerateRefinementRatio()

◆ HasRefinementRatio()

◆ SetRefinementRatio()

◆ GetRefinementRatio()

◆ SetSpacing()

◆ HasChildrenInformation()

◆ GetParents()

◆ GetChildren()

◆ PrintParentChildInfo()

◆ GenerateParentChildInformation()

◆ Audit()

◆ FindCell()

◆ FindGrid() [1/2]

◆ FindGrid() [2/2]

◆ GetNumBlocks()

◆ GetChildrenAtLevel()

◆ DeepCopy()