hierarchical dataset of vtkUniformGrids More...

#include <vtkOverlappingAMR.h>

Inheritance diagram for vtkOverlappingAMR:

Collaboration diagram for vtkOverlappingAMR:

Public Types
typedef vtkUniformGridAMR	Superclass

Public Types inherited from vtkUniformGridAMR
typedef vtkCompositeDataSet	Superclass

Public Types inherited from vtkCompositeDataSet
typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
typedef vtkObject	Superclass

enum	FieldAssociations { FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS, FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS }

enum	AttributeTypes { POINT, CELL, FIELD, POINT_THEN_CELL, VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES }

enum	FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	GetDataObjectType ()

virtual int	IsA (const char *type)

vtkOverlappingAMR *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkCompositeDataIterator *	NewIterator ()

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

void	GetOrigin (unsigned int level, unsigned int id, double origin[3])

void	SetRefinementRatio (unsigned int level, int refRatio)

int	GetRefinementRatio (unsigned int level)

int	GetRefinementRatio (vtkCompositeDataIterator *iter)

bool	HasChildrenInformation ()

void	GenerateParentChildInformation ()

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	GetBounds (double b[6])

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


void	SetOrigin (const double *)

double *	GetOrigin ()


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

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


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

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


void	SetAMRBlockSourceIndex (unsigned int level, unsigned int id, int sourceId)

int	GetAMRBlockSourceIndex (unsigned int level, unsigned int id)


vtkAMRInformation *	GetAMRInfo ()

virtual void	SetAMRInfo (vtkAMRInformation *info)

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

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Initialize ()

virtual void	Initialize (int numLevels, const int *blocksPerLevel)

void	SetGridDescription (int gridDescription)

int	GetGridDescription ()

unsigned int	GetNumberOfLevels ()

virtual unsigned int	GetTotalNumberOfBlocks ()

unsigned int	GetNumberOfDataSets (const unsigned int level)

void	GetBounds (double bounds[6])

const double *	GetBounds ()

void	GetMin (double min[3])

void	GetMax (double max[3])

virtual void	SetDataSet (vtkCompositeDataIterator iter, vtkDataObject dataObj)

virtual void	SetDataSet (unsigned int level, unsigned int idx, vtkUniformGrid *grid)

vtkDataObject *	GetDataSet (vtkCompositeDataIterator *iter)

vtkUniformGrid *	GetDataSet (unsigned int level, unsigned int idx)

int	GetCompositeIndex (const unsigned int level, const unsigned int index)

void	GetLevelAndIndex (const unsigned int compositeIdx, unsigned int &level, unsigned int &idx)

virtual void	ShallowCopy (vtkDataObject *src)

virtual void	DeepCopy (vtkDataObject *src)

virtual void	CopyStructure (vtkCompositeDataSet *src)

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

virtual unsigned long	GetActualMemorySize ()

virtual vtkIdType	GetNumberOfPoints ()

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

unsigned long int	GetMTime ()

void	ReleaseData ()

unsigned long	GetUpdateTime ()

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))

void	DataHasBeenGenerated ()

virtual void	PrepareForNewData ()

virtual int	GetExtentType ()

virtual void	Crop (const int *updateExtent)

virtual vtkDataSetAttributes *	GetAttributes (int type)

virtual vtkFieldData *	GetAttributesAsFieldData (int type)

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)

virtual vtkIdType	GetNumberOfElements (int type)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual int	GetDataReleased ()

virtual void	SetFieldData (vtkFieldData *)

virtual vtkFieldData *	GetFieldData ()

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))

void	GlobalReleaseDataFlagOn ()

void	GlobalReleaseDataFlagOff ()

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

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 vtkOverlappingAMR *	New ()

static int	IsTypeOf (const char *type)

static vtkOverlappingAMR *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIdTypeKey *	NUMBER_OF_BLANKED_POINTS ()


static vtkOverlappingAMR *	GetData (vtkInformation *info)

static vtkOverlappingAMR *	GetData (vtkInformationVector *v, int i=0)

Static Public Member Functions inherited from vtkUniformGridAMR
static vtkUniformGridAMR *	New ()

static int	IsTypeOf (const char *type)

static vtkUniformGridAMR *	SafeDownCast (vtkObjectBase *o)

static vtkUniformGridAMR *	GetData (vtkInformation *info)

static vtkUniformGridAMR *	GetData (vtkInformationVector *v, int i=0)

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

static vtkCompositeDataSet *	SafeDownCast (vtkObjectBase *o)

static vtkInformationStringKey *	NAME ()

static vtkInformationIntegerKey *	CURRENT_PROCESS_CAN_LOAD_BLOCK ()

static vtkCompositeDataSet *	GetData (vtkInformation *info)

static vtkCompositeDataSet *	GetData (vtkInformationVector *v, int i=0)

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static int	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static const char *	GetAssociationTypeAsString (int associationType)

static int	GetAssociationTypeFromString (const char *associationType)

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)

static vtkDataObject *	GetData (vtkInformation *info)

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)

static void	SetGlobalReleaseDataFlag (int val)

static int	GetGlobalReleaseDataFlag ()

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 vtkUniformGridAMR
	vtkUniformGridAMR ()

virtual	~vtkUniformGridAMR ()

virtual vtkAMRDataInternals *	GetAMRData ()

Protected Member Functions inherited from vtkCompositeDataSet
	vtkCompositeDataSet ()

virtual	~vtkCompositeDataSet ()

Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()

	~vtkDataObject ()

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 &)

void	Audit ()

	vtkOverlappingAMR ()

virtual	~vtkOverlappingAMR ()

Additional Inherited Members
Protected Attributes inherited from vtkUniformGridAMR
vtkAMRInformation *	AMRInfo

vtkAMRDataInternals *	AMRData

double	Bounds [6]

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

hierarchical dataset of vtkUniformGrids

vtkOverlappingAMR extends vtkUniformGridAMR by exposing access to the amr meta data, which stores all structural information represented by an vtkAMRInformation object

See also: vtkAMRInformation

Examples:: vtkOverlappingAMR (Examples)

Tests:: vtkOverlappingAMR (Tests)

Definition at line 45 of file vtkOverlappingAMR.h.

Member Typedef Documentation

typedef vtkUniformGridAMR vtkOverlappingAMR::Superclass

Definition at line 53 of file vtkOverlappingAMR.h.

Constructor & Destructor Documentation

vtkOverlappingAMR::vtkOverlappingAMR ( )

protected

Check whether the data set is internally consistent, e.g. whether the meta data and acutal data blocks match. Incorrectness will be reported as error messages

virtual vtkOverlappingAMR::~vtkOverlappingAMR ( )

protectedvirtual

Check whether the data set is internally consistent, e.g. whether the meta data and acutal data blocks match. Incorrectness will be reported as error messages

Member Function Documentation

static vtkOverlappingAMR* vtkOverlappingAMR::New ( )

static

virtual int vtkOverlappingAMR::GetDataObjectType ( )

inlinevirtual

Return class name of data type (see vtkType.h for definitions).

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

Definition at line 51 of file vtkOverlappingAMR.h.

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

static

virtual int vtkOverlappingAMR::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 vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

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

static

virtual vtkObjectBase* vtkOverlappingAMR::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

vtkOverlappingAMR* vtkOverlappingAMR::NewInstance ( ) const

void vtkOverlappingAMR::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 vtkCompositeDataSet.

virtual vtkCompositeDataIterator* vtkOverlappingAMR::NewIterator ( )

virtual

Return a new iterator (the iterator has to be deleted by the user).

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

void vtkOverlappingAMR::SetOrigin ( const double * )

Get/Set the global origin of the amr data set

double* vtkOverlappingAMR::GetOrigin ( )

Get/Set the global origin of the amr data set

void vtkOverlappingAMR::SetSpacing	(	unsigned int	level,
		const double	spacing[3]
	)

Get/Set the grid spacing at a given level

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

Get/Set the grid spacing at a given level

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

Set/Get the AMRBox for a given block

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

Set/Get the AMRBox for a given block

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

Returns the bounding information of a data set.

void vtkOverlappingAMR::GetOrigin	(	unsigned int	level,
		unsigned int	id,
		double	origin[3]
	)

Returns the origin of an AMR block

static vtkInformationIdTypeKey* vtkOverlappingAMR::NUMBER_OF_BLANKED_POINTS ( )

static

static vtkOverlappingAMR* vtkOverlappingAMR::GetData ( vtkInformation * info )

inlinestatic

Retrieve an instance of this class from an information object.

Definition at line 89 of file vtkOverlappingAMR.h.

static vtkOverlappingAMR* vtkOverlappingAMR::GetData	(	vtkInformationVector *	v,
		int	i = `0`
	)

inlinestatic

Retrieve an instance of this class from an information object.

Definition at line 91 of file vtkOverlappingAMR.h.

void vtkOverlappingAMR::SetRefinementRatio	(	unsigned int	level,
		int	refRatio
	)

Sets the refinement of a given level. The spacing at level level+1 is defined as spacing(level+1) = spacing(level)/refRatio(level). Note that currently, this is not enforced by this class however some algorithms might not function properly if the spacing in the blocks (vtkUniformGrid) does not match the one described by the refinement ratio.

int vtkOverlappingAMR::GetRefinementRatio ( unsigned int level )

Returns the refinement of a given level.

void vtkOverlappingAMR::SetAMRBlockSourceIndex	(	unsigned int	level,
		unsigned int	id,
		int	sourceId
	)

Set/Get the source id of a block. The source id is produced by an AMR source, e.g. a file reader might set this to be a file block id

int vtkOverlappingAMR::GetAMRBlockSourceIndex	(	unsigned int	level,
		unsigned int	id
	)

Set/Get the source id of a block. The source id is produced by an AMR source, e.g. a file reader might set this to be a file block id

int vtkOverlappingAMR::GetRefinementRatio ( vtkCompositeDataIterator * iter )

Returns the refinement ratio for the position pointed by the iterator.

bool vtkOverlappingAMR::HasChildrenInformation ( )

Return whether parent child information has been generated

void vtkOverlappingAMR::GenerateParentChildInformation ( )

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

unsigned int* vtkOverlappingAMR::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* vtkOverlappingAMR::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 vtkOverlappingAMR::PrintParentChildInfo	(	unsigned int	level,
		unsigned int	index
	)

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

void vtkOverlappingAMR::GetBounds ( double b[6] )

inline

Definition at line 139 of file vtkOverlappingAMR.h.

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

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

vtkAMRInformation* vtkOverlappingAMR::GetAMRInfo ( )

inlinevirtual

Get/Set the interal representation of amr meta meta data

Reimplemented from vtkUniformGridAMR.

Definition at line 146 of file vtkOverlappingAMR.h.

virtual void vtkOverlappingAMR::SetAMRInfo ( vtkAMRInformation * info )

inlinevirtual

Get/Set the interal representation of amr meta meta data

Reimplemented from vtkUniformGridAMR.

Definition at line 147 of file vtkOverlappingAMR.h.

void vtkOverlappingAMR::Audit ( )

Check whether the data set is internally consistent, e.g. whether the meta data and acutal data blocks match. Incorrectness will be reported as error messages

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/vtkOverlappingAMR.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation