VTK  9.2.6
vtkAMRBaseParticlesReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAMRBaseParticlesReader.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  =========================================================================*/
21 #ifndef vtkAMRBaseParticlesReader_h
22 #define vtkAMRBaseParticlesReader_h
23 
24 #include "vtkIOAMRModule.h" // For export macro
26 
27 class vtkInformation;
29 class vtkIndent;
31 class vtkPolyData;
33 class vtkCallbackCommand;
34 
36 {
37 public:
39  void PrintSelf(ostream& os, vtkIndent indent) override;
40 
42 
45  vtkGetMacro(Frequency, int);
46  vtkSetMacro(Frequency, int);
48 
50 
53  vtkGetObjectMacro(Controller, vtkMultiProcessController);
54  virtual void SetController(vtkMultiProcessController*);
56 
58 
61  vtkSetMacro(FilterLocation, vtkTypeBool);
62  vtkGetMacro(FilterLocation, vtkTypeBool);
63  vtkBooleanMacro(FilterLocation, vtkTypeBool);
65 
67 
71  vtkGetObjectMacro(ParticleDataArraySelection, vtkDataArraySelection);
73 
77  int GetNumberOfParticleArrays();
78 
83  const char* GetParticleArrayName(int index);
84 
86 
89  int GetParticleArrayStatus(const char* name);
90  void SetParticleArrayStatus(const char* name, int status);
92 
93  virtual void SetFileName(VTK_FILEPATH const char* fileName);
94  vtkGetFilePathMacro(FileName);
95 
97 
100  inline void SetMinLocation(const double minx, const double miny, const double minz)
101  {
102  this->MinLocation[0] = minx;
103  this->MinLocation[1] = miny;
104  this->MinLocation[2] = minz;
105  }
107 
109 
112  inline void SetMaxLocation(const double maxx, const double maxy, const double maxz)
113  {
114  this->MaxLocation[0] = maxx;
115  this->MaxLocation[1] = maxy;
116  this->MaxLocation[2] = maxz;
117  }
119 
123  virtual int GetTotalNumberOfParticles() = 0;
124 
125 protected:
127  ~vtkAMRBaseParticlesReader() override;
128 
135  virtual void ReadMetaData() = 0;
136 
141  virtual vtkPolyData* ReadParticles(const int blkIdx) = 0;
142 
149  bool CheckLocation(const double x, const double y, const double z);
150 
154  bool IsParallel();
155 
160  bool IsBlockMine(const int blkIdx);
161 
169  int GetBlockProcessId(const int blkIdx);
170 
175  void Initialize();
176 
178 
184 
190  void InitializeParticleDataSelections();
191 
196  virtual void SetupParticleDataSelections() = 0;
197 
202  static void SelectionModifiedCallback(
203  vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
204 
206 
209  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
210  vtkInformationVector* outputVector) override;
213 
215 
217  double MinLocation[3];
218  double MaxLocation[3];
219 
222 
225  char* FileName;
226 
227 private:
229  void operator=(const vtkAMRBaseParticlesReader&) = delete;
230 };
231 
232 #endif /* vtkAMRBaseParticlesReader_h */
abstract base class for most VTK objects
Definition: vtkObject.h:62
Store vtkAlgorithm input/output information.
vtkCallbackCommand * SelectionObserver
Standard Array selection variables & methods.
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:90
Superclass for algorithms that produce only vtkMultiBlockDataSet as output.
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
vtkMultiProcessController * Controller
int FillOutputPortInformation(int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.
An abstract base class that implements all the common functionality for all particle readers...
int vtkTypeBool
Definition: vtkABI.h:69
supports function callbacks
a simple class to control print indentation
Definition: vtkIndent.h:39
void SetMaxLocation(const double maxx, const double maxy, const double maxz)
Sets the max location.
vtkDataArraySelection * ParticleDataArraySelection
Standard Array selection variables & methods.
Store on/off settings for data arrays, etc.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
#define VTK_FILEPATH
Store zero or more vtkInformation instances.
void SetMinLocation(const double minx, const double miny, const double minz)
Sets the min location.
Multiprocessing communication superclass.