VTK  9.3.0
vtkHyperTreeGridPreConfiguredSource.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
3 
14 #include "vtkFiltersSourcesModule.h" //for export macro
16 
17 #ifndef vtkHyperTreeGridPreConfiguredSource_h
18 #define vtkHyperTreeGridPreConfiguredSource_h
19 
20 VTK_ABI_NAMESPACE_BEGIN
21 class vtkHyperTreeGrid;
23 class vtkDoubleArray;
24 
25 class VTKFILTERSSOURCES_EXPORT vtkHyperTreeGridPreConfiguredSource
27 {
28 public:
34 
36 
39  void GenerateUnbalanced(vtkHyperTreeGrid* HTG, unsigned int dim, unsigned int factor,
40  unsigned int depth, const std::vector<double>& extent,
41  const std::vector<unsigned int>& subdivisions);
42 
43  void GenerateBalanced(vtkHyperTreeGrid* HTG, unsigned int dim, unsigned int factor,
44  unsigned int depth, const std::vector<double>& extent,
45  const std::vector<unsigned int>& subdivisions);
47 
49 
52  enum HTGType
53  {
60  CUSTOM
61  };
63 
65 
69  {
71  BALANCED
72  };
74 
80 
82 
85  vtkGetEnumMacro(CustomArchitecture, HTGArchitecture);
86  vtkSetEnumMacro(CustomArchitecture, HTGArchitecture);
87 
91  vtkGetMacro(CustomDim, unsigned int);
92  vtkSetMacro(CustomDim, unsigned int);
93 
97  vtkGetMacro(CustomFactor, unsigned int);
98  vtkSetMacro(CustomFactor, unsigned int);
99 
103  vtkGetMacro(CustomDepth, unsigned int);
104  vtkSetMacro(CustomDepth, unsigned int);
105 
109  vtkGetVector6Macro(CustomExtent, double);
110  vtkSetVector6Macro(CustomExtent, double);
111 
115  vtkGetVector3Macro(CustomSubdivisions, unsigned int);
116  vtkSetVector3Macro(CustomSubdivisions, unsigned int);
118 
120 
124 
126 
128 
130 
132 
134 
137 
138 protected:
145 
147 
149 
152 
154 
156 
159  void Preprocess(vtkHyperTreeGrid* HTG, unsigned int dim, unsigned int factor,
160  const std::vector<double>& extent, const std::vector<unsigned int>& subdivisions);
161 
166  vtkHyperTreeGridNonOrientedCursor* cursor, vtkDoubleArray* levels, int maxDepth);
168 
170 
174 
179  unsigned int CustomDim;
180  unsigned int CustomFactor;
181  unsigned int CustomDepth;
182  double CustomExtent[6];
183  unsigned int CustomSubdivisions[3];
185 
186 }; // vtkHyperTreeGridPreConfiguredSource
187 VTK_ABI_NAMESPACE_END
188 
189 #endif // vtkHyperTreeGridPreConfiguredSource_h
general representation of visualization data
Definition: vtkDataObject.h:55
dynamic, self-adjusting array of double
Superclass for algorithms that produce a hyper tree grid as output.
Objects for traversal a HyperTreeGrid.
Helper class for generating a curated set of HyperTree Grids (HTGs) for testing purposes.
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
void operator=(const vtkHyperTreeGridPreConfiguredSource &)=delete
vtkSetEnumMacro(CustomArchitecture, HTGArchitecture)
Get/Set for custom architecture.
HTGType
An enum type for referencing preconfigured HTGs.
unsigned int CustomFactor
The pre-configuration mode of the generator.
~vtkHyperTreeGridPreConfiguredSource() override=default
HTGType HTGMode
The pre-configuration mode of the generator.
vtkGetEnumMacro(CustomArchitecture, HTGArchitecture)
Get/Set for custom architecture.
void GenerateUnbalanced3DepthQuadTree2x3(vtkHyperTreeGrid *HTG)
Helper functions for generating the different types of HTGs.
HTGArchitecture
An enum type for configuring the type of generation for the CUSTOM HTG type.
void GenerateBalanced2Depth3BranchTree3x3x2(vtkHyperTreeGrid *HTG)
Helper functions for generating the different types of HTGs.
void GenerateBalanced3DepthQuadTree2x3(vtkHyperTreeGrid *HTG)
Helper functions for generating the different types of HTGs.
int ProcessTrees(vtkHyperTreeGrid *, vtkDataObject *) override
Main routine to process individual trees in the grid This is pure virtual method to be implemented by...
static vtkHyperTreeGridPreConfiguredSource * New()
void Preprocess(vtkHyperTreeGrid *HTG, unsigned int dim, unsigned int factor, const std::vector< double > &extent, const std::vector< unsigned int > &subdivisions)
Common preprocessing for setting up the HyperTreeGrid for all types.
void GenerateBalanced4Depth3BranchTree2x2(vtkHyperTreeGrid *HTG)
Helper functions for generating the different types of HTGs.
HTGArchitecture CustomArchitecture
All members related to the CUSTOM HTGType.
void GenerateUnbalanced3DepthOctTree3x2x3(vtkHyperTreeGrid *HTG)
Helper functions for generating the different types of HTGs.
int GenerateCustom(vtkHyperTreeGrid *HTG)
Helper functions for generating the different types of HTGs.
void GenerateUnbalanced2Depth3BranchTree3x3(vtkHyperTreeGrid *HTG)
Helper functions for generating the different types of HTGs.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkHyperTreeGridPreConfiguredSource(const vtkHyperTreeGridPreConfiguredSource &)=delete
vtkGetEnumMacro(HTGMode, HTGType)
Get/Set HyperTreeGrid mode.
unsigned int CustomDepth
The pre-configuration mode of the generator.
unsigned int CustomDim
The pre-configuration mode of the generator.
int FillOutputPortInformation(int, vtkInformation *) override
Define default input and output port types.
vtkHyperTreeGridPreConfiguredSource()
Constructor setup.
void GenerateUnbalanced(vtkHyperTreeGrid *HTG, unsigned int dim, unsigned int factor, unsigned int depth, const std::vector< double > &extent, const std::vector< unsigned int > &subdivisions)
Helper methods for generating HTGs.
void RecurseBalanced(vtkHyperTreeGridNonOrientedCursor *cursor, vtkDoubleArray *levels, int maxDepth)
Recursive helper for the BALANCED architecture.
void GenerateBalanced(vtkHyperTreeGrid *HTG, unsigned int dim, unsigned int factor, unsigned int depth, const std::vector< double > &extent, const std::vector< unsigned int > &subdivisions)
Helper methods for generating HTGs.
A dataset containing a grid of vtkHyperTree instances arranged as a rectilinear grid.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
@ extent
Definition: vtkX3D.h:345