vtkStructuredAMRGridConnectivity.h

Go to the documentation of this file.

/*=========================================================================
 
 Program:   Visualization Toolkit
 Module:    vtkStructuredAMRGridConnectivity.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 vtkStructuredAMRGridConnectivity_h
#define vtkStructuredAMRGridConnectivity_h
 
#include "vtkAbstractGridConnectivity.h"
#include "vtkFiltersGeometryModule.h" // For export macro
 
#include "vtkStructuredAMRNeighbor.h" // For vtkStructuredAMRNeighbor def.
 
// C++ includes
#include <map>     // For STL map
#include <ostream> // For STL stream
#include <set>     // For STL set
#include <vector>  // For STL vector
 
class VTKFILTERSGEOMETRY_EXPORT vtkStructuredAMRGridConnectivity
  : public vtkAbstractGridConnectivity
{
public:
  static vtkStructuredAMRGridConnectivity* New();
  vtkTypeMacro(vtkStructuredAMRGridConnectivity, vtkAbstractGridConnectivity);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void Initialize(
    const unsigned int NumberOfLevels, const unsigned int N, const int RefinementRatio = -1);
 
  void ComputeNeighbors() override;
 
  void CreateGhostLayers(const int N = 1) override;
 
  virtual void RegisterGrid(const int gridIdx, const int level, const int refinementRatio,
    int extents[6], vtkUnsignedCharArray* nodesGhostArray, vtkUnsignedCharArray* cellGhostArray,
    vtkPointData* pointData, vtkCellData* cellData, vtkPoints* gridNodes);
 
  virtual void RegisterGrid(const int gridIdx, const int level, int extents[6],
    vtkUnsignedCharArray* nodesGhostArray, vtkUnsignedCharArray* cellGhostArray,
    vtkPointData* pointData, vtkCellData* cellData, vtkPoints* gridNodes);
 
 
  vtkSetMacro(BalancedRefinement, bool);
  vtkGetMacro(BalancedRefinement, bool);
 
 
  vtkSetMacro(NodeCentered, bool);
  vtkGetMacro(NodeCentered, bool);
 
 
  vtkSetMacro(CellCentered, bool);
  vtkGetMacro(CellCentered, bool);
 
  int GetNumberOfNeighbors(const int gridID);
 
  void GetGhostedExtent(const int gridID, int ext[6]);
 
  vtkStructuredAMRNeighbor GetNeighbor(const int gridID, const int nei);
 
protected:
  vtkStructuredAMRGridConnectivity();
  ~vtkStructuredAMRGridConnectivity() override;
 
  void SetNumberOfGrids(const unsigned int N) override;
 
  void CreateGhostedMaskArrays(const int gridID);
 
  void CreateGhostedExtent(const int gridID, const int N);
 
  void SetGhostedExtent(const int gridID, int ext[6]);
 
  void GetCoarsenedExtent(const int gridIdx, int fromLevel, int toLevel, int ext[6]);
 
  void GetRefinedExtent(const int gridIdx, int fromLevel, int toLevel, int ext[6]);
 
  void RefineExtent(int orient[3], int ndim, int fromLevel, int toLevel, int ext[6]);
 
  void GetCellRefinedExtent(int orient[3], int ndim, const int i, const int j, const int k,
    const int fromLevel, const int toLevel, int ext[6]);
 
  void CoarsenExtent(int orient[3], int ndim, int fromLevel, int toLevel, int ext[6]);
 
  void GetGridExtent(const int gridIdx, int ext[6]);
 
  int GetGridLevel(const int gridIdx);
 
  bool LevelExists(const int level);
 
  bool IsNodeInterior(const int i, const int j, const int k, int ext[6]);
 
  bool IsNodeWithinExtent(const int i, const int j, const int k, int ext[6]);
 
  bool IsNodeOnSharedBoundary(
    const int i, const int j, const int k, const int gridId, int gridExt[6]);
 
  bool IsNodeOnBoundaryOfExtent(const int i, const int j, const int k, int ext[6]);
 
  void InsertGridAtLevel(const int level, const int gridID);
 
  void ComputeNeighborSendAndRcvExtent(const int gridID, const int N);
 
  void ComputeWholeExtent();
 
  void GetWholeExtentAtLevel(const int level, int ext[6]);
 
  void EstablishNeighbors(const int i, const int j);
 
  void GetNodeOrientation(
    const int i, const int j, const int k, int gridExt[6], int nodeOrientation[3]);
 
  void GetOrientationVector(const int dataDescription, int orient[3], int& ndim);
 
  bool HasConstantRefinementRatio();
 
  void SetRefinementRatioAtLevel(const int level, const int r);
 
  int GetRefinementRatioAtLevel(const int level);
 
  bool AreExtentsEqual(int ext1[6], int ext2[6]);
 
  void SetBlockTopology(const int gridID);
 
  int GetNumberOfConnectingBlockFaces(const int gridID);
 
 
  bool HasBlockConnection(const int gridID, const int blockDirection)
  {
    // Sanity check
    assert("pre: gridID is out-of-bounds" && (gridID >= 0) &&
      (gridID < static_cast<int>(this->NumberOfGrids)));
    assert("pre: BlockTopology has not been properly allocated" &&
      (this->NumberOfGrids == this->BlockTopology.size()));
    assert("pre: blockDirection is out-of-bounds" && (blockDirection >= 0) && (blockDirection < 6));
    bool status = false;
    if (this->BlockTopology[gridID] & (1 << blockDirection))
    {
      status = true;
    }
    return (status);
  }
 
  void RemoveBlockConnection(const int gridID, const int blockDirection);
 
  void AddBlockConnection(const int gridID, const int blockDirection);
 
  void ClearBlockConnections(const int gridID);
 
  virtual void MarkNodeProperty(const int gridId, const int i, const int j, const int k,
    int gridExt[6], int wholeExt[6], unsigned char& p);
 
  virtual void FillNodesGhostArray(const int gridId, vtkUnsignedCharArray* nodesArray);
 
  virtual void FillCellsGhostArray(const int gridId, vtkUnsignedCharArray* cellArray);
 
  void FillGhostArrays(
    const int gridId, vtkUnsignedCharArray* nodesArray, vtkUnsignedCharArray* cellsArray) override;
 
  vtkStructuredAMRNeighbor GetAMRNeighbor(const int i, const int iLevel, int next1[6], const int j,
    const int jLevel, int next2[6], const int normalizedLevel, const int levelDiff,
    vtkStructuredNeighbor& nei);
 
  void ComputeAMRNeighborOverlapExtents(const int iLevel, const int jLevel,
    const int normalizedLevel, const vtkStructuredNeighbor& nei, int orient[3], int ndim,
    int gridOverlapExtent[6], int neiOverlapExtent[6]);
 
  int Get1DOrientation(const int idx, const int ExtentLo, const int ExtentHi, const int OnLo,
    const int OnHi, const int NotOnBoundary);
 
  void PrintExtent(std::ostream& os, int ext[6]);
 
  void InitializeGhostData(const int gridID);
 
  void TransferRegisteredDataToGhostedData(const int gridID);
 
  void TransferLocalNodeCenteredNeighborData(const int gridID, vtkStructuredAMRNeighbor& nei);
 
  void GetLocalCellCentersFromCoarserLevel(const int gridID, vtkStructuredAMRNeighbor& nei);
 
  void GetLocalCellCentersFromFinerLevel(const int gridID, vtkStructuredAMRNeighbor& nei);
 
  void GetLocalCellCentersAtSameLevel(const int gridID, vtkStructuredAMRNeighbor& nei);
 
  void TransferLocalCellCenteredNeighborData(const int gridID, vtkStructuredAMRNeighbor& nei);
 
  void TransferLocalNeighborData(const int gridID, vtkStructuredAMRNeighbor& nei);
 
  virtual void TransferGhostDataFromNeighbors(const int gridID);
 
  void AverageFieldData(vtkFieldData* source, vtkIdType* sourceIds, const int N,
    vtkFieldData* target, vtkIdType targetIdx);
 
  void CopyFieldData(
    vtkFieldData* source, vtkIdType sourceIdx, vtkFieldData* target, vtkIdType targetIdx);
 
  unsigned int NumberOfLevels; // The total number of levels;
  int DataDimension;           // The dimension of the data, i.e. 2 or 3
  int DataDescription;         // The data description, i.e., VTK_XY_PLANE, etc.
  int WholeExtent[6];          // The whole extent w.r.t. to the root level, level 0.
  int MaxLevel;                // The max level of the AMR hierarchy
  int RefinementRatio;         // The refinement ratio, set in the initialization,iff,
                               // a constant refinement ratio is used. A value of -1
                               // indicates that the refinement ratio is not constant
                               // and the RefinementRatios vector is used instead.
 
  bool NodeCentered; // Indicates if the data is node-centered
  bool CellCentered; // Indicates if the data is cell-centered
 
  bool BalancedRefinement; // If Balanced refinement is true, then adjacent
                           // grids in the hierarchy can only differ by one
                           // level.
 
  // AMRHierarchy stores the set of grid Ids in [0,N] for each level
  std::map<int, std::set<int> > AMRHierarchy;
 
  // For each grid, [0,N] store the grid extents,level, and list of neighbors
  std::vector<int> GridExtents;             // size of this vector is 6*N
  std::vector<int> GhostedExtents;          // size of this vector is 6*N
  std::vector<unsigned char> BlockTopology; // size of this vector is N
  std::vector<int> GridLevels;              // size of this vector is N
  std::vector<std::vector<vtkStructuredAMRNeighbor> > Neighbors;
 
  // For each grid, [0,N], store the donor level,grid and cell information, a
  // DonorLevel of -1 indicates that the cell is not receiving any information
  // from a donor.
  std::vector<std::vector<int> > CellCenteredDonorLevel;
 
  // RefinementRatios stores the refinement ratio at each level, this vector
  // is used only when the refinement ratio varies across levels
  std::vector<int> RefinementRatios;
 
private:
  vtkStructuredAMRGridConnectivity(const vtkStructuredAMRGridConnectivity&) = delete;
  void operator=(const vtkStructuredAMRGridConnectivity&) = delete;
};
 
//=============================================================================
//  INLINE METHODS
//=============================================================================
 
//------------------------------------------------------------------------------
inline int vtkStructuredAMRGridConnectivity::GetNumberOfNeighbors(const int gridID)
{
  assert("pre: grid ID is out-of-bounds" && (gridID >= 0) &&
    (gridID < static_cast<int>(this->NumberOfGrids)));
  assert("pre: neighbors vector has not been properly allocated" &&
    (this->Neighbors.size() == this->NumberOfGrids));
  return (static_cast<int>(this->Neighbors[gridID].size()));
}
 
//------------------------------------------------------------------------------
inline vtkStructuredAMRNeighbor vtkStructuredAMRGridConnectivity::GetNeighbor(
  const int gridID, const int nei)
{
  assert("pre: grid ID is out-of-bounds" && (gridID >= 0) &&
    (gridID < static_cast<int>(this->NumberOfGrids)));
  assert("pre: neighbors vector has not been properly allocated" &&
    (this->Neighbors.size() == this->NumberOfGrids));
  assert("pre: nei index is out-of-bounds" && (nei >= 0) &&
    (nei < static_cast<int>(this->Neighbors[gridID].size())));
  return (this->Neighbors[gridID][nei]);
}
 
//------------------------------------------------------------------------------
inline int vtkStructuredAMRGridConnectivity::Get1DOrientation(const int idx, const int ExtentLo,
  const int ExtentHi, const int OnLo, const int OnHi, const int NotOnBoundary)
{
  if (idx == ExtentLo)
  {
    return OnLo;
  }
  else if (idx == ExtentHi)
  {
    return OnHi;
  }
  return NotOnBoundary;
}
 
//------------------------------------------------------------------------------
inline int vtkStructuredAMRGridConnectivity::GetNumberOfConnectingBlockFaces(const int gridID)
{
  // Sanity check
  assert("pre: gridID is out-of-bounds" && (gridID >= 0) &&
    (gridID < static_cast<int>(this->NumberOfGrids)));
  assert("pre: BlockTopology has not been properly allocated" &&
    (this->NumberOfGrids == this->BlockTopology.size()));
 
  int count = 0;
  for (int i = 0; i < 6; ++i)
  {
    if (this->HasBlockConnection(gridID, i))
    {
      ++count;
    }
  }
  assert("post: count must be in [0,5]" && (count >= 0 && count <= 6));
  return (count);
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredAMRGridConnectivity::RemoveBlockConnection(
  const int gridID, const int blockDirection)
{
  // Sanity check
  assert("pre: gridID is out-of-bounds" && (gridID >= 0) &&
    (gridID < static_cast<int>(this->NumberOfGrids)));
  assert("pre: BlockTopology has not been properly allocated" &&
    (this->NumberOfGrids == this->BlockTopology.size()));
  assert("pre: blockDirection is out-of-bounds" && (blockDirection >= 0) && (blockDirection < 6));
 
  this->BlockTopology[gridID] &= ~(1 << blockDirection);
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredAMRGridConnectivity::AddBlockConnection(
  const int gridID, const int blockDirection)
{
  // Sanity check
  assert("pre: gridID is out-of-bounds" && (gridID >= 0) &&
    (gridID < static_cast<int>(this->NumberOfGrids)));
  assert("pre: BlockTopology has not been properly allocated" &&
    (this->NumberOfGrids == this->BlockTopology.size()));
  assert("pre: blockDirection is out-of-bounds" && (blockDirection >= 0) && (blockDirection < 6));
  this->BlockTopology[gridID] |= (1 << blockDirection);
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredAMRGridConnectivity::ClearBlockConnections(const int gridID)
{
  // Sanity check
  assert("pre: gridID is out-of-bounds" && (gridID >= 0) &&
    (gridID < static_cast<int>(this->NumberOfGrids)));
  assert("pre: BlockTopology has not been properly allocated" &&
    (this->NumberOfGrids == this->BlockTopology.size()));
  for (int i = 0; i < 6; ++i)
  {
    this->RemoveBlockConnection(gridID, i);
  } // END for all block directions
}
 
//------------------------------------------------------------------------------
inline bool vtkStructuredAMRGridConnectivity::AreExtentsEqual(int ext1[6], int ext2[6])
{
  for (int i = 0; i < 6; ++i)
  {
    if (ext1[i] != ext2[i])
    {
      return false;
    }
  } // END for
  return true;
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredAMRGridConnectivity::PrintExtent(std::ostream& os, int ext[6])
{
  for (int i = 0; i < 6; i += 2)
  {
    os << "[";
    os << ext[i] << " ";
    os << ext[i + 1] << "] ";
  } // END for
}
 
//------------------------------------------------------------------------------
inline int vtkStructuredAMRGridConnectivity::GetGridLevel(const int gridIdx)
{
  assert("pre: grid Index is out-of-bounds!" && (gridIdx < static_cast<int>(this->NumberOfGrids)));
  assert("pre: grid levels vector has not been allocated" &&
    (this->GridLevels.size() == this->NumberOfGrids));
  return (this->GridLevels[gridIdx]);
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredAMRGridConnectivity::SetRefinementRatioAtLevel(
  const int level, const int r)
{
  assert("pre: RefinementRatios vector is not properly allocated" &&
    this->RefinementRatios.size() == this->NumberOfLevels);
  assert("pre: leve is out-of-bounds!" && (level >= 0) &&
    (level < static_cast<int>(this->RefinementRatios.size())));
  assert("pre: invalid refinement ratio" && (r >= 2));
 
  this->RefinementRatios[level] = r;
}
 
//------------------------------------------------------------------------------
inline int vtkStructuredAMRGridConnectivity::GetRefinementRatioAtLevel(const int level)
{
  assert("pre: RefinementRatios vector is not properly allocated" &&
    this->RefinementRatios.size() == this->NumberOfLevels);
  assert("pre: leve is out-of-bounds!" && (level >= 0) &&
    (level < static_cast<int>(this->RefinementRatios.size())));
  assert(
    "pre: refinement ratio for level has not been set" && (this->RefinementRatios[level] >= 2));
 
  return (this->RefinementRatios[level]);
}
 
//------------------------------------------------------------------------------
inline bool vtkStructuredAMRGridConnectivity::HasConstantRefinementRatio()
{
  if (this->RefinementRatio < 2)
  {
    return false;
  }
  return true;
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredAMRGridConnectivity::GetGridExtent(const int gridIdx, int ext[6])
{
  assert("pre: grid index is out-of-bounds" &&
    ((gridIdx >= 0) && (gridIdx < static_cast<int>(this->GridExtents.size()))));
 
  for (int i = 0; i < 6; ++i)
  {
    ext[i] = this->GridExtents[gridIdx * 6 + i];
  }
}
 
//------------------------------------------------------------------------------
inline bool vtkStructuredAMRGridConnectivity::LevelExists(const int level)
{
  if (this->AMRHierarchy.find(level) != this->AMRHierarchy.end())
  {
    return true;
  }
  return false;
}
 
//------------------------------------------------------------------------------
inline void vtkStructuredAMRGridConnectivity::InsertGridAtLevel(const int level, const int gridID)
{
  if (this->LevelExists(level))
  {
    this->AMRHierarchy[level].insert(gridID);
  }
  else
  {
    std::set<int> grids;
    grids.insert(gridID);
    this->AMRHierarchy[level] = grids;
  }
}
 
#endif /* VTKSTRUCTUREDAMRGRIDCONNECTIVITY_H_ */