VTK
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 =========================================================================*/
29#ifndef vtkStructuredAMRNeighbor_h
30#define vtkStructuredAMRNeighbor_h
31
32#include "vtkFiltersGeometryModule.h" // For export macro
34
35class VTKFILTERSGEOMETRY_EXPORT vtkStructuredAMRNeighbor :
37{
38public:
39
40 // An enum that defines the neighbor relationship between the 2 grids.
42 {
43 PARENT, // Neighbor fully contains this grid
44 PARTIALLY_OVERLAPPING_PARENT, // Neighbor partially contains this grid
45 CHILD, // This grid fully contains the neighbor
46 PARTIALLY_OVERLAPPING_CHILD, // This grid partially contains the neighbor
47 SAME_LEVEL_SIBLING, // Grids are adjacent at the same level
48 COARSE_TO_FINE_SIBLING, // Grid is adjacent with a finer neighbor
49 FINE_TO_COARSE_SIBLING, // Grid is adjacent with a coarser neighbor
50 UNDEFINED
51 };
52
53 // NOTE: The OverlapExtent stores the overlap w.r.t. the neighboring grid
54 // Consequently, GridOverlapExtent stores the overlap extent w.r.t. this grid.
55 int GridOverlapExtent[6]; // The overlap extent w.r.t. this grid
56 int GridLevel; // The level of the grid that has this neighbor
57 int NeighborLevel; // The level of the neighboring grid
58 int RelationShip; // The relationship of the grid with this neighbor
59
64
72 const int gridLevel,
73 const int neiID, const int neighborLevel,
74 int gridOverlap[6], int neiOverlap[6],
75 int orient[3],
76 const int relationShip);
77
82 vtkStructuredNeighbor(N) { *this = N; }
83
87 ~vtkStructuredAMRNeighbor() VTK_OVERRIDE {}
88
93
98 void GetReceiveExtentOnGrid(const int ng,int gridExtent[6],int ext[6]);
99
104
106
113 int gridRealExtent[6], int gridGhostedExtent[6], int neiRealExtent[6],
114 int WholeExtent[6], const int N) VTK_OVERRIDE;
115};
117
118#endif /* vtkStructuredAMRNeighbor_h */
119// 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 (usefule 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:490