vtkStructuredNeighbor Class Reference

#include <vtkStructuredNeighbor.h>

Inheritance diagram for vtkStructuredNeighbor:

Public Types
enum	NeighborOrientation {   SUBSET_LO = -2, LO = -1, ONE_TO_ONE = 0, HI = 1,   SUBSET_HI = 2, SUBSET_BOTH = 3, SUPERSET = 4, UNDEFINED = 5 }

Public Member Functions
	vtkStructuredNeighbor ()
	vtkStructuredNeighbor (const int NeiID, int overlap[6])
	vtkStructuredNeighbor (const int NeiID, int overlap[6], int orient[3])
	vtkStructuredNeighbor (const vtkStructuredNeighbor &N)
virtual	~vtkStructuredNeighbor ()
vtkStructuredNeighbor &	operator= (const vtkStructuredNeighbor &N)
virtual void	ComputeSendAndReceiveExtent (int gridRealExtent[6], int gridGhostedExtent[6], int neiRealExtent[6], int WholeExtent[6], const int N)

Public Attributes
int	NeighborID
int	OverlapExtent [6]
int	SendExtent [6]
int	RcvExtent [6]
int	Orientation [3]

Detailed Description

An internal, light-weight class used to store neighbor information.

Tests:

vtkStructuredNeighbor (Tests)

Definition at line 30 of file vtkStructuredNeighbor.h.

Member Enumeration Documentation

enum vtkStructuredNeighbor::NeighborOrientation

Enumerator
SUBSET_LO
LO
ONE_TO_ONE
HI
SUBSET_HI
SUBSET_BOTH
SUPERSET
UNDEFINED

Definition at line 38 of file vtkStructuredNeighbor.h.

Constructor & Destructor Documentation

vtkStructuredNeighbor::vtkStructuredNeighbor

(

)

Default Constructor

vtkStructuredNeighbor::vtkStructuredNeighbor	(	const int	NeiID,
		int	overlap[6]
	)

Custom constructor. Constructs a neighbor with the prescribed neighbor grid/block ID and overlap.

vtkStructuredNeighbor::vtkStructuredNeighbor	(	const int	NeiID,
		int	overlap[6],
		int	orient[3]
	)

Custom constructor. Constructs a neighbor with the prescribed neigbhor grid/block ID, overlap extent, and orientation

vtkStructuredNeighbor::vtkStructuredNeighbor ( const vtkStructuredNeighbor &  N )

inline

Copy constructor

Definition at line 82 of file vtkStructuredNeighbor.h.

virtual vtkStructuredNeighbor::~vtkStructuredNeighbor ( )

virtual

Default destructor

Member Function Documentation

vtkStructuredNeighbor& vtkStructuredNeighbor::operator= ( const vtkStructuredNeighbor &  N )

inline

Overload assignment operator

Definition at line 90 of file vtkStructuredNeighbor.h.

virtual void vtkStructuredNeighbor::ComputeSendAndReceiveExtent ( int  gridRealExtent[6], int  gridGhostedExtent[6], int  neiRealExtent[6], int  WholeExtent[6], const int  N  )

virtual

Computes the SendExtent and the RcvExtent for this neighbor. The method assumes that the overlap extent and orientation are already computed. Using this information, the method grows the overlap extent to form the Send and Rcv Extents for this neighbor instance.

Reimplemented in vtkStructuredAMRNeighbor.

Member Data Documentation

int vtkStructuredNeighbor::NeighborID

Definition at line 63 of file vtkStructuredNeighbor.h.

int vtkStructuredNeighbor::OverlapExtent[6]

Definition at line 64 of file vtkStructuredNeighbor.h.

int vtkStructuredNeighbor::SendExtent[6]

Definition at line 65 of file vtkStructuredNeighbor.h.

int vtkStructuredNeighbor::RcvExtent[6]

Definition at line 66 of file vtkStructuredNeighbor.h.

int vtkStructuredNeighbor::Orientation[3]

Definition at line 67 of file vtkStructuredNeighbor.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/vtkStructuredNeighbor.h