vtkStructuredGridConnectivity is a concrete instance of vtkObject that implements functionality for computing the neighboring topology within a single partitioned structured grid dataset. More...

#include <vtkStructuredGridConnectivity.h>

Inheritance diagram for vtkStructuredGridConnectivity:

[legend]

Collaboration diagram for vtkStructuredGridConnectivity:

[legend]

Public Types
typedef vtkAbstractGridConnectivity	Superclass

Public Types inherited from vtkAbstractGridConnectivity
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. More...

vtkStructuredGridConnectivity *	NewInstance () const

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

void	SetNumberOfGrids (const unsigned int N) override
	Set/Get the total number of domains distributed among processors. More...

virtual void	RegisterGrid (const int gridID, int extents[6], vtkUnsignedCharArray nodesGhostArray, vtkUnsignedCharArray cellGhostArray, vtkPointData pointData, vtkCellData cellData, vtkPoints *gridNodes)
	Registers the current grid corresponding to the grid ID by its global extent w.r.t. More...

void	GetGridExtent (const int gridID, int extent[6])
	Returns the grid extent of the grid corresponding to the given grid ID. More...

void	SetGhostedGridExtent (const int gridID, int ext[6])
	Sets the ghosted grid extent for the grid corresponding to the given grid ID to the given extent. More...

void	GetGhostedGridExtent (const int gridID, int ext[6])
	Returns the ghosted grid extent for the block corresponding the. More...

void	ComputeNeighbors () override
	Computes neighboring information. More...

int	GetNumberOfNeighbors (const int gridID)
	Returns the number of neighbors for the grid corresponding to the given grid ID. More...

vtkStructuredNeighbor	GetGridNeighbor (const int gridID, const int nei)
	Returns the neighbor corresponding to the index nei for the grid with the given (global) grid ID. More...

vtkIdList *	GetNeighbors (const int gridID, int *extents)
	Returns the list of neighboring blocks for the given grid and the corresponding overlapping extents are filled in the 1-D flat array strided by 6. More...

void	FillGhostArrays (const int gridID, vtkUnsignedCharArray nodesArray, vtkUnsignedCharArray cellsArray) override
	Fills the mesh property arrays, nodes and cells, for the grid corresponding to the given grid ID. More...

void	CreateGhostLayers (const int N=1) override
	Creates ghost layers. More...


virtual void	SetWholeExtent (int, int, int, int, int, int)
	Set/Get the whole extent of the grid. More...

virtual void	SetWholeExtent (int[6])
	Set/Get the whole extent of the grid. More...

virtual int *	GetWholeExtent ()
	Set/Get the whole extent of the grid. More...

virtual void	GetWholeExtent (int &, int &, int &, int &, int &, int &)
	Set/Get the whole extent of the grid. More...

virtual void	GetWholeExtent (int[6])
	Set/Get the whole extent of the grid. More...


virtual int	GetDataDimension ()
	Returns the data dimension based on the whole extent. More...

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

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

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

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

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

Static Public Member Functions
static vtkStructuredGridConnectivity *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkStructuredGridConnectivity *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractGridConnectivity
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. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkStructuredGridConnectivity ()

	~vtkStructuredGridConnectivity () override

bool	InBounds (const int idx, const int Lo, const int Hi)
	Returns true iff Lo <= idx <= Hi, otherwise false. More...

bool	StrictlyInsideBounds (const int idx, const int Lo, const int Hi)
	Returns true iff Lo < idx < Hi, otherwise false. More...

bool	IsSubset (int A[2], int B[2])
	Returns true iff A is a subset of B, otherwise false. More...

int	Cardinality (int S[2])
	Returns the cardinality of a range S. More...

void	FillNodesGhostArray (const int gridID, const int dataDescription, int GridExtent[6], int RealExtent[6], vtkUnsignedCharArray *nodeArray)
	Fills the ghost array for the nodes. More...

void	FillCellsGhostArray (const int dataDescription, const int numNodesPerCell, int dims[3], int CellExtent[6], vtkUnsignedCharArray nodesArray, vtkUnsignedCharArray cellsArray)
	Fills the ghost array for the grid cells. More...

void	SearchNeighbors (const int gridID, const int i, const int j, const int k, vtkIdList *neiList)
	Given a point (i,j,k) belonging to the grid corresponding to the given gridID, this method searches for the grids that this point is neighboring with. More...

void	MarkNodeProperty (const int gridID, const int i, const int j, const int k, int ext[6], int RealExtent[6], unsigned char &pfield)
	Marks the node properties with the node with the given global i,j,k grid coordinates w.r.t. More...

void	MarkCellProperty (unsigned char &pfield, unsigned char *nodeGhostFields, const int numNodes)
	Marks the cell property for the cell composed by the nodes with the given ghost fields. More...

void	GetRealExtent (const int gridID, int GridExtent[6], int RealExtent[6])
	Given a grid extent, this method computes the RealExtent. More...

bool	IsGhostNode (int GridExtent[6], int RealExtent[6], const int i, const int j, const int k)
	Checks if the node corresponding to the given global i,j,k coordinates is a ghost node or not. More...

bool	IsNodeOnBoundaryOfExtent (const int i, const int j, const int k, int ext[6])
	Checks if the node corresponding to the given global i,j,k coordinates is on the boundary of the given extent. More...

bool	IsNodeOnSharedBoundary (const int gridID, int RealExtent[6], const int i, const int j, const int k)
	Checks if the node corresponding to the given global i,j,k coordinates is on the shared boundary, i.e., a partition interface. More...

bool	IsNodeOnBoundary (const int i, const int j, const int k)
	Checks if the node corresponding to the given global i,j,k coordinates touches the real boundaries of the domain given the whole extent. More...

bool	IsNodeInterior (const int i, const int j, const int k, int GridExtent[6])
	Checks if the node, corresponding to the given global i,j,k coordinates is within the interior of the given global grid extent. More...

bool	IsNodeWithinExtent (const int i, const int j, const int k, int GridExtent[6])
	Checks if the node corresponding to the given global i,j,k coordinates is within the given extent, inclusive of the extent bounds. More...

void	SetNeighbors (const int i, const int j, int i2jOrientation[3], int j2iOrientation[3], int overlapExtent[6])
	Creates a neighbor from i-to-j and from j-to-i. More...

void	DetermineNeighborOrientation (const int idx, int A[2], int B[2], int overlap[2], int orient[3])
	Given two overlapping extents A,B and the corresponding overlap extent this method computes A's relative neighboring orientation w.r.t to its neighbor, B. More...

void	DetectNeighbors (const int i, const int j, int ex1[6], int ex2[6], int orientation[3], int ndim)
	Detects if the two extents, ex1 and ex2, corresponding to the grids with grid IDs i,j respectively, are neighbors, i.e, they either share a corner, an edge or a plane in 3-D. More...

int	IntervalOverlap (int A[2], int B[2], int overlap[2])
	Checks if the intervals A,B overlap. More...

int	DoPartialOverlap (int s[2], int S[2], int overlap[2])
	Checks if the internals s,S partially overlap where \|s\| < \|S\|. More...

int	PartialOverlap (int A[2], const int CofA, int B[2], const int CofB, int overlap[2])
	Checks if the intervals A,B partially overlap. More...

void	EstablishNeighbors (const int i, const int j)
	Establishes the neighboring information between the two grids corresponding to grid ids "i" and "j" with i < j. More...

void	AcquireDataDescription ()
	Based on the user-supplied WholeExtent, this method determines the topology of the structured domain, e.g., VTK_XYZ_GRID, VTK_XY_PLANE, etc. More...

bool	HasBlockConnection (const int gridID, const int blockDirection)
	Checks if the block corresponding to the given grid ID has a block adjacent to it in the given block direction. More...

void	RemoveBlockConnection (const int gridID, const int blockDirection)
	Removes a block connection along the given direction for the block corresponding to the given gridID. More...

void	AddBlockConnection (const int gridID, const int blockDirection)
	Adds a block connection along the given direction for the block corresponding to the given gridID. More...

void	ClearBlockConnections (const int gridID)
	Clears all block connections for the block corresponding to the given grid ID. More...

int	GetNumberOfConnectingBlockFaces (const int gridID)
	Returns the number of faces of the block corresponding to the given grid ID that are adjacent to at least one other block. More...

void	SetBlockTopology (const int gridID)
	Sets the block topology connections for the grid corresponding to gridID. More...

void	GetIJKBlockOrientation (const int i, const int j, const int k, int ext[6], int orientation[3])
	Given i-j-k coordinates and the grid defined by tis extent, ext, this method determines IJK orientation with respect to the block boundaries, i.e., the 6 block faces. More...

int	Get1DOrientation (const int idx, const int ExtentLo, const int ExtentHi, const int OnLo, const int OnHi, const int NotOnBoundary)
	A helper method that computes the 1-D i-j-k orientation to facilitate the implementation of GetNodeBlockOrientation. More...

void	CreateGhostedExtent (const int gridID, const int N)
	Creates the ghosted extent of the grid corresponding to the given gridID. More...

void	GetGhostedExtent (int *ghostedExtent, int GridExtent[6], const int minIdx, const int maxIdx, const int N)
	Gets the ghosted extent from the given grid extent along the dimension given by minIdx and maxIdx. More...

void	CreateGhostedMaskArrays (const int gridID)
	This method creates the ghosted mask arrays, i.e., the NodeGhostArrays and the CellGhostArrays for the grid corresponding to the given gridID. More...

void	InitializeGhostData (const int gridID)
	This method initializes the ghost data according to the computed ghosted grid extent for the grid with the given grid ID. More...

void	AllocatePointData (vtkPointData RPD, const int N, vtkPointData PD)
	Adds/creates all the arrays in the reference grid point data, RPD, to the user-supplied point data instance, PD, where the number of points is given by N. More...

void	AllocateCellData (vtkCellData RCD, const int N, vtkCellData CD)
	Adds/creates all the arrays in the reference grid cell data, RCD, to the user-supplied cell data instance, CD, where the number of cells is given by N. More...

void	TransferRegisteredDataToGhostedData (const int gridID)
	This method transfers the registered grid data to the corresponding ghosted grid data. More...

void	ComputeNeighborSendAndRcvExtent (const int gridID, const int N)
	This method computes, the send and rcv extents for each neighbor of each grid. More...

virtual void	TransferGhostDataFromNeighbors (const int gridID)
	This method transfers the fields (point data and cell data) to the ghost extents from the neighboring grids of the grid corresponding to the given gridID. More...

void	TransferLocalNeighborData (const int gridID, const vtkStructuredNeighbor &Neighor)
	This method transfers the fields. More...

void	CopyCoordinates (vtkPoints source, vtkIdType sourceIdx, vtkPoints target, vtkIdType targetIdx)
	Copies the coordinates from the source points to the target points. More...

void	CopyFieldData (vtkFieldData source, vtkIdType sourceIdx, vtkFieldData target, vtkIdType targetIdx)
	Loops through all arrays in the source and for each array, it copies the tuples from sourceIdx to the target at targetIdx. More...

int	GetNeighborIndex (const int gridIdx, const int NeighborGridIdx)
	Given a global grid ID and the neighbor grid ID, this method returns the neighbor index w.r.t. More...

void	PrintExtent (int extent[6])
	Prints the extent, used for debugging. More...


int	GetNumberOfNodesPerCell (const int dim)
	Returns the number of nodes per cell according to the given dimension. More...

Protected Member Functions inherited from vtkAbstractGridConnectivity
	vtkAbstractGridConnectivity ()

	~vtkAbstractGridConnectivity () override

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

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

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

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

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

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

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

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

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

int	DataDescription

int	WholeExtent [6]

std::vector< int >	GridExtents

std::vector< int >	GhostedExtents

std::vector< unsigned char >	BlockTopology

std::vector< std::vector< vtkStructuredNeighbor > >	Neighbors

std::map< std::pair< int, int >, int >	NeighborPair2NeighborListIndex

Protected Attributes inherited from vtkAbstractGridConnectivity
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

vtkStructuredGridConnectivity is a concrete instance of vtkObject that implements functionality for computing the neighboring topology within a single partitioned structured grid dataset.

This class implementation does not have any support for distributed data. For the parallel implementation see vtkPStructuredGridConnectivity.

See also: vtkPStructuredGridConnectivity

Tests:: vtkStructuredGridConnectivity (Tests)

Definition at line 60 of file vtkStructuredGridConnectivity.h.

Member Typedef Documentation

typedef vtkAbstractGridConnectivity vtkStructuredGridConnectivity::Superclass

Definition at line 65 of file vtkStructuredGridConnectivity.h.

Constructor & Destructor Documentation

vtkStructuredGridConnectivity::vtkStructuredGridConnectivity ( )

protected

vtkStructuredGridConnectivity::~vtkStructuredGridConnectivity ( )

overrideprotected

Member Function Documentation

static vtkStructuredGridConnectivity* vtkStructuredGridConnectivity::New ( )

static

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

static

virtual vtkTypeBool vtkStructuredGridConnectivity::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 vtkAbstractGridConnectivity.

Reimplemented in vtkPStructuredGridConnectivity.

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

static

virtual vtkObjectBase* vtkStructuredGridConnectivity::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractGridConnectivity.

Reimplemented in vtkPStructuredGridConnectivity.

vtkStructuredGridConnectivity* vtkStructuredGridConnectivity::NewInstance ( ) const

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

Reimplemented in vtkPStructuredGridConnectivity.

virtual void vtkStructuredGridConnectivity::SetWholeExtent	(	int	,
		int	,
		int	,
		int	,
		int	,
		int
	)

virtual