1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkHyperTreeGridGhostCellsGenerator
* @brief Generate ghost cells for distributed vtkHyperTreeGrids
*
* This filter generates ghost cells for vtkHyperTreeGrid type data.
* It can also take a vtkPartitionedDataSet composed of HyperTreeGrid partition,
* where each process has a single non-null partition. In case of a PartitionedDataSet, the output
* structure is identical to the input structure.
*
* This filter produces ghost hyper trees at the interfaces between different processes,
* only composed of the nodes and leaves at this interface to avoid data waste.
*
* This filter should be used in a multi-processes environment, and is only required if wanting to
* filter a vtkHyperTreeGrid with algorithms using Von Neumann or Moore supercursors afterwards.
*
* All processes should have a single HTG with a correct extent, even if it does not contain any
* actual unmasked cells.
*
* @par Thanks:
* This class was written by Jacques-Bernard Lekien, 2019
* This work was supported by Commissariat a l'Energie Atomique
* CEA, DAM, DIF, F-91297 Arpajon, France.
*/
#ifndef vtkHyperTreeGridGhostCellsGenerator_h
#define vtkHyperTreeGridGhostCellsGenerator_h
#include "vtkFiltersParallelModule.h" // For export macro
#include "vtkHyperTreeGridAlgorithm.h"
#include "vtkWeakPointer.h" // for vtkWeakPointer
#include <vector> // For vtkHypertreeGridGhostCellsGenerator::ExtractInterface
VTK_ABI_NAMESPACE_BEGIN
class vtkBitArray;
class vtkCellData;
class vtkHyperTreeGrid;
class vtkHyperTreeGridNonOrientedCursor;
class vtkMultiProcessController;
class vtkUnsignedCharArray;
class VTKFILTERSPARALLEL_EXPORT vtkHyperTreeGridGhostCellsGenerator
: public vtkHyperTreeGridAlgorithm
{
public:
static vtkHyperTreeGridGhostCellsGenerator* New();
vtkTypeMacro(vtkHyperTreeGridGhostCellsGenerator, vtkHyperTreeGridAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* Get/Set the controller to use. By default
* vtkMultiProcessController::GlobalController will be used.
*/
virtual void SetController(vtkMultiProcessController*);
vtkMultiProcessController* GetController();
///@}
protected:
vtkHyperTreeGridGhostCellsGenerator();
~vtkHyperTreeGridGhostCellsGenerator() override;
struct vtkInternals;
/**
* Input must be either HTG or vtkPartitionnedDataSet composed of HTG partitions.
*/
int FillInputPortInformation(int, vtkInformation*) override;
/**
* Override RequestData, to make sure every HTG piece can be processed, hence avoiding that one
* rank waits for the others which will actually never enter the filter.
*/
int RequestData(vtkInformation* vtkNotUsed(request), vtkInformationVector** inputVector,
vtkInformationVector* outputVector) override;
/**
* Main routine to generate ghost cells using information
* from the neighboring HTGs.
*/
int ProcessTrees(vtkHyperTreeGrid*, vtkDataObject*) override;
/**
* Recursively copy the input tree (cell data and mask information)
* pointed by the cursor to the output. Fills memory gaps if present.
*/
VTK_DEPRECATED_IN_9_4_0(
"This method is now defined in an internal class, and cannot be overridden anymore.")
void CopyInputTreeToOutput(vtkHyperTreeGridNonOrientedCursor* inCursor,
vtkHyperTreeGridNonOrientedCursor* outCursor, vtkCellData* inCellData, vtkCellData* outCellData,
vtkBitArray* inMask, vtkBitArray* outMask);
/**
* Reads the input interface with neighbor processes.
* This method is built in mirror with vtkHyperTreeGridGhostCellsGenerator::CreateGhostTree
*/
VTK_DEPRECATED_IN_9_4_0(
"This method is now defined in an internal class, and cannot be overridden anymore.")
void ExtractInterface(vtkHyperTreeGridNonOrientedCursor* inCursor, vtkBitArray* isParent,
std::vector<vtkIdType>& indices, vtkHyperTreeGrid* grid, unsigned int mask, vtkIdType& pos);
/**
* Creates a ghost tree in the output. It is built in mirror with
* vtkHyperTreeGridGhostCellsGenerator::ExtractInterface.
*/
VTK_DEPRECATED_IN_9_4_0(
"This method is now defined in an internal class, and cannot be overridden anymore.")
vtkIdType CreateGhostTree(vtkHyperTreeGridNonOrientedCursor* outCursor, vtkBitArray* isParent,
vtkIdType* indices, vtkIdType&& pos = 0);
private:
vtkHyperTreeGridGhostCellsGenerator(const vtkHyperTreeGridGhostCellsGenerator&) = delete;
void operator=(const vtkHyperTreeGridGhostCellsGenerator&) = delete;
vtkWeakPointer<vtkMultiProcessController> Controller;
};
VTK_ABI_NAMESPACE_END
#endif /* vtkHyperTreeGridGhostCellsGenerator */
|