VTK  9.2.6
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  =========================================================================*/
27 #ifndef vtkStructuredAMRNeighbor_h
28 #define vtkStructuredAMRNeighbor_h
29 
30 #include "vtkFiltersGeometryModule.h" // For export macro
31 #include "vtkStructuredNeighbor.h"
32 
33 class VTKFILTERSGEOMETRY_EXPORT vtkStructuredAMRNeighbor : public vtkStructuredNeighbor
34 {
35 public:
36  // An enum that defines the neighbor relationship between the 2 grids.
38  {
39  PARENT, // Neighbor fully contains this grid
40  PARTIALLY_OVERLAPPING_PARENT, // Neighbor partially contains this grid
41  CHILD, // This grid fully contains the neighbor
42  PARTIALLY_OVERLAPPING_CHILD, // This grid partially contains the neighbor
43  SAME_LEVEL_SIBLING, // Grids are adjacent at the same level
44  COARSE_TO_FINE_SIBLING, // Grid is adjacent with a finer neighbor
45  FINE_TO_COARSE_SIBLING, // Grid is adjacent with a coarser neighbor
46  UNDEFINED
47  };
48 
49  // NOTE: The OverlapExtent stores the overlap w.r.t. the neighboring grid
50  // Consequently, GridOverlapExtent stores the overlap extent w.r.t. this grid.
51  int GridOverlapExtent[6]; // The overlap extent w.r.t. this grid
52  int GridLevel; // The level of the grid that has this neighbor
53  int NeighborLevel; // The level of the neighboring grid
54  int RelationShip; // The relationship of the grid with this neighbor
55 
60 
67  vtkStructuredAMRNeighbor(const int gridLevel, const int neiID, const int neighborLevel,
68  int gridOverlap[6], int neiOverlap[6], int orient[3], const int relationShip);
69 
75  {
76  *this = N;
77  }
78 
82  ~vtkStructuredAMRNeighbor() override = default;
83 
88 
93  void GetReceiveExtentOnGrid(const int ng, int gridExtent[6], int ext[6]);
94 
98  std::string GetRelationShipString();
99 
101 
107  void ComputeSendAndReceiveExtent(int gridRealExtent[6], int gridGhostedExtent[6],
108  int neiRealExtent[6], int WholeExtent[6], const int N) override;
110 };
111 
112 #endif /* vtkStructuredAMRNeighbor_h */
113 // VTK-HeaderTest-Exclude: vtkStructuredAMRNeighbor.h
vtkStructuredAMRNeighbor(const vtkStructuredAMRNeighbor &N)
Copy constructor.
vtkStructuredNeighbor & operator=(const vtkStructuredNeighbor &N)
Overload assignment operator.
An internal, light-weight class used to store neighbor information.
An internal, light-weight object used to store neighbor information for AMR grids.
virtual void ComputeSendAndReceiveExtent(int gridRealExtent[6], int gridGhostedExtent[6], int neiRealExtent[6], int WholeExtent[6], const int N)
Computes the SendExtent and the RcvExtent for this neighbor.