vtkAMRUtilities.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkAMRUtilities_h
#define vtkAMRUtilities_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
#include <vector> // For C++ vector

// Forward declarations
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;
class vtkFieldData;
class vtkOverlappingAMR;
class vtkUniformGrid;
class vtkUnsignedCharArray;

class VTKCOMMONDATAMODEL_EXPORT vtkAMRUtilities : public vtkObject
{
public:
  // Standard Routines
  vtkTypeMacro(vtkAMRUtilities, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static void StripGhostLayers(
    vtkOverlappingAMR* ghostedAMRData, vtkOverlappingAMR* strippedAMRData);

  static bool HasPartiallyOverlappingGhostCells(vtkOverlappingAMR* amr);

  static void BlankCells(vtkOverlappingAMR* amr);

protected:
  vtkAMRUtilities() = default;
  ~vtkAMRUtilities() override = default;

  static void CopyFieldsWithinRealExtent(
    int realExtent[6], vtkUniformGrid* ghostedGrid, vtkUniformGrid* strippedGrid);

  static void CopyFieldData(
    vtkFieldData* target, vtkIdType targetIdx, vtkFieldData* source, vtkIdType sourceIdx);

  static vtkUniformGrid* StripGhostLayersFromGrid(vtkUniformGrid* grid, int ghost[6]);

  static void BlankGridsAtLevel(vtkOverlappingAMR* amr, int levelIdx,
    std::vector<std::vector<unsigned int>>& children, const std::vector<int>& processMap);

private:
  vtkAMRUtilities(const vtkAMRUtilities&) = delete;
  void operator=(const vtkAMRUtilities&) = delete;

  static void MergeGhostArrays(vtkDataArray* existingArray, vtkUnsignedCharArray* ghosts);
};

VTK_ABI_NAMESPACE_END
#endif /* vtkAMRUtilities_h */