A superclass that defines the interface to be implemented by all concrete grid connectivity classes. More...

#include <vtkAbstractGridConnectivity.h>

Inheritance diagram for vtkAbstractGridConnectivity:

Collaboration diagram for vtkAbstractGridConnectivity:

Public Types
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.

vtkAbstractGridConnectivity *	NewInstance () const

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

virtual void	SetNumberOfGrids (unsigned int N)=0
	Sets the total number of grids in the domain.

unsigned int	GetNumberOfGrids ()
	Returns the total number of grids.

virtual void	ComputeNeighbors ()=0
	Computes the grid neighboring topology for the domain.

virtual void	CreateGhostLayers (int N=1)=0
	Creates N layers of ghost layers where N is the number of cells that will be added to each grid.

vtkUnsignedCharArray *	GetGhostedPointGhostArray (int gridID)
	Returns the ghosted points ghost array for the grid associated with the given grid ID.

vtkUnsignedCharArray *	GetGhostedCellGhostArray (int gridID)
	Returns the ghosted cells ghost array for the grid associated with the given grid ID.

vtkPointData *	GetGhostedGridPointData (int gridID)
	Returns the ghosted grid point data for the grid associated with the given grid ID.

vtkCellData *	GetGhostedGridCellData (int gridID)
	Returns the ghosted grid cell data for the grid associated with the given grid ID.

vtkPoints *	GetGhostedPoints (int gridID)
	Returns the ghosted grid points for the grid associated with the given grid ID.


virtual void	SetNumberOfGhostLayers (unsigned int)
	Set/Get the number of ghost layers.

virtual unsigned int	GetNumberOfGhostLayers ()
	Set/Get the number of ghost layers.

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 vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractGridConnectivity *	SafeDownCast (vtkObjectBase *o)

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

	vtkAbstractGridConnectivity ()

	~vtkAbstractGridConnectivity () override

virtual void	FillGhostArrays (int gridId, vtkUnsignedCharArray nodesArray, vtkUnsignedCharArray cellsArray)=0
	Fills the ghost arrays for the given grid.

void	RegisterGridGhostArrays (int gridID, vtkUnsignedCharArray nodesArray, vtkUnsignedCharArray cellsArray)
	Registers the ghostarrays for the given grid.

void	RegisterFieldData (int gridID, vtkPointData PointData, vtkCellData CellData)
	Registers the grid's field data, i.e., the node and cell data.

void	RegisterGridNodes (int gridID, vtkPoints *nodes)
	Registers the grid nodes for the grid associated with the given gridID.


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

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


void	AllocateInternalDataStructures ()
	Allocated/De-allocate the data-structures where the ghosted grid data will be stored.

void	DeAllocateInternalDataStructures ()
	Allocated/De-allocate the data-structures where the ghosted grid data will be stored.

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

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 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 54 of file vtkAbstractGridConnectivity.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkAbstractGridConnectivity::Superclass

Definition at line 57 of file vtkAbstractGridConnectivity.h.

Constructor & Destructor Documentation

◆ vtkAbstractGridConnectivity()

vtkAbstractGridConnectivity::vtkAbstractGridConnectivity ( )

protected

◆ ~vtkAbstractGridConnectivity()

vtkAbstractGridConnectivity::~vtkAbstractGridConnectivity ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

Reimplemented in vtkStructuredAMRGridConnectivity, vtkStructuredGridConnectivity, and vtkPStructuredGridConnectivity.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAbstractGridConnectivity::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkStructuredAMRGridConnectivity, vtkStructuredGridConnectivity, and vtkPStructuredGridConnectivity.

◆ NewInstance()

vtkAbstractGridConnectivity * vtkAbstractGridConnectivity::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkStructuredAMRGridConnectivity, vtkStructuredGridConnectivity, and vtkPStructuredGridConnectivity.

◆ SetNumberOfGhostLayers()

virtual void vtkAbstractGridConnectivity::SetNumberOfGhostLayers ( unsigned int )

virtual

Set/Get the number of ghost layers.

◆ GetNumberOfGhostLayers()

virtual unsigned int vtkAbstractGridConnectivity::GetNumberOfGhostLayers ( )

virtual

Set/Get the number of ghost layers.

◆ SetNumberOfGrids()

virtual void vtkAbstractGridConnectivity::SetNumberOfGrids ( 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.

◆ GetNumberOfGrids()

unsigned int vtkAbstractGridConnectivity::GetNumberOfGrids ( )

inline

Returns the total number of grids.

Definition at line 80 of file vtkAbstractGridConnectivity.h.

◆ ComputeNeighbors()

virtual void vtkAbstractGridConnectivity::ComputeNeighbors ( )

pure virtual

Computes the grid neighboring topology for the domain.

Implemented in vtkStructuredAMRGridConnectivity, vtkStructuredGridConnectivity, and vtkPStructuredGridConnectivity.

◆ CreateGhostLayers()

virtual void vtkAbstractGridConnectivity::CreateGhostLayers ( 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 vtkStructuredAMRGridConnectivity, vtkStructuredGridConnectivity, and vtkPStructuredGridConnectivity.

◆ GetGhostedPointGhostArray()

vtkUnsignedCharArray * vtkAbstractGridConnectivity::GetGhostedPointGhostArray ( 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 nullptr iff there is no ghosted points ghost array for the requested grid.

Definition at line 204 of file vtkAbstractGridConnectivity.h.

◆ GetGhostedCellGhostArray()

vtkUnsignedCharArray * vtkAbstractGridConnectivity::GetGhostedCellGhostArray ( 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 nullptr iff there is no ghosted cells ghost array for the requested grid.

Definition at line 220 of file vtkAbstractGridConnectivity.h.

◆ GetGhostedGridPointData()

vtkPointData * vtkAbstractGridConnectivity::GetGhostedGridPointData ( 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 nullptr iff there is no ghosted point data for the requested grid.

Definition at line 236 of file vtkAbstractGridConnectivity.h.

◆ GetGhostedGridCellData()

vtkCellData * vtkAbstractGridConnectivity::GetGhostedGridCellData ( 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 nullptr iff there is no ghosted cell data for the requested grid.

Definition at line 252 of file vtkAbstractGridConnectivity.h.

◆ GetGhostedPoints()

vtkPoints * vtkAbstractGridConnectivity::GetGhostedPoints ( 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 nullptr iff there are no ghosted points created for the requested grid.

Definition at line 268 of file vtkAbstractGridConnectivity.h.