VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
vtkStructuredAMRNeighbor.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkStructuredAMRNeighbor.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14  =========================================================================*/
28 #ifndef VTKSTRUCTUREDAMRNEIGHBOR_H_
29 #define VTKSTRUCTUREDAMRNEIGHBOR_H_
30 
31 #include "vtkFiltersGeometryModule.h" // For export macro
32 #include "vtkStructuredNeighbor.h"
33 
34 class VTKFILTERSGEOMETRY_EXPORT vtkStructuredAMRNeighbor :
36 {
37 public:
38 
39  // An enum that defines the neighbor relationship between the 2 grids.
41  {
42  PARENT, // Neighbor fully contains this grid
43  PARTIALLY_OVERLAPPING_PARENT, // Neighbor partially contains this grid
44  CHILD, // This grid fully contains the neighbor
45  PARTIALLY_OVERLAPPING_CHILD, // This grid partially contains the neighbor
46  SAME_LEVEL_SIBLING, // Grids are adjacent at the same level
47  COARSE_TO_FINE_SIBLING, // Grid is adjacent with a finer neighbor
48  FINE_TO_COARSE_SIBLING, // Grid is adjacent with a coarser neighbor
49  UNDEFINED
50  };
51 
52  // NOTE: The OverlapExtent stores the overlap w.r.t. the neighboring grid
53  // Consequently, GridOverlapExtent stores the overlap extent w.r.t. this grid.
54  int GridOverlapExtent[6]; // The overlap extent w.r.t. this grid
55  int GridLevel; // The level of the grid that has this neighbor
56  int NeighborLevel; // The level of the neighboring grid
57  int RelationShip; // The relationship of the grid with this neighbor
58 
61 
63 
68  const int gridLevel,
69  const int neiID, const int neighborLevel,
70  int gridOverlap[6], int neiOverlap[6],
71  int orient[3],
72  const int relationShip);
74 
76  virtual ~vtkStructuredAMRNeighbor();
77 
80 
83  void GetReceiveExtentOnGrid(const int ng,int gridExtent[6],int ext[6]);
84 
87  std::string GetRelationShipString();
88 
90 
94  virtual void ComputeSendAndReceiveExtent(
95  int gridRealExtent[6], int gridGhostedExtent[6], int neiRealExtent[6],
96  int WholeExtent[6], const int N);
97 };
99 
100 #endif /* VTKSTRUCTUREDAMRNEIGHBOR_H_ */
101 // VTK-HeaderTest-Exclude: vtkStructuredAMRNeighbor.h
vtkStructuredNeighbor & operator=(const vtkStructuredNeighbor &N)
virtual void ComputeSendAndReceiveExtent(int gridRealExtent[6], int gridGhostedExtent[6], int neiRealExtent[6], int WholeExtent[6], const int N)