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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAMRInformation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

bool	operator== (const vtkAMRInformation &other)

void	Initialize (int numLevels, const int *blocksPerLevel)

unsigned int	GetNumberOfDataSets (unsigned int level) const

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

const double *	GetBounds ()

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

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

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

bool	HasSpacing (unsigned int level)

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

void	GenerateRefinementRatio ()

bool	HasRefinementRatio ()

void	SetRefinementRatio (unsigned int level, int ratio)

int	GetRefinementRatio (unsigned int level) const

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

bool	HasChildrenInformation ()

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

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

void	PrintParentChildInfo (unsigned int level, unsigned int index)

void	GenerateParentChildInformation ()

bool	Audit ()

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

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

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

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

void	DeepCopy (vtkAMRInformation *other)


virtual int	GetGridDescription ()

void	SetGridDescription (int description)


void	GetOrigin (double origin[3])

double *	GetOrigin ()

void	SetOrigin (const double *origin)


unsigned int	GetNumberOfLevels () const


unsigned int	GetTotalNumberOfBlocks ()


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


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

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


int	GetAMRBlockSourceIndex (int index)

void	SetAMRBlockSourceIndex (int index, int sourceId)


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

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkAMRInformation *	New ()

static int	IsTypeOf (const char *type)

static vtkAMRInformation *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

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

vtkAMRInformation encaspulates 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

Examples:
vtkAMRInformation (Examples)

Definition at line 50 of file vtkAMRInformation.h.

Member Typedef Documentation

typedef vtkObject vtkAMRInformation::Superclass

Definition at line 54 of file vtkAMRInformation.h.

Member Function Documentation

static vtkAMRInformation* vtkAMRInformation::New ( )

static

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

static

virtual int 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 vtkObject.

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

static

virtual vtkObjectBase* vtkAMRInformation::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkAMRInformation* vtkAMRInformation::NewInstance ( ) const

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

virtual

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 vtkObject.

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

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

virtual int vtkAMRInformation::GetGridDescription ( )

virtual

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

void vtkAMRInformation::SetGridDescription ( int description )

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

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

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

double* vtkAMRInformation::GetOrigin ( )

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

void vtkAMRInformation::SetOrigin ( const double * origin )

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

unsigned int vtkAMRInformation::GetNumberOfLevels ( ) const

inline

Return the number of levels

Definition at line 80 of file vtkAMRInformation.h.

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

Returns the number of datasets at the given levelx

unsigned int vtkAMRInformation::GetTotalNumberOfBlocks ( )

inline

Returns total number of datasets

Definition at line 89 of file vtkAMRInformation.h.

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

inline

Returns the single index from a pair of indices

Definition at line 95 of file vtkAMRInformation.h.

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

Returns the an index pair given a single index

const double* vtkAMRInformation::GetBounds ( )

Returns the bounds of the entire domain

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

Returns the bounding box of a given box

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

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

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

Return the spacing at the given fiven

bool vtkAMRInformation::HasSpacing ( unsigned int level )

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

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

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

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

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

return the amr box coarsened to the previous level

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

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

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.

bool vtkAMRInformation::HasRefinementRatio ( )

Returns Wether refinement ratio has been set (either by calling GenerateRefinementRatio() or by calling 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.

int vtkAMRInformation::GetRefinementRatio ( unsigned int level ) const

Returns the refinement of a given level.

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

Set the spacing at a given level

bool vtkAMRInformation::HasChildrenInformation ( )

Return whether parent child information has been generated

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 NULL.

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 childern ids in level+1. If none exits it returns NULL.

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

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

void vtkAMRInformation::GenerateParentChildInformation ( )

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

bool vtkAMRInformation::Audit ( )

Checks whether the meta data is internally consistent.

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

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

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

bool vtkAMRInformation::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>& vtkAMRInformation::GetNumBlocks ( ) const

inline

Returns internal arrays.

Definition at line 191 of file vtkAMRInformation.h.

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

inline

Definition at line 195 of file vtkAMRInformation.h.

void vtkAMRInformation::DeepCopy ( vtkAMRInformation * other )

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkAMRInformation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Function Documentation