a multi-resolution dataset based on vtkUniformGrid More...

#include <vtkUniformGridAMR.h>

Inheritance diagram for vtkUniformGridAMR:

Collaboration diagram for vtkUniformGridAMR:

Public Types
typedef vtkCompositeDataSet	Superclass

Public Types inherited from vtkCompositeDataSet
typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
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 }
	Possible values for the FIELD_ASSOCIATION information entry. More...

enum	AttributeTypes { POINT , CELL , FIELD , POINT_THEN_CELL , VERTEX , EDGE , ROW , NUMBER_OF_ATTRIBUTE_TYPES }
	Possible attribute types. More...

enum	FieldOperations { FIELD_OPERATION_PRESERVED , FIELD_OPERATION_REINTERPOLATED , FIELD_OPERATION_MODIFIED , FIELD_OPERATION_REMOVED }
	Possible values for the FIELD_OPERATION information entry. More...

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.

vtkUniformGridAMR *	NewInstance () const

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

vtkCompositeDataIterator *	NewIterator () override
	Return a new iterator (the iterator has to be deleted by the user).

int	GetDataObjectType () VTK_FUTURE_CONST override
	Return class name of data type (see vtkType.h for definitions).

void	Initialize () override
	Restore data object to initial state.

virtual void	Initialize (const std::vector< unsigned int > &blocksPerLevel)
	Initialize the AMR with the specified blocksPerLevel.

virtual void	Initialize (int numLevels, const int *blocksPerLevel)
	Initialize the AMR with a specified number of levels and the blocks per level.

unsigned int	GetNumberOfLevels () const
	Get number of levels.

unsigned int	GetNumberOfBlocks () const
	Get the number of blocks for all levels including nullptr blocks, or 0 if AMRMetaData is invalid.

virtual unsigned int	GetTotalNumberOfBlocks ()
	Deprecated, forward to GetNumberOfBlocks.

unsigned int	GetNumberOfBlocks (unsigned int level) const
	Get the number of block at the given level, including nullptr blocks, or 0 if AMRMetaData is invalid.

unsigned int	GetNumberOfDataSets (unsigned int level)
	Deprecated, forward to GetNumberOfBlocks(level)

void	SetDataSet (vtkCompositeDataIterator iter, vtkDataObject dataObj) override
	Overriding superclass method.

virtual void	SetDataSet (unsigned int level, unsigned int idx, vtkUniformGrid *grid)
	At the passed in level, set grid as the idx'th block at that level.

vtkDataObject *	GetDataSet (vtkCompositeDataIterator *iter) override
	Get the data set pointed to by iter.

vtkUniformGrid *	GetDataSet (unsigned int level, unsigned int idx)
	Get the data set using the (level, index) pair.

int	GetAbsoluteBlockIndex (unsigned int level, unsigned int index) const
	Returns the absolute block index from a level and a relative block index or -1 if it doesn't exist.

int	GetCompositeIndex (unsigned int level, unsigned int index)
	Returns the absolute block index from a level and a relative block index or -1 if it doesn't exist.

void	ComputeIndexPair (unsigned int index, unsigned int &level, unsigned int &id)
	Returns the an index pair (level, relative index) given a absolute block index Forward to the internal vtkAMRMetaData.

void	GetLevelAndIndex (unsigned int compositeIdx, unsigned int &level, unsigned int &idx)
	Returns the an index pair (level, relative index) given a absolute block index Forward to the ComputeIndexPair.

void	DeepCopy (vtkDataObject *src) override
	DeepCopy.

void	CopyStructure (vtkCompositeDataSet *src) override
	CopyStructure.

virtual vtkDataObject *	GetDataSet (vtkCompositeDataIterator *iter)=0
	Returns the dataset located at the position pointed by the iterator.

virtual vtkDataObject *	GetDataSet (unsigned int flatIndex)
	Returns the dataset located at the position pointed by the flatIndex.


void	SetGridDescription (int gridDescription)
	Set/Get the data description of this uniform grid instance, e.g.

int	GetGridDescription ()
	Set/Get the data description of this uniform grid instance, e.g.


void	GetBounds (double bounds[6])
	Get the (min/max) bounds of the AMR domain.

virtual const double *	GetBounds ()
	Get the (min/max) bounds of the AMR domain.

void	GetMin (double min[3])
	Get the (min/max) bounds of the AMR domain.

void	GetMax (double max[3])
	Get the (min/max) bounds of the AMR domain.


void	CompositeShallowCopy (vtkCompositeDataSet *src) override
	ShallowCopy.

void	ShallowCopy (vtkDataObject *src) override
	ShallowCopy.


vtkAMRMetaData *	GetAMRMetaData ()
	Get/Set the AMR meta data.

void	SetAMRMetaData (vtkAMRMetaData *metadata)
	Get/Set the AMR meta data.

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

vtkCompositeDataSet *	NewInstance () const

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

virtual vtkCompositeDataIterator *	NewIterator ()=0
	Return a new iterator (the iterator has to be deleted by user).

int	GetDataObjectType () VTK_FUTURE_CONST override
	Return class name of data type (see vtkType.h for definitions).

virtual void	CopyStructure (vtkCompositeDataSet *input)
	Copies the tree structure from the input.

virtual void	SetDataSet (vtkCompositeDataIterator iter, vtkDataObject dataObj)=0
	Sets the data set at the location pointed by the iterator.

virtual vtkDataObject *	GetDataSet (vtkCompositeDataIterator *iter)=0
	Returns the dataset located at the position pointed by the iterator.

virtual vtkDataObject *	GetDataSet (unsigned int flatIndex)
	Returns the dataset located at the position pointed by the flatIndex.

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes).

void	Initialize () override
	Restore data object to initial state,.

virtual void	CompositeShallowCopy (vtkCompositeDataSet *src)
	The goal of the method is to copy the data up to the dataset pointers only.

virtual vtkIdType	GetNumberOfPoints ()
	Returns the total number of points of all blocks.

virtual vtkIdType	GetNumberOfCells ()
	Returns the total number of cells of all blocks.

vtkIdType	GetNumberOfElements (int type) override
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).

void	GetBounds (double bounds[6])
	Return the geometric bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).

bool	SupportsGhostArray (int type) override
	Returns true for POINT or CELL, false otherwise.

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

vtkDataObject *	NewInstance () const

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

vtkMTimeType	GetMTime () override
	Data objects are composite objects and need to check each part for MTime.

virtual void	Initialize ()
	Restore data object to initial state,.

void	ReleaseData ()
	Release data back to system to conserve memory resource.

virtual int	GetDataObjectType () VTK_FUTURE_CONST
	Return class name of data type.

vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).

virtual unsigned long	GetActualMemorySize ()
	Return the actual size of the data in kibibytes (1024 bytes).

virtual void	CopyInformationFromPipeline (vtkInformation *info)
	Copy from the pipeline information to the data object's own information.

virtual void	CopyInformationToPipeline (vtkInformation *info)
	Copy information from this data object to the pipeline information.

void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data.

virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted.

virtual void	ShallowCopy (vtkDataObject *src)
	The goal of the method is to copy the data up to the array pointers only.

virtual void	DeepCopy (vtkDataObject *src)
	The goal of the method is to copy the complete data from src into this object.

virtual int	GetExtentType () VTK_FUTURE_CONST
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.

virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent.

virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type.

virtual vtkUnsignedCharArray *	GetGhostArray (int type)
	Returns the ghost arrays of the data object of the specified attribute type.

virtual bool	SupportsGhostArray (int type)
	Returns if this type of data object support ghost array for specified type.

virtual vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData.

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from.

virtual vtkIdType	GetNumberOfElements (int type)
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this data object.

virtual vtkTypeBool	GetDataReleased ()
	Get the flag indicating the data has been released.

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object.

virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object.

void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkUniformGridAMR *	SafeDownCast (vtkObjectBase *o)


static vtkUniformGridAMR *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkUniformGridAMR *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.

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

static vtkCompositeDataSet *	SafeDownCast (vtkObjectBase *o)

static vtkInformationStringKey *	NAME ()
	Key used to put node name in the meta-data associated with a node.

static vtkInformationIntegerKey *	CURRENT_PROCESS_CAN_LOAD_BLOCK ()
	Key used to indicate that the current process can load the data in the node.

template<class DataSetT = vtkDataSet>
static std::vector< DataSetT * >	GetDataSets (vtkDataObject *dobj, bool preserveNull=false)
	Extract datasets from the given data object.

static vtkCompositeDataSet *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkCompositeDataSet *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS)

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name.

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Remove the info associated with an array.

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)
	Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters.

static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e.

static int	GetAssociationTypeFromString (const char *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e.

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 *	DIRECTION ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.

static void	SetGlobalReleaseDataFlag (vtkTypeBool val)
	Turn on/off flag to control whether every object releases its data after being used by a filter.

static vtkTypeBool	GetGlobalReleaseDataFlag ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

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

	vtkUniformGridAMR ()

	~vtkUniformGridAMR () override

virtual void	InstantiateMetaData ()
	Create and set a new vtkAMRMetaData as AMRMetaData.


virtual vtkAMRDataInternals *	GetAMRData ()
	Get/Set the meta AMR data Deprecated, do not use.

virtual void	SetAMRData (vtkAMRDataInternals *)
	Get/Set the meta AMR data Deprecated, do not use.


virtual vtkOverlappingAMRMetaData *	GetAMRInfo ()
	Noop and deprecated, use GetAMRData/SetAMRMetaData instead.

virtual void	SetAMRInfo (vtkOverlappingAMRMetaData *)
	Noop and deprecated, use GetAMRData/SetAMRMetaData instead.

Protected Member Functions inherited from vtkCompositeDataSet
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCompositeDataSet ()

	~vtkCompositeDataSet () override

Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObject ()

	~vtkDataObject () override

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

Friends
class	vtkUniformGridAMRDataIterator

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 vtkDataObject
vtkFieldData *	FieldData

vtkTypeBool	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

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

a multi-resolution dataset based on vtkUniformGrid

vtkUniformGridAMR (AMR stands for Adaptive Mesh Refinement) is a container for vtkUniformGrid. Each grid is added as a block of a given level.

The structure of the container is described in a vtkAMRMetaData object.

See also: vtkOverlappingAMR, vtkNonOverlappingAMR, vtkOverlappingAMRMetaData, vtkUniformGridAMRDataIterator

Definition at line 32 of file vtkUniformGridAMR.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCompositeDataSet vtkUniformGridAMR::Superclass

Definition at line 36 of file vtkUniformGridAMR.h.

Constructor & Destructor Documentation

◆ vtkUniformGridAMR()

vtkUniformGridAMR::vtkUniformGridAMR ( )

protected

◆ ~vtkUniformGridAMR()

vtkUniformGridAMR::~vtkUniformGridAMR ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkUniformGridAMR * vtkUniformGridAMR::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkUniformGridAMR::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 vtkCompositeDataSet.

Reimplemented in vtkHierarchicalBoxDataSet, vtkNonOverlappingAMR, and vtkOverlappingAMR.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkUniformGridAMR::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCompositeDataSet.

Reimplemented in vtkHierarchicalBoxDataSet, vtkNonOverlappingAMR, and vtkOverlappingAMR.

◆ NewInstance()

vtkUniformGridAMR * vtkUniformGridAMR::NewInstance ( ) const

◆ PrintSelf()

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

◆ NewIterator()

vtkCompositeDataIterator * vtkUniformGridAMR::NewIterator ( )

overridevirtual

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

Implements vtkCompositeDataSet.

◆ GetDataObjectType()

int vtkUniformGridAMR::GetDataObjectType ( )

inlineoverridevirtual

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

Reimplemented from vtkCompositeDataSet.

Definition at line 47 of file vtkUniformGridAMR.h.

◆ Initialize() [1/3]

void vtkUniformGridAMR::Initialize ( )

overridevirtual

Restore data object to initial state.

Reimplemented from vtkCompositeDataSet.

◆ Initialize() [2/3]

virtual void vtkUniformGridAMR::Initialize ( const std::vector< unsigned int > & blocksPerLevel )

virtual

Initialize the AMR with the specified blocksPerLevel.

◆ Initialize() [3/3]

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

virtual

Initialize the AMR with a specified number of levels and the blocks per level.

◆ SetGridDescription()

void vtkUniformGridAMR::SetGridDescription ( int gridDescription )

Set/Get the data description of this uniform grid instance, e.g.

VTK_STRUCTURED_XYZ_GRID

◆ GetGridDescription()

int vtkUniformGridAMR::GetGridDescription ( )

Set/Get the data description of this uniform grid instance, e.g.

VTK_STRUCTURED_XYZ_GRID

◆ GetNumberOfLevels()

unsigned int vtkUniformGridAMR::GetNumberOfLevels ( ) const

Get number of levels.

◆ GetNumberOfBlocks() [1/2]

unsigned int vtkUniformGridAMR::GetNumberOfBlocks ( ) const

Get the number of blocks for all levels including nullptr blocks, or 0 if AMRMetaData is invalid.

◆ GetTotalNumberOfBlocks()

virtual unsigned int vtkUniformGridAMR::GetTotalNumberOfBlocks ( )

inlinevirtual

Deprecated, forward to GetNumberOfBlocks.

Definition at line 89 of file vtkUniformGridAMR.h.

◆ GetNumberOfBlocks() [2/2]

unsigned int vtkUniformGridAMR::GetNumberOfBlocks ( unsigned int level ) const

Get the number of block at the given level, including nullptr blocks, or 0 if AMRMetaData is invalid.

◆ GetNumberOfDataSets()

unsigned int vtkUniformGridAMR::GetNumberOfDataSets ( unsigned int level )

inline

Deprecated, forward to GetNumberOfBlocks(level)

Definition at line 101 of file vtkUniformGridAMR.h.

◆ GetBounds() [1/2]

void vtkUniformGridAMR::GetBounds ( double bounds[6] )

Get the (min/max) bounds of the AMR domain.

◆ GetBounds() [2/2]

virtual const double * vtkUniformGridAMR::GetBounds ( )

virtual

Get the (min/max) bounds of the AMR domain.

Reimplemented in vtkOverlappingAMR, and vtkOverlappingAMR.

◆ GetMin()

void vtkUniformGridAMR::GetMin ( double min[3] )

Get the (min/max) bounds of the AMR domain.

◆ GetMax()

void vtkUniformGridAMR::GetMax ( double max[3] )

Get the (min/max) bounds of the AMR domain.

◆ SetDataSet() [1/2]

void vtkUniformGridAMR::SetDataSet	(	vtkCompositeDataIterator *	iter,
		vtkDataObject *	dataObj
	)

overridevirtual

Overriding superclass method.

Implements vtkCompositeDataSet.

◆ SetDataSet() [2/2]

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

virtual

At the passed in level, set grid as the idx'th block at that level.

idx must be less than the number of data sets at that level

◆ GetDataSet() [1/4]

vtkDataObject * vtkUniformGridAMR::GetDataSet ( vtkCompositeDataIterator * iter )

overridevirtual

Get the data set pointed to by iter.

Implements vtkCompositeDataSet.

◆ GetDataSet() [2/4]

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

Get the data set using the (level, index) pair.

◆ GetAbsoluteBlockIndex()

int vtkUniformGridAMR::GetAbsoluteBlockIndex	(	unsigned int	level,
		unsigned int	index
	)		const

Returns the absolute block index from a level and a relative block index or -1 if it doesn't exist.

Forward to the internal vtkAMRMetaData.

◆ GetCompositeIndex()

int vtkUniformGridAMR::GetCompositeIndex	(	unsigned int	level,
		unsigned int	index
	)

inline

Returns the absolute block index from a level and a relative block index or -1 if it doesn't exist.

Forward to the internal GetAbsoluteBlockIndex Deprecated, use GetAbsoluteBlockIndex instead.

Definition at line 151 of file vtkUniformGridAMR.h.

◆ ComputeIndexPair()

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

Returns the an index pair (level, relative index) given a absolute block index Forward to the internal vtkAMRMetaData.

◆ GetLevelAndIndex()

void vtkUniformGridAMR::GetLevelAndIndex	(	unsigned int	compositeIdx,
		unsigned int &	level,
		unsigned int &	idx
	)

inline

Returns the an index pair (level, relative index) given a absolute block index Forward to the ComputeIndexPair.

Deprecated, using ComputeIndexPair.

Definition at line 168 of file vtkUniformGridAMR.h.

◆ CompositeShallowCopy()

void vtkUniformGridAMR::CompositeShallowCopy ( vtkCompositeDataSet * src )

overridevirtual

ShallowCopy.

Reimplemented from vtkCompositeDataSet.

◆ ShallowCopy()

void vtkUniformGridAMR::ShallowCopy ( vtkDataObject * src )

overridevirtual

ShallowCopy.

Reimplemented from vtkDataObject.

◆ DeepCopy()

void vtkUniformGridAMR::DeepCopy ( vtkDataObject * src )

overridevirtual

DeepCopy.

Reimplemented from vtkDataObject.

◆ CopyStructure()

void vtkUniformGridAMR::CopyStructure ( vtkCompositeDataSet * src )

overridevirtual

CopyStructure.

Reimplemented from vtkCompositeDataSet.

◆ GetData() [1/2]

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

static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

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

static

Retrieve an instance of this class from an information object.

◆ GetAMRMetaData()

vtkAMRMetaData * vtkUniformGridAMR::GetAMRMetaData ( )

Get/Set the AMR meta data.

◆ SetAMRMetaData()

void vtkUniformGridAMR::SetAMRMetaData ( vtkAMRMetaData * metadata )

Get/Set the AMR meta data.

◆ InstantiateMetaData()

virtual void vtkUniformGridAMR::InstantiateMetaData ( )

protectedvirtual

Create and set a new vtkAMRMetaData as AMRMetaData.

Reimplemented in vtkOverlappingAMR.

◆ GetAMRData()

virtual vtkAMRDataInternals * vtkUniformGridAMR::GetAMRData ( )

inlineprotectedvirtual

Get/Set the meta AMR data Deprecated, do not use.

Definition at line 222 of file vtkUniformGridAMR.h.

◆ SetAMRData()

virtual void vtkUniformGridAMR::SetAMRData ( vtkAMRDataInternals * )

inlineprotectedvirtual

Get/Set the meta AMR data Deprecated, do not use.

Definition at line 224 of file vtkUniformGridAMR.h.

◆ GetAMRInfo()

virtual vtkOverlappingAMRMetaData * vtkUniformGridAMR::GetAMRInfo ( )

inlineprotectedvirtual

Noop and deprecated, use GetAMRData/SetAMRMetaData instead.

Reimplemented in vtkOverlappingAMR.

Definition at line 233 of file vtkUniformGridAMR.h.

◆ SetAMRInfo()

virtual void vtkUniformGridAMR::SetAMRInfo ( vtkOverlappingAMRMetaData * )

inlineprotectedvirtual

Noop and deprecated, use GetAMRData/SetAMRMetaData instead.

Reimplemented in vtkOverlappingAMR.

Definition at line 236 of file vtkUniformGridAMR.h.

◆ GetDataSet() [3/4]

virtual vtkDataObject * vtkCompositeDataSet::GetDataSet ( vtkCompositeDataIterator * iter )

virtual

Returns the dataset located at the position pointed by the iterator.

The iterator does not need to be iterating over this dataset itself. It can be an iterator for composite dataset with similar structure (achieved by using CopyStructure).

Implements vtkCompositeDataSet.

◆ GetDataSet() [4/4]

virtual vtkDataObject * vtkCompositeDataSet::GetDataSet ( unsigned int flatIndex )

virtual

Returns the dataset located at the position pointed by the flatIndex.

If no dataset has the same flat index, nullptr is returned.

It should be noted that this function should be used ONLY when you already know the flat index. It should NOT be used when you are iterating over the composite dataset (in that case, prefer the vtkCompositeDataIterator).

Reimplemented from vtkCompositeDataSet.

Friends And Related Symbol Documentation

◆ vtkUniformGridAMRDataIterator

friend class vtkUniformGridAMRDataIterator

friend

Definition at line 243 of file vtkUniformGridAMR.h.

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

Common/DataModel/vtkUniformGridAMR.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkUniformGridAMR()

◆ ~vtkUniformGridAMR()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ NewIterator()

◆ GetDataObjectType()

◆ Initialize() [1/3]

◆ Initialize() [2/3]

◆ Initialize() [3/3]

◆ SetGridDescription()

◆ GetGridDescription()

◆ GetNumberOfLevels()

◆ GetNumberOfBlocks() [1/2]

◆ GetTotalNumberOfBlocks()

◆ GetNumberOfBlocks() [2/2]

◆ GetNumberOfDataSets()

◆ GetBounds() [1/2]

◆ GetBounds() [2/2]

◆ GetMin()

◆ GetMax()

◆ SetDataSet() [1/2]

◆ SetDataSet() [2/2]

◆ GetDataSet() [1/4]

◆ GetDataSet() [2/4]

◆ GetAbsoluteBlockIndex()

◆ GetCompositeIndex()

◆ ComputeIndexPair()

◆ GetLevelAndIndex()

◆ CompositeShallowCopy()

◆ ShallowCopy()

◆ DeepCopy()

◆ CopyStructure()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetAMRMetaData()

◆ SetAMRMetaData()

◆ InstantiateMetaData()

◆ GetAMRData()

◆ SetAMRData()

◆ GetAMRInfo()

◆ SetAMRInfo()

◆ GetDataSet() [3/4]

◆ GetDataSet() [4/4]

Friends And Related Symbol Documentation

◆ vtkUniformGridAMRDataIterator