vtkDistributedDataFilter.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkDistributedDataFilter.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.
 
=========================================================================*/
/*----------------------------------------------------------------------------
 Copyright (c) Sandia Corporation
 See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
----------------------------------------------------------------------------*/
 
#ifndef vtkDistributedDataFilter_h
#define vtkDistributedDataFilter_h
 
#include "vtkDataObjectAlgorithm.h"
#include "vtkFiltersParallelModule.h" // For export macro
 
#include <vector> // for vector
 
class vtkBSPCuts;
class vtkMultiProcessController;
class vtkPKdTree;
 
class VTKFILTERSPARALLEL_EXPORT vtkDistributedDataFilter : public vtkDataObjectAlgorithm
{
public:
  vtkTypeMacro(vtkDistributedDataFilter, vtkDataObjectAlgorithm);
 
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkDistributedDataFilter* New();
 
 
  void SetController(vtkMultiProcessController* c);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);
 
  vtkPKdTree* GetKdtree();
 
  vtkBooleanMacro(RetainKdtree, int);
  vtkGetMacro(RetainKdtree, int);
  vtkSetMacro(RetainKdtree, int);
 
  vtkBooleanMacro(IncludeAllIntersectingCells, int);
  vtkGetMacro(IncludeAllIntersectingCells, int);
  vtkSetMacro(IncludeAllIntersectingCells, int);
 
  vtkBooleanMacro(ClipCells, int);
  vtkGetMacro(ClipCells, int);
  vtkSetMacro(ClipCells, int);
 
  enum BoundaryModes
  {
    ASSIGN_TO_ONE_REGION = 0,
    ASSIGN_TO_ALL_INTERSECTING_REGIONS = 1,
    SPLIT_BOUNDARY_CELLS = 2
  };
 
 
  void SetBoundaryMode(int mode);
  void SetBoundaryModeToAssignToOneRegion()
  {
    this->SetBoundaryMode(vtkDistributedDataFilter::ASSIGN_TO_ONE_REGION);
  }
  void SetBoundaryModeToAssignToAllIntersectingRegions()
  {
    this->SetBoundaryMode(vtkDistributedDataFilter::ASSIGN_TO_ALL_INTERSECTING_REGIONS);
  }
  void SetBoundaryModeToSplitBoundaryCells()
  {
    this->SetBoundaryMode(vtkDistributedDataFilter::SPLIT_BOUNDARY_CELLS);
  }
  int GetBoundaryMode();
 
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  vtkBooleanMacro(UseMinimalMemory, int);
  vtkGetMacro(UseMinimalMemory, int);
  vtkSetMacro(UseMinimalMemory, int);
 
  vtkGetMacro(MinimumGhostLevel, int);
  vtkSetMacro(MinimumGhostLevel, int);
 
  vtkBooleanMacro(Timing, int);
  vtkSetMacro(Timing, int);
  vtkGetMacro(Timing, int);
 
  vtkBSPCuts* GetCuts() { return this->UserCuts; }
  void SetCuts(vtkBSPCuts* cuts);
 
  void SetUserRegionAssignments(const int* map, int numRegions);
 
protected:
  vtkDistributedDataFilter();
  ~vtkDistributedDataFilter() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  int RequestDataObject(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  vtkPKdTree* Kdtree;
  vtkMultiProcessController* Controller;
 
  int NumProcesses;
  int MyId;
 
  int* Target;
  int* Source;
 
  int NumConvexSubRegions;
  double* ConvexSubRegionBounds;
 
  // User-adjustable minimum number of ghost levels.
  int MinimumGhostLevel;
 
  // Actual number of ghost levels used during execution.
  int GhostLevel;
 
  int RetainKdtree;
  int IncludeAllIntersectingCells;
  int ClipCells;
 
  int Timing;
 
  int NextProgressStep;
  double ProgressIncrement;
 
  int UseMinimalMemory;
 
  vtkBSPCuts* UserCuts;
 
  std::vector<int> UserRegionAssignments;
 
private:
  vtkDistributedDataFilter(const vtkDistributedDataFilter&) = delete;
  void operator=(const vtkDistributedDataFilter&) = delete;
};
#endif