VTK  9.0.3
vtkAMRBaseReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAMRBaseReader.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14  =========================================================================*/
22 #ifndef vtkAMRBaseReader_h
23 #define vtkAMRBaseReader_h
24 
25 #include "vtkIOAMRModule.h" // For export macro
27 #include <map> // STL map header
28 #include <utility> // for STL pair
29 #include <vector> // STL vector header
30 
31 // Forward Declarations
32 class vtkOverlappingAMR;
35 class vtkCallbackCommand;
36 class vtkIndent;
37 class vtkAMRDataSetCache;
38 class vtkUniformGrid;
39 class vtkDataArray;
40 
41 class VTKIOAMR_EXPORT vtkAMRBaseReader : public vtkOverlappingAMRAlgorithm
42 {
43 public:
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
51  void Initialize();
52 
54 
57  vtkSetMacro(EnableCaching, vtkTypeBool);
58  vtkGetMacro(EnableCaching, vtkTypeBool);
59  vtkBooleanMacro(EnableCaching, vtkTypeBool);
60  bool IsCachingEnabled() const { return ((this->EnableCaching) ? true : false); };
62 
64 
68  vtkSetMacro(Controller, vtkMultiProcessController*);
69  vtkGetMacro(Controller, vtkMultiProcessController*);
71 
73 
76  vtkSetMacro(MaxLevel, int);
78 
80 
84  vtkGetObjectMacro(CellDataArraySelection, vtkDataArraySelection);
85  vtkGetObjectMacro(PointDataArraySelection, vtkDataArraySelection);
87 
89 
95 
97 
101  const char* GetPointArrayName(int index);
102  const char* GetCellArrayName(int index);
104 
106 
110  int GetPointArrayStatus(const char* name);
111  int GetCellArrayStatus(const char* name);
112  void SetPointArrayStatus(const char* name, int status);
113  void SetCellArrayStatus(const char* name, int status);
115 
117 
121  vtkGetStringMacro(FileName);
122  virtual void SetFileName(const char* fileName) = 0;
124 
128  virtual int GetNumberOfBlocks() = 0;
129 
133  virtual int GetNumberOfLevels() = 0;
134 
135 protected:
137  ~vtkAMRBaseReader() override;
138 
139  // Desscription:
140  // Checks if this reader instance is attached to a communicator
141  // with more than one MPI processes.
142  bool IsParallel();
143 
148  bool IsBlockMine(const int blockIdx);
149 
155  vtkUniformGrid* GetAMRBlock(const int blockIdx);
156 
162 
170 
175  void GetAMRData(const int blockIdx, vtkUniformGrid* block, const char* fieldName);
176 
180  void GetAMRPointData(const int blockIdx, vtkUniformGrid* block, const char* fieldName);
181 
187  void LoadPointData(const int blockIdx, vtkUniformGrid* block);
188 
195  void LoadCellData(const int blockIdx, vtkUniformGrid* block);
196 
205  int GetBlockProcessId(const int blockIdx);
206 
215 
219  virtual void ReadMetaData() = 0;
220 
224  virtual int GetBlockLevel(const int blockIdx) = 0;
225 
231  virtual int FillMetaData() = 0;
232 
236  virtual vtkUniformGrid* GetAMRGrid(const int blockIdx) = 0;
237 
241  virtual void GetAMRGridData(const int blockIdx, vtkUniformGrid* block, const char* field) = 0;
242 
246  virtual void GetAMRGridPointData(
247  const int blockIdx, vtkUniformGrid* block, const char* field) = 0;
248 
250 
253  int RequestData(vtkInformation* vtkNotUsed(request),
254  vtkInformationVector** vtkNotUsed(inputVector), vtkInformationVector* outputVector) override;
256  vtkInformationVector* outputVector) override;
259 
260  // Array selection member variables and methods
264 
271 
275  virtual void SetUpDataArraySelections() = 0;
276 
281  vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
282 
284  int MaxLevel;
285  char* FileName;
287 
292 
295 
296  std::vector<int> BlockMap;
297 
298 private:
299  vtkAMRBaseReader(const vtkAMRBaseReader&) = delete;
300  void operator=(const vtkAMRBaseReader&) = delete;
301 };
302 
303 #endif /* vtkAMRBaseReader_h */
An abstract class that encapsulates common functionality for all AMR readers.
std::vector< int > BlockMap
void SetupBlockRequest(vtkInformation *outputInfo)
Initializes the request of blocks to be loaded.
int GetNumberOfCellArrays()
const char * GetPointArrayName(int index)
Get the name of the point or cell array with the given index in the input.
void GetAMRData(const int blockIdx, vtkUniformGrid *block, const char *fieldName)
Loads the AMR data corresponding to the given field name.
int RequestData(vtkInformation *vtkNotUsed(request), vtkInformationVector **vtkNotUsed(inputVector), vtkInformationVector *outputVector) override
Standard Pipeline methods, subclasses may override this method if needed.
vtkDataArraySelection * PointDataArraySelection
virtual void GetAMRGridPointData(const int blockIdx, vtkUniformGrid *block, const char *field)=0
Loads the block Point data.
vtkCallbackCommand * SelectionObserver
vtkDataArraySelection * CellDataArraySelection
virtual vtkUniformGrid * GetAMRGrid(const int blockIdx)=0
Loads the block according to the index w.r.t.
virtual int GetNumberOfBlocks()=0
Returns the total number of blocks.
vtkTypeBool EnableCaching
virtual void ReadMetaData()=0
Reads all the metadata from the file.
void LoadRequestedBlocks(vtkOverlappingAMR *amrds)
This method loads all the blocks in the BlockMap for the given process.
static void SelectionModifiedCallback(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
Call-back registered with the SelectionObserver.
int GetCellArrayStatus(const char *name)
int GetBlockProcessId(const int blockIdx)
Returns the block process ID for the block corresponding to the given block index.
void LoadCellData(const int blockIdx, vtkUniformGrid *block)
A wrapper that loops over all cell arrays and loads the cell arrays that are enabled,...
virtual int GetBlockLevel(const int blockIdx)=0
Returns the block level for the given block.
bool IsCachingEnabled() const
void AssignAndLoadBlocks(vtkOverlappingAMR *amrds)
This method assigns blocks to processes using block-cyclic distribution.
bool IsBlockMine(const int blockIdx)
Determines if the block is owned by this process based on the the block index and total number of pro...
void SetPointArrayStatus(const char *name, int status)
void GetAMRPointData(const int blockIdx, vtkUniformGrid *block, const char *fieldName)
Loads the AMR point data corresponding to the given field name.
virtual int FillMetaData()=0
Loads all the AMR metadata & constructs the LevelIdxPair12InternalIdx datastructure which maps (level...
~vtkAMRBaseReader() override
int GetPointArrayStatus(const char *name)
Get/Set whether the point or cell array with the given name is to be read.
void InitializeArraySelections()
Initializes the array selections.
virtual void GetAMRGridData(const int blockIdx, vtkUniformGrid *block, const char *field)=0
Loads the block data.
int RequestInformation(vtkInformation *rqst, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called by the superclass.
vtkOverlappingAMR * Metadata
void Initialize()
Initializes the AMR reader.
virtual void SetFileName(const char *fileName)=0
void LoadPointData(const int blockIdx, vtkUniformGrid *block)
A wrapper that loops over point arrays and load the point arrays that are enabled,...
const char * GetCellArrayName(int index)
vtkAMRDataSetCache * Cache
void SetCellArrayStatus(const char *name, int status)
vtkMultiProcessController * Controller
virtual int GetNumberOfLevels()=0
Returns the total number of levels.
int FillOutputPortInformation(int port, vtkInformation *info) override
See algorithm for more info.
vtkUniformGrid * GetAMRBlock(const int blockIdx)
Loads the AMR block corresponding to the given index.
int GetNumberOfPointArrays()
Get the number of point or cell arrays available in the input.
virtual void SetUpDataArraySelections()=0
Initializes the PointDataArraySelection & CellDataArraySelection.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
A concrete implementation of vtkObject that provides functionality for caching AMR blocks.
supports function callbacks
Store on/off settings for data arrays for a vtkSource.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
a simple class to control print indentation
Definition: vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Multiprocessing communication superclass.
abstract base class for most VTK objects
Definition: vtkObject.h:63
A base class for all algorithms that take as input vtkOverlappingAMR and produce vtkOverlappingAMR.
hierarchical dataset of vtkUniformGrids
image data with blanking
@ field
Definition: vtkX3D.h:183
@ info
Definition: vtkX3D.h:382
@ port
Definition: vtkX3D.h:453
@ name
Definition: vtkX3D.h:225
@ index
Definition: vtkX3D.h:252
int vtkTypeBool
Definition: vtkABI.h:69