vtkOverlappingAMR Class Reference

a multi-resolution dataset based on vtkUniformGrid allowing overlaps 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
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
int	GetDataObjectType () VTK_FUTURE_CONST override
	Return class name of data type (see vtkType.h for definitions).
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkOverlappingAMR *	NewInstance () const
vtkCompositeDataIterator *	NewIterator () override
	Return a new iterator (the iterator has to be deleted by the user).
const double *	GetBounds () override
	If AMRMetaData is set and superclass bounds are empty, return AMRMetaData::GetBounds, return superclass bounds otherwise.
void	GetBounds (unsigned int level, unsigned int id, double bb[6])
	Returns the bounding information of a data set.
void	GetOrigin (unsigned int level, unsigned int id, double origin[3])
	Returns the origin of an AMR block.
void	SetRefinementRatio (unsigned int level, int refRatio)
	Sets the refinement of a given level.
int	GetRefinementRatio (unsigned int level)
	Returns the refinement of a given level or -1 if metadata is invalid.
int	GetRefinementRatio (vtkCompositeDataIterator *iter)
	Returns the refinement ratio for the position pointed by the iterator or -1 if refinement is invalid.
bool	HasChildrenInformation ()
	Return whether parent child information has been generated.
void	GenerateParentChildInformation ()
	Generate the parent/child relationships - needed to be called before GetParents or GetChildren can be used!
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)
bool	FindGrid (double q[3], unsigned int &level, unsigned int &gridId)
	Given a point q, find the highest level grid that contains it.
void	Audit ()
	Deprecated, forward to CheckValidity.
bool	CheckValidity ()
	Check whether the data set is internally consistent, e.g.
vtkOverlappingAMRMetaData *	GetOverlappingAMRMetaData ()
	Convenience getter that get superclass MetaData and cast it to vtkOverlappingAMRMetaDat.
vtkOverlappingAMRMetaData *	GetAMRInfo () override
	Get/Set the AMR meta data Deprecated, use Get/SetAMRMetaData or GetOverlappingAMRMetaData.
void	SetAMRInfo (vtkOverlappingAMRMetaData *info) override
	Noop and deprecated, use GetAMRData/SetAMRMetaData instead.
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	SetOrigin (const double origin[3])
	Get/Set the global origin of the amr data set.
double *	GetOrigin ()
	Get/Set the global origin of the amr data set.
void	SetSpacing (unsigned int level, const double spacing[3])
	Get/Set the grid spacing at a given level.
void	GetSpacing (unsigned int level, double spacing[3])
	Get/Set the grid spacing at a given level.
void	SetAMRBox (unsigned int level, unsigned int id, const vtkAMRBox &box)
	Set/Get the AMRBox for a given block May return invalid box in case of errors, check with vtkAMRBox::IsInvalid.
const vtkAMRBox &	GetAMRBox (unsigned int level, unsigned int id)
	Set/Get the AMRBox for a given block May return invalid box in case of errors, check with vtkAMRBox::IsInvalid.
void	SetAMRBlockSourceIndex (unsigned int level, unsigned int id, int sourceId)
	Set/Get the source id of a block.
int	GetAMRBlockSourceIndex (unsigned int level, unsigned int id)
	Set/Get the source id of a block.
Public Member Functions inherited from vtkUniformGridAMR
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.
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 vtkOverlappingAMR *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOverlappingAMR *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIdTypeKey *	NUMBER_OF_BLANKED_POINTS ()
static vtkOverlappingAMR *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.
static vtkOverlappingAMR *	GetData (vtkInformationVector *v, int i=0)
Static Public Member Functions inherited from vtkUniformGridAMR
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
	vtkOverlappingAMR ()
	~vtkOverlappingAMR () override
void	InstantiateMetaData () override
	Create and set a new vtkOverlappingAMRMetaData as AMRMetaData.
Protected Member Functions inherited from vtkUniformGridAMR
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.
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 &)

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 allowing overlaps

vtkOverlappingAMR groups vtkUniformGrid into level of different refinement (AMR stands for Adaptive Mesh Refinement). See SetDataSet to add a new grid.

The grids of a level are expected to have the same spacing and refinement ratio. The refinement ratio represent the spacing factor between a level and the previous one. This class does not ensure the link between spacing and refinement ratio: please set them carefully.

Associated to each grid, a vtkAMRBox object describes the main information of the grid: origin, extent, spacing. When creating a vtkOverlappingAMR, you should call SetAMRBox for each block of each level.

In a distributed environement, the structure should be shared across all rank: the vtkOverlappingAMRMetaData and vtkAMRBox should be duplicated as needed.

See also

vtkOverlappingAMRMetaData, vtkNonOverlappingAMR, vtkUniformGridAMR, vtkAMRBox

Examples:

vtkOverlappingAMR (Examples)

Online Examples:

Generate2DAMRDataSetWithPulse

Generate3DAMRDataSetWithPulse

OverlappingAMR

Tests:

vtkOverlappingAMR (Tests)

Definition at line 86 of file vtkOverlappingAMR.h.

Member Typedef Documentation

Superclass

typedef vtkUniformGridAMR vtkOverlappingAMR::Superclass

Definition at line 95 of file vtkOverlappingAMR.h.

Constructor & Destructor Documentation

vtkOverlappingAMR()

vtkOverlappingAMR::vtkOverlappingAMR ( )

protected

~vtkOverlappingAMR()

vtkOverlappingAMR::~vtkOverlappingAMR ( )

overrideprotected

Member Function Documentation

New()

static vtkOverlappingAMR * vtkOverlappingAMR::New ( )

static

GetDataObjectType()

int vtkOverlappingAMR::GetDataObjectType ( )

inlineoverridevirtual

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

Reimplemented from vtkCompositeDataSet.

Definition at line 94 of file vtkOverlappingAMR.h.

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkOverlappingAMR::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

NewInstance()

vtkOverlappingAMR * vtkOverlappingAMR::NewInstance

(

)

const

NewIterator()

vtkCompositeDataIterator * vtkOverlappingAMR::NewIterator ( )

overridevirtual

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

Implements vtkCompositeDataSet.

SetOrigin()

void vtkOverlappingAMR::SetOrigin

(

const double

origin[3]

)

Get/Set the global origin of the amr data set.

GetOrigin() [1/2]

double * vtkOverlappingAMR::GetOrigin

(

)

Get/Set the global origin of the amr data set.

SetSpacing()

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

Get/Set the grid spacing at a given level.

Note that is expected (but not enforeced) that spacing evolves according to RefinementRatio factor from previous level to current. In pseudo code, you should ensure the following:

GetSpacing(lvl, spacing)
SetSpacing(lvl + 1, spacing / RefinementRatio)

See SetRefinementRatio.

GetSpacing()

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

Get/Set the grid spacing at a given level.

Note that is expected (but not enforeced) that spacing evolves according to RefinementRatio factor from previous level to current. In pseudo code, you should ensure the following:

GetSpacing(lvl, spacing)
SetSpacing(lvl + 1, spacing / RefinementRatio)

See SetRefinementRatio.

SetAMRBox()

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

Set/Get the AMRBox for a given block May return invalid box in case of errors, check with vtkAMRBox::IsInvalid.

GetAMRBox()

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

Set/Get the AMRBox for a given block May return invalid box in case of errors, check with vtkAMRBox::IsInvalid.

GetBounds() [1/4]

const double * vtkOverlappingAMR::GetBounds ( )

overridevirtual

If AMRMetaData is set and superclass bounds are empty, return AMRMetaData::GetBounds, return superclass bounds otherwise.

Reimplemented from vtkUniformGridAMR.

GetBounds() [2/4]

void vtkOverlappingAMR::GetBounds	(	unsigned int	level,
		unsigned int	id,
		double	bb[6]
	)

Returns the bounding information of a data set.

GetOrigin() [2/2]

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

Returns the origin of an AMR block.

NUMBER_OF_BLANKED_POINTS()

static vtkInformationIdTypeKey * vtkOverlappingAMR::NUMBER_OF_BLANKED_POINTS ( )

static

GetData() [1/2]

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

inlinestatic

Retrieve an instance of this class from an information object.

Definition at line 159 of file vtkOverlappingAMR.h.

GetData() [2/2]

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

inlinestatic

Definition at line 163 of file vtkOverlappingAMR.h.

SetRefinementRatio()

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.

GetRefinementRatio() [1/2]

int vtkOverlappingAMR::GetRefinementRatio

(

unsigned int

level

)

Returns the refinement of a given level or -1 if metadata is invalid.

SetAMRBlockSourceIndex()

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 Return -1 if meta data is invalid.

GetAMRBlockSourceIndex()

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 Return -1 if meta data is invalid.

GetRefinementRatio() [2/2]

int vtkOverlappingAMR::GetRefinementRatio

(

vtkCompositeDataIterator *

iter

)

Returns the refinement ratio for the position pointed by the iterator or -1 if refinement is invalid.

HasChildrenInformation()

bool vtkOverlappingAMR::HasChildrenInformation

(

)

Return whether parent child information has been generated.

GenerateParentChildInformation()

void vtkOverlappingAMR::GenerateParentChildInformation

(

)

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

GetParents()

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 or if meta data is invalid it returns nullptr.

GetChildren()

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 children ids in level+1. If none exits or meta data is invalid, it returns nullptr.

PrintParentChildInfo()

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

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

FindGrid()

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

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

Audit()

void vtkOverlappingAMR::Audit

(

)

Deprecated, forward to CheckValidity.

CheckValidity()

bool vtkOverlappingAMR::CheckValidity

(

)

Check whether the data set is internally consistent, e.g.

whether the meta data and actual data blocks match. Incorrectness will be reported as error messages Return true if correct, false otherwise.

GetOverlappingAMRMetaData()

vtkOverlappingAMRMetaData * vtkOverlappingAMR::GetOverlappingAMRMetaData

(

)

Convenience getter that get superclass MetaData and cast it to vtkOverlappingAMRMetaDat.

GetAMRInfo()

vtkOverlappingAMRMetaData * vtkOverlappingAMR::GetAMRInfo ( )

inlineoverridevirtual

Get/Set the AMR meta data Deprecated, use Get/SetAMRMetaData or GetOverlappingAMRMetaData.

Reimplemented from vtkUniformGridAMR.

Definition at line 260 of file vtkOverlappingAMR.h.

SetAMRInfo()

void vtkOverlappingAMR::SetAMRInfo ( vtkOverlappingAMRMetaData *  )

overridevirtual

Noop and deprecated, use GetAMRData/SetAMRMetaData instead.

Reimplemented from vtkUniformGridAMR.

InstantiateMetaData()

void vtkOverlappingAMR::InstantiateMetaData ( )

overrideprotectedvirtual

Create and set a new vtkOverlappingAMRMetaData as AMRMetaData.

Reimplemented from vtkUniformGridAMR.

GetBounds() [3/4]

void vtkUniformGridAMR::GetBounds

(

double

bounds[6]

)

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

GetBounds() [4/4]

virtual const double * vtkUniformGridAMR::GetBounds ( )

virtual

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

Reimplemented from vtkUniformGridAMR.

---

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

• Common/DataModel/vtkOverlappingAMR.h