vtkStructuredImplicitConnectivity.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkStructuredImplicitConnectivity.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 vtkStructuredImplicitConnectivity_h
#define vtkStructuredImplicitConnectivity_h

#include "vtkFiltersParallelMPIModule.h" // For export macro
#include "vtkObject.h"

// Forward declarations
class vtkDataArray;
class vtkImageData;
class vtkMPIController;
class vtkMultiProcessStream;
class vtkPointData;
class vtkPoints;
class vtkRectilinearGrid;
class vtkStructuredGrid;

namespace vtk
{
namespace detail
{

class CommunicationManager;
struct DomainMetaData;
struct StructuredGrid;

} // END namespace detail
} // END namespace vtk

class VTKFILTERSPARALLELMPI_EXPORT vtkStructuredImplicitConnectivity :
  public vtkObject
{
public:
  static vtkStructuredImplicitConnectivity* New();
  void PrintSelf(ostream& os, vtkIndent indent);
  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 (NULL 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(
        const 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(
        const int gridID,
        int extent[6],
        vtkDataArray* xcoords,
        vtkDataArray* ycoords,
        vtkDataArray* zcoords,
        vtkPointData* pointData
        );

  void EstablishConnectivity();

  bool HasImplicitConnectivity();

  void ExchangeData();

  void GetOutputStructuredGrid(const int gridID, vtkStructuredGrid* grid);

  void GetOutputImageData(const int gridID, vtkImageData* grid);

  void GetOutputRectilinearGrid(const int gridID, vtkRectilinearGrid* grid);

protected:
  vtkStructuredImplicitConnectivity();
  virtual ~vtkStructuredImplicitConnectivity();

  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(const int dim);

  void ComputeNeighbors();

  void ConstructOutput();

  void GrowGrid(const int dim);

  void UpdateNeighborList(const int dim);

  void GetGlobalImplicitConnectivityState();

  void ExchangeExtents();

private:
  vtkStructuredImplicitConnectivity(const vtkStructuredImplicitConnectivity&); // Not implemented
  void operator=(const vtkStructuredImplicitConnectivity&); // Not implemented
};
#endif