vtkStructuredImplicitConnectivity.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 vtkStructuredImplicitConnectivity_h
#define vtkStructuredImplicitConnectivity_h
 
#include "vtkFiltersParallelMPIModule.h" // For export macro
#include "vtkObject.h"
 
// Forward declarations
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;
class vtkImageData;
class vtkMPIController;
class vtkMultiProcessStream;
class vtkPointData;
class vtkPoints;
class vtkRectilinearGrid;
class vtkStructuredGrid;
VTK_ABI_NAMESPACE_END
 
namespace vtk
{
namespace detail
{
VTK_ABI_NAMESPACE_BEGIN
 
class CommunicationManager;
struct DomainMetaData;
struct StructuredGrid;
 
VTK_ABI_NAMESPACE_END
} // END namespace detail
} // END namespace vtk
 
VTK_ABI_NAMESPACE_BEGIN
class VTKFILTERSPARALLELMPI_EXPORT vtkStructuredImplicitConnectivity : public vtkObject
{
public:
  static vtkStructuredImplicitConnectivity* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;
  vtkTypeMacro(vtkStructuredImplicitConnectivity, vtkObject);

  void SetWholeExtent(int wholeExt[6]);
 
  // \brief Registers the structured grid dataset belonging to this process.
  // \param gridID the ID of the grid in this rank.
  // \param extent the [imin,imax,jmin,jmax,kmin,kmax] of the grid.
  // \param gridPnts pointer to the points of the grid (nullptr for uniform grid).
  // \param pointData pointer to the node-centered fields of the grid.
  // \pre gridID >= 0. The code uses values of gridID < -1 as flag internally.
  // \pre vtkStructuredExtent::Smaller(extent,wholeExtent) == true.
  // \note A rank with no or an empty grid, should not call this method.
  void RegisterGrid(int gridID, int extent[6], vtkPoints* gridPnts, vtkPointData* pointData);
 
  // \brief Registers the rectilinear grid dataset belonging to this process.
  // \param gridID the ID of the in this rank.
  // \param extent the [imin,imax,jmin,jmax,kmin,kmax] of the grid.
  // \param xcoords the x-coordinates array of the rectilinear grid.
  // \param ycoords the y-coordinates array of the rectilinear grid.
  // \param zcoords the z-coordinates array of the rectilinear grid.
  // \param pointData pointer to the node-centered fields of the grid.
  // \pre gridID >= 0. The code uses values of gridID < -1 as flag internally.
  // \pre vtkStructuredExtent::Smaller(extent,wholeExtent) == true.
  // \note A rank with no or an empty grid, should not call this method.
  void RegisterRectilinearGrid(int gridID, int extent[6], vtkDataArray* xcoords,
    vtkDataArray* ycoords, vtkDataArray* zcoords, vtkPointData* pointData);

  void EstablishConnectivity();

  bool HasImplicitConnectivity();

  void ExchangeData();

  void GetOutputStructuredGrid(int gridID, vtkStructuredGrid* grid);

  void GetOutputImageData(int gridID, vtkImageData* grid);

  void GetOutputRectilinearGrid(int gridID, vtkRectilinearGrid* grid);
 
protected:
  vtkStructuredImplicitConnectivity();
  ~vtkStructuredImplicitConnectivity() override;
 
  void SetController(vtkMPIController*);
  vtkMPIController* Controller;
 
  vtk::detail::DomainMetaData* DomainInfo;
  vtk::detail::StructuredGrid* InputGrid;
  vtk::detail::StructuredGrid* OutputGrid;
  vtk::detail::CommunicationManager* CommManager;

  bool GlobalDataDescriptionMatch();

  void PackData(int ext[6], vtkMultiProcessStream& bytestream);

  void UnPackData(unsigned char* buffer, unsigned int size);

  void AllocateBuffers(int dim);

  void ComputeNeighbors();

  void ConstructOutput();

  void GrowGrid(int dim);

  void UpdateNeighborList(int dim);

  void GetGlobalImplicitConnectivityState();

  void ExchangeExtents();
 
private:
  vtkStructuredImplicitConnectivity(const vtkStructuredImplicitConnectivity&) = delete;
  void operator=(const vtkStructuredImplicitConnectivity&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif