#include <vtkAbstractGridConnectivity.h>

Inheritance diagram for vtkAbstractGridConnectivity:

Collaboration diagram for vtkAbstractGridConnectivity:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAbstractGridConnectivity *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetNumberOfGrids (const unsigned int N)=0

unsigned int	GetNumberOfGrids ()

virtual void	ComputeNeighbors ()=0

virtual void	CreateGhostLayers (const int N=1)=0

vtkUnsignedCharArray *	GetGhostedPointGhostArray (const int gridID)

vtkUnsignedCharArray *	GetGhostedCellGhostArray (const int gridID)

vtkPointData *	GetGhostedGridPointData (const int gridID)

vtkCellData *	GetGhostedGridCellData (const int gridID)

vtkPoints *	GetGhostedPoints (const int gridID)


virtual void	SetNumberOfGhostLayers (unsigned int)

virtual unsigned int	GetNumberOfGhostLayers ()

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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

static vtkAbstractGridConnectivity *	SafeDownCast (vtkObjectBase *o)

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

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractGridConnectivity ()

virtual	~vtkAbstractGridConnectivity ()

void	RegisterGridNodes (const int gridID, vtkPoints *nodes)


virtual void	FillGhostArrays (const int gridId, vtkUnsignedCharArray nodesArray, vtkUnsignedCharArray cellsArray)=0


void	RegisterGridGhostArrays (const int gridID, vtkUnsignedCharArray nodesArray, vtkUnsignedCharArray cellsArray)


void	RegisterFieldData (const int gridID, vtkPointData PointData, vtkCellData CellData)


void	AllocateUserRegisterDataStructures ()

void	DeAllocateUserRegisterDataStructures ()


void	AllocateInternalDataStructures ()

void	DeAllocateInternalDataStructures ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
unsigned int	NumberOfGrids

unsigned int	NumberOfGhostLayers

std::vector< vtkUnsignedCharArray * >	GridPointGhostArrays

std::vector< vtkUnsignedCharArray * >	GridCellGhostArrays

std::vector< vtkPointData * >	GridPointData

std::vector< vtkCellData * >	GridCellData

std::vector< vtkPoints * >	GridPoints

bool	AllocatedGhostDataStructures

std::vector< vtkPointData * >	GhostedGridPointData

std::vector< vtkCellData * >	GhostedGridCellData

std::vector< vtkUnsignedCharArray * >	GhostedPointGhostArray

std::vector< vtkUnsignedCharArray * >	GhostedCellGhostArray

std::vector< vtkPoints * >	GhostedGridPoints

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

A superclass that defines the interface to be implemented by all concrete grid connectivity classes. Grid connectivity classes provide the mechanism to achieve the following:

Handling of partitioned/distributed data

Construct the neighboring topology information for each partition,e.g., used for creating communication lists and in computing statistics,i.e., average, mean, etc.

Creation of ghost layers

Provides the mechanism for automatically generating ghost information given a partitioned/distributed grid configuration.

See also: vtkStructuredGridConnectivity vtkStructuredAMRGridConnectivity

Definition at line 62 of file vtkAbstractGridConnectivity.h.

Member Typedef Documentation

typedef vtkObject vtkAbstractGridConnectivity::Superclass

Definition at line 65 of file vtkAbstractGridConnectivity.h.

Constructor & Destructor Documentation

vtkAbstractGridConnectivity::vtkAbstractGridConnectivity ( )

protected

virtual vtkAbstractGridConnectivity::~vtkAbstractGridConnectivity ( )

protectedvirtual

Member Function Documentation

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

static

virtual int vtkAbstractGridConnectivity::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 vtkObject.

Reimplemented in vtkStructuredGridConnectivity, vtkPStructuredGridConnectivity, and vtkStructuredAMRGridConnectivity.

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

static

virtual vtkObjectBase* vtkAbstractGridConnectivity::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkStructuredGridConnectivity, vtkPStructuredGridConnectivity, and vtkStructuredAMRGridConnectivity.

vtkAbstractGridConnectivity* vtkAbstractGridConnectivity::NewInstance ( ) const

void vtkAbstractGridConnectivity::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 vtkObject.

Reimplemented in vtkStructuredGridConnectivity, vtkPStructuredGridConnectivity, and vtkStructuredAMRGridConnectivity.

virtual void vtkAbstractGridConnectivity::SetNumberOfGhostLayers ( unsigned int )

virtual

Set/Get the number of ghost layers

virtual unsigned int vtkAbstractGridConnectivity::GetNumberOfGhostLayers ( )

virtual

Set/Get the number of ghost layers

virtual void vtkAbstractGridConnectivity::SetNumberOfGrids ( const unsigned int N )

pure virtual

Sets the total number of grids in the domain. Note: This method is implemented by concrete classes. NOTE: Concrete classes implementing this pure virtual method must set the number of grids and call AllocateUserRegisterDataStructures in addition to defining any other additional functionality.

Implemented in vtkStructuredAMRGridConnectivity, vtkStructuredGridConnectivity, and vtkPStructuredGridConnectivity.

unsigned int vtkAbstractGridConnectivity::GetNumberOfGrids ( )

inline

Returns the total number of grids.

Definition at line 82 of file vtkAbstractGridConnectivity.h.

virtual void vtkAbstractGridConnectivity::ComputeNeighbors ( )

pure virtual

Computes the grid neighboring topology for the domain

Implemented in vtkStructuredGridConnectivity, vtkPStructuredGridConnectivity, and vtkStructuredAMRGridConnectivity.

virtual void vtkAbstractGridConnectivity::CreateGhostLayers ( const int N = 1 )

pure virtual

Creates N layers of ghost layers where N is the number of cells that will be added to each grid. If no parameter is supplied, N has a nominal value of 1, in which case 1 layer of cells would be added. NOTE: This method is implemented by concrete implementations

Implemented in vtkStructuredGridConnectivity, vtkPStructuredGridConnectivity, and vtkStructuredAMRGridConnectivity.

vtkUnsignedCharArray * vtkAbstractGridConnectivity::GetGhostedPointGhostArray ( const int gridID )

inline

Returns the ghosted points ghost array for the grid associated with the given grid ID. The return pointer is a shallow-copy of the internal data-structure. The pointer may be NULL iff there is no ghosted points ghost array for the requested grid.

Definition at line 195 of file vtkAbstractGridConnectivity.h.

vtkUnsignedCharArray * vtkAbstractGridConnectivity::GetGhostedCellGhostArray ( const int gridID )

inline

Returns the ghosted cells ghost array for the grid associated with the given grid ID. The return pointer is a shallow-copy of the internal data-structure. The pointer may be NULL iff there is no ghosted cells ghost array for the requested grid.

Definition at line 213 of file vtkAbstractGridConnectivity.h.

vtkPointData * vtkAbstractGridConnectivity::GetGhostedGridPointData ( const int gridID )

inline

Returns the ghosted grid point data for the grid associated with the given grid ID. The return pointer is a shallow-copy of the internal data-structure. The pointer may be NULL iff there is no ghosted point data for the requested grid.

Definition at line 230 of file vtkAbstractGridConnectivity.h.

vtkCellData * vtkAbstractGridConnectivity::GetGhostedGridCellData ( const int gridID )

inline

Returns the ghosted grid cell data for the grid associated with the given grid ID. The return pointer is a shallow-copy of the internal data-structure. The pointer may be NULL iff there is no ghosted cell data for the requested grid.

Definition at line 247 of file vtkAbstractGridConnectivity.h.

vtkPoints * vtkAbstractGridConnectivity::GetGhostedPoints ( const int gridID )

inline

Returns the ghosted grid points for the grid associated with the given grid ID. The return pointer is a shallow-copy of the internal data structure. The pointer may be NULL iff there are no ghosted points created for the requested grid.

Definition at line 264 of file vtkAbstractGridConnectivity.h.

virtual void vtkAbstractGridConnectivity::FillGhostArrays	(	const int	gridId,
		vtkUnsignedCharArray *	nodesArray,
		vtkUnsignedCharArray *	cellsArray
	)

protectedpure virtual

Fills the ghost arrays for the given grid.

Implemented in vtkStructuredAMRGridConnectivity, and vtkStructuredGridConnectivity.

void vtkAbstractGridConnectivity::RegisterGridGhostArrays	(	const int	gridID,
		vtkUnsignedCharArray *	nodesArray,
		vtkUnsignedCharArray *	cellsArray
	)

inlineprotected

Registers the ghostarrays for the given grid.

Definition at line 411 of file vtkAbstractGridConnectivity.h.

void vtkAbstractGridConnectivity::RegisterFieldData	(	const int	gridID,
		vtkPointData *	PointData,
		vtkCellData *	CellData
	)

inlineprotected

Registers the grid's field data, i.e., the node and cell data.

Definition at line 430 of file vtkAbstractGridConnectivity.h.

void vtkAbstractGridConnectivity::RegisterGridNodes	(	const int	gridID,
		vtkPoints *	nodes
	)

inlineprotected

Registers the grid nodes for the grid associated with the given gridID.

Definition at line 468 of file vtkAbstractGridConnectivity.h.

void vtkAbstractGridConnectivity::AllocateUserRegisterDataStructures ( )

inlineprotected

Allocate/De-allocate the data-structures where the user-supplied grids will be registered.

Definition at line 281 of file vtkAbstractGridConnectivity.h.

void vtkAbstractGridConnectivity::DeAllocateUserRegisterDataStructures ( )

inlineprotected

Allocate/De-allocate the data-structures where the user-supplied grids will be registered.

Definition at line 296 of file vtkAbstractGridConnectivity.h.

void vtkAbstractGridConnectivity::AllocateInternalDataStructures ( )

inlineprotected

Allocated/De-allocate the data-structures where the ghosted grid data will be stored.

Definition at line 344 of file vtkAbstractGridConnectivity.h.

void vtkAbstractGridConnectivity::DeAllocateInternalDataStructures ( )

inlineprotected

Allocated/De-allocate the data-structures where the ghosted grid data will be stored.

Definition at line 359 of file vtkAbstractGridConnectivity.h.

Member Data Documentation

unsigned int vtkAbstractGridConnectivity::NumberOfGrids

protected

Definition at line 168 of file vtkAbstractGridConnectivity.h.

unsigned int vtkAbstractGridConnectivity::NumberOfGhostLayers

protected

Definition at line 169 of file vtkAbstractGridConnectivity.h.

std::vector< vtkUnsignedCharArray* > vtkAbstractGridConnectivity::GridPointGhostArrays

protected

Definition at line 173 of file vtkAbstractGridConnectivity.h.

std::vector< vtkUnsignedCharArray* > vtkAbstractGridConnectivity::GridCellGhostArrays

protected

Definition at line 174 of file vtkAbstractGridConnectivity.h.

std::vector< vtkPointData* > vtkAbstractGridConnectivity::GridPointData

protected

Definition at line 175 of file vtkAbstractGridConnectivity.h.

std::vector< vtkCellData* > vtkAbstractGridConnectivity::GridCellData

protected

Definition at line 176 of file vtkAbstractGridConnectivity.h.

std::vector< vtkPoints* > vtkAbstractGridConnectivity::GridPoints

protected

Definition at line 177 of file vtkAbstractGridConnectivity.h.

bool vtkAbstractGridConnectivity::AllocatedGhostDataStructures

protected

Definition at line 180 of file vtkAbstractGridConnectivity.h.

std::vector< vtkPointData* > vtkAbstractGridConnectivity::GhostedGridPointData

protected

Definition at line 181 of file vtkAbstractGridConnectivity.h.

std::vector< vtkCellData* > vtkAbstractGridConnectivity::GhostedGridCellData

protected

Definition at line 182 of file vtkAbstractGridConnectivity.h.

std::vector< vtkUnsignedCharArray* > vtkAbstractGridConnectivity::GhostedPointGhostArray

protected

Definition at line 183 of file vtkAbstractGridConnectivity.h.

std::vector< vtkUnsignedCharArray* > vtkAbstractGridConnectivity::GhostedCellGhostArray

protected

Definition at line 184 of file vtkAbstractGridConnectivity.h.

std::vector< vtkPoints* > vtkAbstractGridConnectivity::GhostedGridPoints

protected

Definition at line 185 of file vtkAbstractGridConnectivity.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Filters/Geometry/vtkAbstractGridConnectivity.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation