vtkStructuredAMRNeighbor.h

Go to the documentation of this file.

/*=========================================================================
 
 Program:   Visualization Toolkit
 Module:    vtkStructuredAMRNeighbor.h
 
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 All rights reserved.
 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
 This software is distributed WITHOUT ANY WARRANTY; without even
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notice for more information.
 
 =========================================================================*/
#ifndef vtkStructuredAMRNeighbor_h
#define vtkStructuredAMRNeighbor_h
 
#include "vtkFiltersGeometryModule.h" // For export macro
#include "vtkStructuredNeighbor.h"
 
class VTKFILTERSGEOMETRY_EXPORT vtkStructuredAMRNeighbor : public vtkStructuredNeighbor
{
public:
  // An enum that defines the neighbor relationship between the 2 grids.
  enum NeighborRelationship
  {
    PARENT,                       // Neighbor fully contains this grid
    PARTIALLY_OVERLAPPING_PARENT, // Neighbor partially contains this grid
    CHILD,                        // This grid fully contains the neighbor
    PARTIALLY_OVERLAPPING_CHILD,  // This grid partially contains the neighbor
    SAME_LEVEL_SIBLING,           // Grids are adjacent at the same level
    COARSE_TO_FINE_SIBLING,       // Grid is adjacent with a finer neighbor
    FINE_TO_COARSE_SIBLING,       // Grid is adjacent with a coarser neighbor
    UNDEFINED
  };
 
  // NOTE: The OverlapExtent stores the overlap w.r.t. the neighboring grid
  // Consequently, GridOverlapExtent stores the overlap extent w.r.t. this grid.
  int GridOverlapExtent[6]; // The overlap extent w.r.t. this grid
  int GridLevel;            // The level of the grid that has this neighbor
  int NeighborLevel;        // The level of the neighboring grid
  int RelationShip;         // The relationship of the grid with this neighbor
 
  vtkStructuredAMRNeighbor();
 
  vtkStructuredAMRNeighbor(const int gridLevel, const int neiID, const int neighborLevel,
    int gridOverlap[6], int neiOverlap[6], int orient[3], const int relationShip);
 
  vtkStructuredAMRNeighbor(const vtkStructuredAMRNeighbor& N)
    : vtkStructuredNeighbor(N)
  {
    *this = N;
  }
 
  ~vtkStructuredAMRNeighbor() override = default;
 
  vtkStructuredAMRNeighbor& operator=(const vtkStructuredAMRNeighbor& N);
 
  void GetReceiveExtentOnGrid(const int ng, int gridExtent[6], int ext[6]);
 
  std::string GetRelationShipString();
 
 
  void ComputeSendAndReceiveExtent(int gridRealExtent[6], int gridGhostedExtent[6],
    int neiRealExtent[6], int WholeExtent[6], const int N) override;
};
 
#endif /* vtkStructuredAMRNeighbor_h */
// VTK-HeaderTest-Exclude: vtkStructuredAMRNeighbor.h