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