vtkPDistributedDataFilter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause

 
#ifndef vtkPDistributedDataFilter_h
#define vtkPDistributedDataFilter_h
 
#include "vtkDistributedDataFilter.h"
#include "vtkFiltersParallelGeometryModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkBSPCuts;
class vtkDataArray;
class vtkFloatArray;
class vtkIdList;
class vtkIdTypeArray;
class vtkIntArray;
class vtkMultiProcessController;
class vtkPDistributedDataFilterSTLCloak;
class vtkPKdTree;
class vtkUnstructuredGrid;
 
class VTKFILTERSPARALLELGEOMETRY_EXPORT vtkPDistributedDataFilter : public vtkDistributedDataFilter
{
public:
  vtkTypeMacro(vtkPDistributedDataFilter, vtkDistributedDataFilter);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkPDistributedDataFilter* New();
 
protected:
  vtkPDistributedDataFilter();
  ~vtkPDistributedDataFilter() override;

 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  void SingleProcessExecute(vtkDataSet* input, vtkUnstructuredGrid* output);

  int RequestDataInternal(vtkDataSet* input, vtkUnstructuredGrid* output);
 
private:
  enum
  {
    DeleteNo = 0,
    DeleteYes = 1
  };
 
  enum
  {
    DuplicateCellsNo = 0,
    DuplicateCellsYes = 1
  };
 
  enum
  {
    GhostCellsNo = 0,
    GhostCellsYes = 1
  };
 
  enum
  {
    UnsetGhostLevel = 99
  };

  int PartitionDataAndAssignToProcesses(vtkDataSet* set);

  vtkUnstructuredGrid* RedistributeDataSet(
    vtkDataSet* set, vtkDataSet* input, int filterOutDuplicateCells);

  int ClipGridCells(vtkUnstructuredGrid* grid);

  vtkUnstructuredGrid* AcquireGhostCells(vtkUnstructuredGrid* grid);

  void ComputeMyRegionBounds();

  int CheckFieldArrayTypes(vtkDataSet* set);

  vtkDataSet* TestFixTooFewInputFiles(vtkDataSet* input, int& duplicateCells);

  vtkUnstructuredGrid* MPIRedistribute(
    vtkDataSet* in, vtkDataSet* input, int filterOutDuplicateCells);

  vtkIdList** GetCellIdsForProcess(int proc, int* nlists);

  void SetUpPairWiseExchange();


  void FreeIntArrays(vtkIdTypeArray** ar);
  static void FreeIdLists(vtkIdList** lists, int nlists);
  static vtkIdType GetIdListSize(vtkIdList** lists, int nlists);


  vtkIdTypeArray* ExchangeCounts(vtkIdType myCount, int tag);
  vtkIdTypeArray* ExchangeCountsLean(vtkIdType myCount, int tag);
  vtkIdTypeArray* ExchangeCountsFast(vtkIdType myCount, int tag);


  vtkIdTypeArray** ExchangeIdArrays(vtkIdTypeArray** arIn, int deleteSendArrays, int tag);
  vtkIdTypeArray** ExchangeIdArraysLean(vtkIdTypeArray** arIn, int deleteSendArrays, int tag);
  vtkIdTypeArray** ExchangeIdArraysFast(vtkIdTypeArray** arIn, int deleteSendArrays, int tag);


  vtkFloatArray** ExchangeFloatArrays(vtkFloatArray** myArray, int deleteSendArrays, int tag);
  vtkFloatArray** ExchangeFloatArraysLean(vtkFloatArray** myArray, int deleteSendArrays, int tag);
  vtkFloatArray** ExchangeFloatArraysFast(vtkFloatArray** myArray, int deleteSendArrays, int tag);


  vtkUnstructuredGrid* ExchangeMergeSubGrids(vtkIdList** cellIds, int deleteCellIds,
    vtkDataSet* myGrid, int deleteMyGrid, int filterOutDuplicateCells, int ghostCellFlag, int tag);
  vtkUnstructuredGrid* ExchangeMergeSubGrids(vtkIdList*** cellIds, int* numLists, int deleteCellIds,
    vtkDataSet* myGrid, int deleteMyGrid, int filterOutDuplicateCells, int ghostCellFlag, int tag);
  vtkUnstructuredGrid* ExchangeMergeSubGridsLean(vtkIdList*** cellIds, int* numLists,
    int deleteCellIds, vtkDataSet* myGrid, int deleteMyGrid, int filterOutDuplicateCells,
    int ghostCellFlag, int tag);
  vtkUnstructuredGrid* ExchangeMergeSubGridsFast(vtkIdList*** cellIds, int* numLists,
    int deleteCellIds, vtkDataSet* myGrid, int deleteMyGrid, int filterOutDuplicateCells,
    int ghostCellFlag, int tag);


  char* MarshallDataSet(vtkUnstructuredGrid* extractedGrid, vtkIdType& size);
  vtkUnstructuredGrid* UnMarshallDataSet(char* buf, vtkIdType size);


  void ClipCellsToSpatialRegion(vtkUnstructuredGrid* grid);
#if 0
  void ClipWithVtkClipDataSet(vtkUnstructuredGrid *grid, double *bounds,
           vtkUnstructuredGrid **outside, vtkUnstructuredGrid **inside);
#endif
 
  void ClipWithBoxClipDataSet(vtkUnstructuredGrid* grid, double* bounds,
    vtkUnstructuredGrid** outside, vtkUnstructuredGrid** inside);


  vtkIdTypeArray* GetGlobalNodeIdArray(vtkDataSet* set);
  vtkIdType* GetGlobalNodeIds(vtkDataSet* set);
  vtkIdTypeArray* GetGlobalElementIdArray(vtkDataSet* set);
  vtkIdType* GetGlobalElementIds(vtkDataSet* set);
  int AssignGlobalNodeIds(vtkUnstructuredGrid* grid);
  int AssignGlobalElementIds(vtkDataSet* in);
  vtkIdTypeArray** FindGlobalPointIds(vtkFloatArray** ptarray, vtkIdTypeArray* ids,
    vtkUnstructuredGrid* grid, vtkIdType& numUniqueMissingPoints);

  vtkIdTypeArray** MakeProcessLists(
    vtkIdTypeArray** pointIds, vtkPDistributedDataFilterSTLCloak* procs);

  vtkIdList** BuildRequestedGrids(vtkIdTypeArray** globalPtIds, vtkUnstructuredGrid* grid,
    vtkPDistributedDataFilterSTLCloak* ptIdMap);


  int InMySpatialRegion(float x, float y, float z);
  int InMySpatialRegion(double x, double y, double z);
  int StrictlyInsideMyBounds(float x, float y, float z);
  int StrictlyInsideMyBounds(double x, double y, double z);


  vtkIdTypeArray** GetGhostPointIds(
    int ghostLevel, vtkUnstructuredGrid* grid, int AddCellsIAlreadyHave);
  vtkUnstructuredGrid* AddGhostCellsUniqueCellAssignment(
    vtkUnstructuredGrid* myGrid, vtkPDistributedDataFilterSTLCloak* globalToLocalMap);
  vtkUnstructuredGrid* AddGhostCellsDuplicateCellAssignment(
    vtkUnstructuredGrid* myGrid, vtkPDistributedDataFilterSTLCloak* globalToLocalMap);
  vtkUnstructuredGrid* SetMergeGhostGrid(vtkUnstructuredGrid* ghostCellGrid,
    vtkUnstructuredGrid* incomingGhostCells, int ghostLevel,
    vtkPDistributedDataFilterSTLCloak* idMap);


  vtkUnstructuredGrid* ExtractCells(vtkIdList* list, int deleteCellLists, vtkDataSet* in);
  vtkUnstructuredGrid* ExtractCells(
    vtkIdList** lists, int nlists, int deleteCellLists, vtkDataSet* in);
  vtkUnstructuredGrid* ExtractZeroCellGrid(vtkDataSet* in);


  static int GlobalPointIdIsUsed(
    vtkUnstructuredGrid* grid, int ptId, vtkPDistributedDataFilterSTLCloak* globalToLocal);
  static int LocalPointIdIsUsed(vtkUnstructuredGrid* grid, int ptId);
  static vtkIdType FindId(vtkIdTypeArray* ids, vtkIdType gid, vtkIdType startLoc);

  static vtkIdTypeArray* AddPointAndCells(vtkIdType gid, vtkIdType localId,
    vtkUnstructuredGrid* grid, vtkIdType* gidCells, vtkIdTypeArray* ids);


  static void AddConstantUnsignedCharPointArray(
    vtkUnstructuredGrid* grid, const char* arrayName, unsigned char val);
  static void AddConstantUnsignedCharCellArray(
    vtkUnstructuredGrid* grid, const char* arrayName, unsigned char val);

  static void RemoveRemoteCellsFromList(
    vtkIdList* cellList, vtkIdType* gidCells, vtkIdType* remoteCells, vtkIdType nRemoteCells);

  static vtkUnstructuredGrid* MergeGrids(vtkDataSet** sets, int nsets, int deleteDataSets,
    int useGlobalNodeIds, float pointMergeTolerance, int useGlobalCellIds);
 
  vtkPDistributedDataFilter(const vtkPDistributedDataFilter&) = delete;
  void operator=(const vtkPDistributedDataFilter&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif