You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
113 lines
3.8 KiB
C++
113 lines
3.8 KiB
C++
/*=========================================================================
|
|
|
|
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.
|
|
|
|
=========================================================================*/
|
|
/**
|
|
* @class vtkStructuredAMRNeighbor
|
|
*
|
|
*
|
|
* An internal, light-weight object used to store neighbor information for
|
|
* AMR grids.
|
|
*
|
|
* @sa
|
|
* vtkStructuredNeighbor vtkStructuredAMRGridConnectivity
|
|
*/
|
|
|
|
#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
|
|
|
|
/**
|
|
* Default constructor.
|
|
*/
|
|
vtkStructuredAMRNeighbor();
|
|
|
|
/**
|
|
* Custom constructor. Creates an AMR neighbor for a grid (block) at level
|
|
* GridLevel with the neighboring block at NeiID, NeighborLevel. The two
|
|
* neighbors overlap at the pre-computed overlap extent which is given w.r.t
|
|
* to the current grid (i.e., not the neighboring grid).
|
|
*/
|
|
vtkStructuredAMRNeighbor(const int gridLevel, const int neiID, const int neighborLevel,
|
|
int gridOverlap[6], int neiOverlap[6], int orient[3], const int relationShip);
|
|
|
|
/**
|
|
* Copy constructor.
|
|
*/
|
|
vtkStructuredAMRNeighbor(const vtkStructuredAMRNeighbor& N)
|
|
: vtkStructuredNeighbor(N)
|
|
{
|
|
*this = N;
|
|
}
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
~vtkStructuredAMRNeighbor() override {}
|
|
|
|
/**
|
|
* Overload assignment operator.
|
|
*/
|
|
vtkStructuredAMRNeighbor& operator=(const vtkStructuredAMRNeighbor& N);
|
|
|
|
/**
|
|
* Returns the receive extent w.r.t. the grid's level, i.e., not the
|
|
* neighbor's level.
|
|
*/
|
|
void GetReceiveExtentOnGrid(const int ng, int gridExtent[6], int ext[6]);
|
|
|
|
/**
|
|
* Returns the neighbor relationship as a string (useful for debugging).
|
|
*/
|
|
std::string GetRelationShipString();
|
|
|
|
//@{
|
|
/**
|
|
* Computes the SendExtent and RcvExtent for this neighbor. The method assumes
|
|
* that the overlap extent and orientation are already computed. Using this
|
|
* information, the method grows the overlap extent to form the Send and Rcv
|
|
* extents for this neighbor instance.
|
|
*/
|
|
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
|