#include <vtkStructuredAMRNeighbor.h>

Inheritance diagram for vtkStructuredAMRNeighbor:

Collaboration diagram for vtkStructuredAMRNeighbor:

Public Types
enum	NeighborRelationship { PARENT, PARTIALLY_OVERLAPPING_PARENT, CHILD, PARTIALLY_OVERLAPPING_CHILD, SAME_LEVEL_SIBLING, COARSE_TO_FINE_SIBLING, FINE_TO_COARSE_SIBLING, UNDEFINED }
Public Member Functions
	vtkStructuredAMRNeighbor ()
virtual	~vtkStructuredAMRNeighbor ()
vtkStructuredAMRNeighbor &	operator= (const vtkStructuredAMRNeighbor &N)
void	GetReceiveExtentOnGrid (const int ng, int gridExtent[6], int ext[6])
std::string	GetRelationShipString ()

	vtkStructuredAMRNeighbor (const int gridLevel, const int neiID, const int neighborLevel, int gridOverlap[6], int neiOverlap[6], int orient[3], const int relationShip)

virtual void	ComputeSendAndReceiveExtent (int gridRealExtent[6], int gridGhostedExtent[6], int neiRealExtent[6], int WholeExtent[6], const int N)
Public Attributes
int	GridOverlapExtent [6]
int	GridLevel
int	NeighborLevel
int	RelationShip

Detailed Description

An internal, light-weight object used to store neighbor information for AMR grids.

See also:: vtkStructuredNeighbor vtkStructuredAMRGridConnectivity

Tests:: vtkStructuredAMRNeighbor (Tests)

Definition at line 34 of file vtkStructuredAMRNeighbor.h.

Member Enumeration Documentation

enum vtkStructuredAMRNeighbor::NeighborRelationship

Enumerator:

PARENT
PARTIALLY_OVERLAPPING_PARENT
CHILD
PARTIALLY_OVERLAPPING_CHILD
SAME_LEVEL_SIBLING
COARSE_TO_FINE_SIBLING
FINE_TO_COARSE_SIBLING
UNDEFINED

Definition at line 40 of file vtkStructuredAMRNeighbor.h.

Constructor & Destructor Documentation

vtkStructuredAMRNeighbor::vtkStructuredAMRNeighbor ( )

Default constructor.

vtkStructuredAMRNeighbor::vtkStructuredAMRNeighbor	(	const int	gridLevel,
		const int	neiID,
		const int	neighborLevel,
		int	gridOverlap[6],
		int	neiOverlap[6],
		int	orient[3],
		const int	relationShip
	)

Custom constructor. Creates an AMR neighbor for a grid (block) at level GridLevel with the neighboring block at NeiID, NeighborLevel. The two neighbors overlap at the pre-computed overlap extent which is given w.r.t to the current grid (i.e., not the neighboring grid).

virtual vtkStructuredAMRNeighbor::~vtkStructuredAMRNeighbor ( ) [virtual]

Destructor.

Member Function Documentation

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

Overload assignment operator.

void vtkStructuredAMRNeighbor::GetReceiveExtentOnGrid	(	const int	ng,
		int	gridExtent[6],
		int	ext[6]
	)

Returns the receive extent w.r.t. the grid's level, i.e., not the neighbor's level.

std::string vtkStructuredAMRNeighbor::GetRelationShipString ( )

Returns the neighbor relationship as a string (usefule for debugging).

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

Computes the SendExtent and 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 from vtkStructuredNeighbor.