VTK  9.3.20240527
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkUniformGridAMR Class Reference

a concrete implementation of vtkCompositeDataSet More...

#include <vtkUniformGridAMR.h>

Inheritance diagram for vtkUniformGridAMR:
[legend]
Collaboration diagram for vtkUniformGridAMR:
[legend]

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.
 
vtkUniformGridAMRNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkCompositeDataIteratorNewIterator () override
 Return a new iterator (the iterator has to be deleted by the user).
 
int GetDataObjectType () override
 Return class name of data type (see vtkType.h for definitions).
 
void Initialize () override
 Restore data object to initial state.
 
virtual void Initialize (int numLevels, const int *blocksPerLevel)
 Initialize the AMR with a specified number of levels and the blocks per level.
 
void SetGridDescription (int gridDescription)
 Set/Get the data description of this uniform grid instance, e.g.
 
int GetGridDescription ()
 
unsigned int GetNumberOfLevels ()
 Get number of levels.
 
virtual unsigned int GetTotalNumberOfBlocks ()
 Get the total number of blocks, including nullptr blocks.
 
unsigned int GetNumberOfDataSets (unsigned int level)
 Get the number of datasets at the given level, including null blocks.
 
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.
 
vtkDataObjectGetDataSet (vtkCompositeDataIterator *iter) override
 Get the data set pointed to by iter.
 
vtkUniformGridGetDataSet (unsigned int level, unsigned int idx)
 Get the data set using the (level, index) pair.
 
int GetCompositeIndex (unsigned int level, unsigned int index)
 Retrieves the composite index associated with the data at the given (level,index) pair.
 
void GetLevelAndIndex (unsigned int compositeIdx, unsigned int &level, unsigned int &idx)
 Given the compositeIdx (as set by SetCompositeIdx) this method returns the corresponding level and dataset index within the level.
 
void RecursiveShallowCopy (vtkDataObject *src) override
 Deprecated RecursiveShallowCopy method, uses ShallowCopy.
 
void DeepCopy (vtkDataObject *src) override
 DeepCopy.
 
void CopyStructure (vtkCompositeDataSet *src) override
 CopyStructure.
 
virtual vtkDataObjectGetDataSet (vtkCompositeDataIterator *iter)=0
 Returns the dataset located at the position pointed by the iterator.
 
virtual vtkDataObjectGetDataSet (unsigned int flatIndex)
 Returns the dataset located at the position pointed by the flatIndex.
 
void GetBounds (double bounds[6])
 Get the (min/max) bounds of the AMR domain.
 
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.
 
- 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.
 
vtkCompositeDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual vtkCompositeDataIteratorNewIterator ()=0
 Return a new iterator (the iterator has to be deleted by user).
 
int GetDataObjectType () 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 vtkDataObjectGetDataSet (vtkCompositeDataIterator *iter)=0
 Returns the dataset located at the position pointed by the iterator.
 
virtual vtkDataObjectGetDataSet (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 void RecursiveShallowCopy (vtkDataObject *src)
 
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.
 
vtkDataObjectNewInstance () 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 ()
 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 *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information.
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(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 ()
 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 vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type.
 
virtual vtkUnsignedCharArrayGetGhostArray (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 vtkFieldDataGetAttributesAsFieldData (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 vtkInformationGetInformation ()
 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 vtkFieldDataGetFieldData ()
 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.
 
vtkCommandGetCommand (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 vtkUniformGridAMRNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUniformGridAMRSafeDownCast (vtkObjectBase *o)
 
static vtkUniformGridAMRGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkUniformGridAMRGetData (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 vtkCompositeDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkInformationStringKeyNAME ()
 Key used to put node name in the meta-data associated with a node.
 
static vtkInformationIntegerKeyCURRENT_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 vtkCompositeDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkCompositeDataSetGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static vtkInformationGetActiveFieldInformation (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 vtkInformationGetNamedFieldInformation (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 vtkInformationSetActiveAttribute (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 vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkDataObjectGetData (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 vtkObjectNew ()
 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkUniformGridAMR ()
 
 ~vtkUniformGridAMR () override
 
virtual vtkAMRDataInternalsGetAMRData ()
 Get/Set the meta AMR meta data.
 
virtual void SetAMRData (vtkAMRDataInternals *)
 Get/Set the meta AMR meta data.
 
virtual vtkAMRInformationGetAMRInfo ()
 Get/Set the meta AMR meta info.
 
virtual void SetAMRInfo (vtkAMRInformation *)
 Get/Set the meta AMR meta info.
 
- Protected Member Functions inherited from vtkCompositeDataSet
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCompositeDataSet ()
 
 ~vtkCompositeDataSet () override
 
- Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBaseNewInstanceInternal () 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 &)
 

Protected Attributes

double Bounds [6]
 
vtkAMRDataInternalsAMRData
 
vtkAMRInformationAMRInfo
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
vtkTypeBool DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- 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
 

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

Detailed Description

a concrete implementation of vtkCompositeDataSet

vtkUniformGridAMR is an AMR (hierarchical) composite dataset that holds vtkUniformGrids.

See also
vtkUniformGridAMRDataIterator

Definition at line 26 of file vtkUniformGridAMR.h.

Member Typedef Documentation

◆ Superclass

Definition at line 30 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

◆ 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 41 of file vtkUniformGridAMR.h.

◆ Initialize() [1/2]

void vtkUniformGridAMR::Initialize ( )
overridevirtual

Restore data object to initial state.

Reimplemented from vtkCompositeDataSet.

◆ Initialize() [2/2]

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_XYZ_GRID

◆ GetGridDescription()

int vtkUniformGridAMR::GetGridDescription ( )

◆ GetNumberOfLevels()

unsigned int vtkUniformGridAMR::GetNumberOfLevels ( )

Get number of levels.

◆ GetTotalNumberOfBlocks()

virtual unsigned int vtkUniformGridAMR::GetTotalNumberOfBlocks ( )
virtual

Get the total number of blocks, including nullptr blocks.

◆ GetNumberOfDataSets()

unsigned int vtkUniformGridAMR::GetNumberOfDataSets ( unsigned int  level)

Get the number of datasets at the given level, including null blocks.

◆ GetBounds() [1/2]

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

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

◆ GetBounds() [2/2]

const double * vtkUniformGridAMR::GetBounds ( )

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

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

◆ GetCompositeIndex()

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

Retrieves the composite index associated with the data at the given (level,index) pair.

◆ GetLevelAndIndex()

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

Given the compositeIdx (as set by SetCompositeIdx) this method returns the corresponding level and dataset index within the level.

◆ CompositeShallowCopy()

void vtkUniformGridAMR::CompositeShallowCopy ( vtkCompositeDataSet src)
overridevirtual

ShallowCopy.

Reimplemented from vtkCompositeDataSet.

◆ ShallowCopy()

void vtkUniformGridAMR::ShallowCopy ( vtkDataObject src)
overridevirtual

ShallowCopy.

Reimplemented from vtkDataObject.

◆ RecursiveShallowCopy()

void vtkUniformGridAMR::RecursiveShallowCopy ( vtkDataObject src)
overridevirtual

Deprecated RecursiveShallowCopy method, uses ShallowCopy.

Reimplemented from vtkCompositeDataSet.

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

◆ GetAMRData()

virtual vtkAMRDataInternals * vtkUniformGridAMR::GetAMRData ( )
protectedvirtual

Get/Set the meta AMR meta data.

◆ SetAMRData()

virtual void vtkUniformGridAMR::SetAMRData ( vtkAMRDataInternals )
protectedvirtual

Get/Set the meta AMR meta data.

◆ GetAMRInfo()

virtual vtkAMRInformation * vtkUniformGridAMR::GetAMRInfo ( )
protectedvirtual

Get/Set the meta AMR meta info.

Reimplemented in vtkOverlappingAMR.

◆ SetAMRInfo()

virtual void vtkUniformGridAMR::SetAMRInfo ( vtkAMRInformation )
protectedvirtual

Get/Set the meta AMR meta info.

Reimplemented in vtkOverlappingAMR.

◆ 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 183 of file vtkUniformGridAMR.h.

Member Data Documentation

◆ Bounds

double vtkUniformGridAMR::Bounds[6]
protected

Definition at line 157 of file vtkUniformGridAMR.h.

◆ AMRData

vtkAMRDataInternals* vtkUniformGridAMR::AMRData
protected

Definition at line 167 of file vtkUniformGridAMR.h.

◆ AMRInfo

vtkAMRInformation* vtkUniformGridAMR::AMRInfo
protected

Definition at line 177 of file vtkUniformGridAMR.h.


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