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

#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 ()
	Default Constructor.

	vtkStructuredNeighbor (int NeiID, int overlap[6])
	Custom constructor.

	vtkStructuredNeighbor (int NeiID, int overlap[6], int orient[3])
	Custom constructor.

	vtkStructuredNeighbor (const vtkStructuredNeighbor &N)
	Copy constructor.

virtual	~vtkStructuredNeighbor ()
	Default destructor.


vtkStructuredNeighbor &	operator= (const vtkStructuredNeighbor &N)
	Overload assignment operator.


virtual void	ComputeSendAndReceiveExtent (int gridRealExtent[6], int gridGhostedExtent[6], int neiRealExtent[6], int WholeExtent[6], int N)
	Computes the SendExtent and the RcvExtent for this neighbor.

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 18 of file vtkStructuredNeighbor.h.

Member Enumeration Documentation

◆ NeighborOrientation

enum vtkStructuredNeighbor::NeighborOrientation

Enumerator
SUBSET_LO
LO
ONE_TO_ONE
HI
SUBSET_HI
SUBSET_BOTH
SUPERSET
UNDEFINED

Definition at line 25 of file vtkStructuredNeighbor.h.

Constructor & Destructor Documentation

◆ vtkStructuredNeighbor() [1/4]

vtkStructuredNeighbor::vtkStructuredNeighbor ( )

Default Constructor.

◆ vtkStructuredNeighbor() [2/4]

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

Custom constructor.

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

◆ vtkStructuredNeighbor() [3/4]

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

Custom constructor.

Constructs a neighbor with the prescribed neighbor grid/block ID, overlap extent, and orientation

◆ vtkStructuredNeighbor() [4/4]

vtkStructuredNeighbor::vtkStructuredNeighbor ( const vtkStructuredNeighbor & N )

inline

Copy constructor.

Definition at line 77 of file vtkStructuredNeighbor.h.

◆ ~vtkStructuredNeighbor()

virtual vtkStructuredNeighbor::~vtkStructuredNeighbor ( )

virtual

Default destructor.

Member Function Documentation

◆ operator=()

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

inline

Overload assignment operator.

Definition at line 88 of file vtkStructuredNeighbor.h.

◆ ComputeSendAndReceiveExtent()

virtual void vtkStructuredNeighbor::ComputeSendAndReceiveExtent	(	int	gridRealExtent[6],
		int	gridGhostedExtent[6],
		int	neiRealExtent[6],
		int	WholeExtent[6],
		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

◆ NeighborID

int vtkStructuredNeighbor::NeighborID

Definition at line 50 of file vtkStructuredNeighbor.h.

◆ OverlapExtent

int vtkStructuredNeighbor::OverlapExtent[6]

Definition at line 51 of file vtkStructuredNeighbor.h.

◆ SendExtent

int vtkStructuredNeighbor::SendExtent[6]

Definition at line 52 of file vtkStructuredNeighbor.h.

◆ RcvExtent

int vtkStructuredNeighbor::RcvExtent[6]

Definition at line 53 of file vtkStructuredNeighbor.h.

◆ Orientation

int vtkStructuredNeighbor::Orientation[3]

Definition at line 54 of file vtkStructuredNeighbor.h.

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

Filters/Geometry/vtkStructuredNeighbor.h

Public Types

Public Member Functions

Public Attributes