vtkAMRBaseParticlesReader.h 6.59 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/*=========================================================================

 Program:   Visualization Toolkit
 Module:    vtkAMRBaseParticlesReader.h

 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 All rights reserved.
 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

 This software is distributed WITHOUT ANY WARRANTY; without even
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notice for more information.

 =========================================================================*/
// .NAME vtkAMRBaseParticlesReader.h -- Base class for all AMR particle readers
//
// .SECTION Description
18
19
//  An abstract base class that implements all the common functionality for
//  all particle readers.
20
21
22
23
24
25

#ifndef VTKAMRBASEPARTICLESREADER_H_
#define VTKAMRBASEPARTICLESREADER_H_

#include "vtkMultiBlockDataSetAlgorithm.h"

26
27
28
29
30
class vtkInformation;
class vtkInformationVector;
class vtkIndent;
class vtkMultiProcessController;
class vtkPolyData;
George Zagaris's avatar
George Zagaris committed
31
32
class vtkDataArraySelection;
class vtkCallbackCommand;
33

34
35
36
37
38
class VTK_AMR_EXPORT vtkAMRBaseParticlesReader :
  public vtkMultiBlockDataSetAlgorithm
{
  public:
      vtkTypeMacro( vtkAMRBaseParticlesReader, vtkMultiBlockDataSetAlgorithm );
39
      void PrintSelf(ostream &os, vtkIndent indent );
40

41
42
      // Description:
      // Set & Get the frequency.
43
44
45
      vtkGetMacro(Frequency,int);
      vtkSetMacro(Frequency,int);

46
47
48
49
50
51
52
53
54
55
56
      // Description:
      // Set & Get the multi-process controller.
      vtkGetMacro(Controller, vtkMultiProcessController* );
      vtkSetMacro(Controller, vtkMultiProcessController* );

      // Description:
      // Set & Get for filter location and boolean macro
      vtkSetMacro(FilterLocation,int);
      vtkGetMacro(FilterLocation,int);
      vtkBooleanMacro(FilterLocation,int);

George Zagaris's avatar
George Zagaris committed
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

      // Description:
      // Get the data array selection tables used to configure which data
      // arrays are loaded by the reader.
      vtkGetObjectMacro(ParticleDataArraySelection,vtkDataArraySelection);

      // Description:
      // Get the number of particles arrays available in the input.
      int GetNumberOfParticleArrays();

      // Description:
      // Get the particle array name of the array associated with the given
      // index.
      const char* GetParticleArrayName( int index );

      // Description:
      // Get/Set whether the particle array status.
      int GetParticleArrayStatus( const char* name );
      void SetParticleArrayStatus( const char* name, int status );


78
      virtual void SetFileName( const char *fileName );
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
      vtkGetStringMacro(FileName);

      // Description:
      // Sets the min location
      inline void SetMinLocation(
          const double minx, const double miny, const double minz )
        {
          this->MinLocation[ 0 ] = minx;
          this->MinLocation[ 1 ] = miny;
          this->MinLocation[ 2 ] = minz;
        }

      // Description:
      // Sets the max location
      inline void SetMaxLocation(
          const double maxx, const double maxy, const double maxz )
        {
          this->MaxLocation[ 0 ] = maxx;
          this->MaxLocation[ 1 ] = maxy;
          this->MaxLocation[ 2 ] = maxz;
        }

101
102
103
104
      // Description:
      // Returns the total number of particles
      virtual int GetTotalNumberOfParticles() = 0;

105
106
107
108
  protected:
    vtkAMRBaseParticlesReader();
    virtual ~vtkAMRBaseParticlesReader();

109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
    // Description:
    // Reads the metadata, e.g., the number of blocks in the file.
    // After the metadata is read, this->Initialized is set to true.
    // Furthermore, to limit I/O, all concrete classes must make sure
    // that this method returns immediately if this->Initialized is true.
    virtual void ReadMetaData() = 0;

    // Description:
    // Reads the particles corresponding to the block associated with the
    // given supplied block index.
    virtual vtkPolyData* ReadParticles( const int blkIdx ) = 0;

    // Description:
    // Filters particles by their location. If FilterLocation is ON, this
    // method returns whether or not the particle with the supplied xyz
    // coordiantes flass within the bouning box spefixied by the user using
    // the SetMinLocation & SetMaxLocation.
    bool CheckLocation( const double x, const double y, const double z );

    // Description:
    // Determines whether this reader instance is running in parallel or not.
    bool IsParallel( );

    // Description:
    // Determines if the block associated with the given block index belongs
    // to the process that executes the current instance of the reader.
    bool IsBlockMine( const int blkIdx );

    // Description:
    // Given the block index, this method determines the process Id.
    // If the reader instance is serial this method always returns 0.
    // Otherwise, static block-cyclic-distribution is assumed and each
    // block is assigned to a process according to blkIdx%N, where N is
    // the total number of processes.
    int GetBlockProcessId( const int blkIdx );

145
146
147
148
149
    // Description:
    // Initializes the AMR Particles reader
    // NOTE: must be called in the constructor of concrete classes.
    void Initialize();

George Zagaris's avatar
George Zagaris committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
    // Description:
    // Standard Array selection variables & methods
    vtkDataArraySelection *ParticleDataArraySelection;
    vtkCallbackCommand *SelectionObserver;

    // Description:
    // Initializes the ParticleDataArraySelection object. This method
    // only executes for an intial request in which case all arrays are
    // deselected.
    void InitializeParticleDataSelections();

    // Description:
    // Sets up the ParticleDataArraySelection. Implemented
    // by concrete classes.
    virtual void SetupParticleDataSelections() = 0;

    // Description:
    // Call-back registered with the SelectionObserver for selecting/deselecting
    // particles
    static void SelectionModifiedCallback(
     vtkObject *caller,unsigned long eid,void *clientdata,void *calldata );

    // Description:
173
174
175
176
177
178
179
180
181
182
183
184
    // Standard pipeline operations
    virtual int RequestData( vtkInformation *request,
        vtkInformationVector **inputVector,
        vtkInformationVector *outputVector );
    virtual int FillOutputPortInformation( int port, vtkInformation *info );

    int NumberOfBlocks;

    int FilterLocation;
    double MinLocation[3];
    double MaxLocation[3];

185
    int Frequency;
186
187
    vtkMultiProcessController *Controller;

George Zagaris's avatar
George Zagaris committed
188
    bool  InitialRequest;
189
190
191
    bool  Initialized;
    char *FileName;

192
193
194
195
196
197
  private:
    vtkAMRBaseParticlesReader( const vtkAMRBaseParticlesReader& ); // Not implemented
    void operator=(const vtkAMRBaseParticlesReader& ); // Not implemented
};

#endif /* VTKAMRBASEPARTICLESREADER_H_ */