hierarchical dataset of vtkUniformGrids More...

#include <vtkOverlappingAMR.h>

Inheritance diagram for vtkOverlappingAMR:

Collaboration diagram for vtkOverlappingAMR:

Public Types
typedef vtkUniformGridAMR	Superclass
Public Member Functions
virtual int	GetDataObjectType ()
virtual int	IsA (const char *type)
vtkOverlappingAMR *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkCompositeDataIterator *	NewIterator ()
void	GetBounds (unsigned int level, unsigned int id, double *bb)
void	GetOrigin (unsigned int level, unsigned int id, double origin[3])
void	SetRefinementRatio (unsigned int level, int refRatio)
int	GetRefinementRatio (unsigned int level)
int	GetRefinementRatio (vtkCompositeDataIterator *iter)
bool	HasChildrenInformation ()
void	GenerateParentChildInformation ()
unsigned int *	GetParents (unsigned int level, unsigned int index, unsigned int &numParents)
unsigned int *	GetChildren (unsigned int level, unsigned int index, unsigned int &numChildren)
void	PrintParentChildInfo (unsigned int level, unsigned int index)
void	GetBounds (double b[6])
bool	FindGrid (double q[3], unsigned int &level, unsigned int &gridId)

void	SetOrigin (const double *)
double *	GetOrigin ()

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

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

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

vtkAMRInformation *	GetAMRInfo ()
virtual void	SetAMRInfo (vtkAMRInformation *info)
Static Public Member Functions
static vtkOverlappingAMR *	New ()
static int	IsTypeOf (const char *type)
static vtkOverlappingAMR *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIdTypeKey *	NUMBER_OF_BLANKED_POINTS ()

static vtkOverlappingAMR *	GetData (vtkInformation *info)
static vtkOverlappingAMR *	GetData (vtkInformationVector *v, int i=0)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
void	Audit ()
	vtkOverlappingAMR ()
virtual	~vtkOverlappingAMR ()

Detailed Description

hierarchical dataset of vtkUniformGrids

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

See also:: vtkAMRInformation

Examples:: vtkOverlappingAMR (Examples)

Tests:: vtkOverlappingAMR (Tests)

Definition at line 45 of file vtkOverlappingAMR.h.

Member Typedef Documentation

typedef vtkUniformGridAMR vtkOverlappingAMR::Superclass

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

Definition at line 53 of file vtkOverlappingAMR.h.

Constructor & Destructor Documentation

vtkOverlappingAMR::vtkOverlappingAMR ( ) [protected]

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

virtual vtkOverlappingAMR::~vtkOverlappingAMR ( ) [protected, virtual]

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

Member Function Documentation

static vtkOverlappingAMR* vtkOverlappingAMR::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

virtual int vtkOverlappingAMR::GetDataObjectType ( ) [inline, virtual]

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

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

Definition at line 51 of file vtkOverlappingAMR.h.

static int vtkOverlappingAMR::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

virtual int vtkOverlappingAMR::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

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

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

virtual vtkObjectBase* vtkOverlappingAMR::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

vtkOverlappingAMR* vtkOverlappingAMR::NewInstance ( ) const

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

void vtkOverlappingAMR::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

virtual vtkCompositeDataIterator* vtkOverlappingAMR::NewIterator ( ) [virtual]

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

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

void vtkOverlappingAMR::SetOrigin ( const double * )

Get/Set the global origin of the amr data set

double* vtkOverlappingAMR::GetOrigin ( )

Get/Set the global origin of the amr data set

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

Get/Set the grid spacing at a given level

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

Get/Set the grid spacing at a given level

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

Set/Get the AMRBox for a given block

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

Set/Get the AMRBox for a given block

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

Returns the bounding information of a data set.

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

Returns the origin of an AMR block

static vtkInformationIdTypeKey* vtkOverlappingAMR::NUMBER_OF_BLANKED_POINTS ( ) [static]

static vtkOverlappingAMR* vtkOverlappingAMR::GetData ( vtkInformation * info ) [inline, static]

Retrieve an instance of this class from an information object.

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

Definition at line 89 of file vtkOverlappingAMR.h.

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

Retrieve an instance of this class from an information object.

Reimplemented from vtkUniformGridAMR.

Reimplemented in vtkHierarchicalBoxDataSet.

Definition at line 91 of file vtkOverlappingAMR.h.

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

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

int vtkOverlappingAMR::GetRefinementRatio ( unsigned int level )

Returns the refinement of a given level.

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

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

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

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

int vtkOverlappingAMR::GetRefinementRatio ( vtkCompositeDataIterator * iter )

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

bool vtkOverlappingAMR::HasChildrenInformation ( )

Return whether parent child information has been generated

void vtkOverlappingAMR::GenerateParentChildInformation ( )

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

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

Return a pointer to Parents of a block. The first entry is the number of parents the block has followed by its parent ids in level-1. If none exits it returns NULL.

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

Return a pointer to Children of a block. The first entry is the number of children the block has followed by its childern ids in level+1. If none exits it returns NULL.

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

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

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

Reimplemented from vtkUniformGridAMR.

Definition at line 139 of file vtkOverlappingAMR.h.

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

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

vtkAMRInformation* vtkOverlappingAMR::GetAMRInfo ( ) [inline, virtual]

Get/Set the interal representation of amr meta meta data

Reimplemented from vtkUniformGridAMR.

Definition at line 146 of file vtkOverlappingAMR.h.

virtual void vtkOverlappingAMR::SetAMRInfo ( vtkAMRInformation * info ) [inline, virtual]

Get/Set the interal representation of amr meta meta data

Reimplemented from vtkUniformGridAMR.

Definition at line 147 of file vtkOverlappingAMR.h.

void vtkOverlappingAMR::Audit ( )

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

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

dox/Common/DataModel/vtkOverlappingAMR.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation