VTK
vtkAMREnzoReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAMREnzoReader.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  =========================================================================*/
26 #ifndef vtkAMREnzoReader_h
27 #define vtkAMREnzoReader_h
28 
29 #include "vtkIOAMRModule.h" // For export macro
30 #include "vtkAMRBaseReader.h"
31 
32 #include <map> // For STL map
33 #include <string> // For std::string
34 
35 class vtkOverlappingAMR;
37 
38 class VTKIOAMR_EXPORT vtkAMREnzoReader : public vtkAMRBaseReader
39 {
40 public:
41  static vtkAMREnzoReader* New();
43  void PrintSelf(ostream &os, vtkIndent indent ) override;
44 
46 
49  vtkSetMacro( ConvertToCGS, vtkTypeBool );
50  vtkGetMacro( ConvertToCGS, vtkTypeBool );
51  vtkBooleanMacro( ConvertToCGS, vtkTypeBool );
53 
57  int GetNumberOfBlocks() override;
58 
62  int GetNumberOfLevels() override;
63 
67  void SetFileName( const char* fileName ) override;
68 
69 protected:
71  ~vtkAMREnzoReader() override;
72 
79 
85 
90  void ParseLabel(const std::string &labelString, int &idx, std::string &label);
91 
96  void ParseCFactor(const std::string &labelString, int &idx, double &factor );
97 
104 
108  void ReadMetaData() override;
109 
113  int GetBlockLevel( const int blockIdx ) override;
114 
115  void ComputeStats(vtkEnzoReaderInternal* internal, std::vector<int>& blocksPerLevel, double min[3]);
116 
120  int FillMetaData( ) override;
121 
125  vtkUniformGrid* GetAMRGrid( const int blockIdx ) override;
126 
131  const int blockIdx, vtkUniformGrid *block, const char *field) override;
132 
137  const int vtkNotUsed(blockIdx), vtkUniformGrid *vtkNotUsed(block), const char *vtkNotUsed(field)) override {;};
138 
142  void SetUpDataArraySelections() override;
143 
145  bool IsReady;
146 
147 private:
148  vtkAMREnzoReader( const vtkAMREnzoReader& ) = delete;
149  void operator=(const vtkAMREnzoReader& ) = delete;
150 
151  vtkEnzoReaderInternal *Internal;
152 
153  std::map< std::string, int > label2idx;
154  std::map< int, double > conversionFactors;
155 };
156 
157 #endif /* vtkAMREnzoReader_h */
vtkAMREnzoReader::vtkAMREnzoReader
vtkAMREnzoReader()
vtkAMREnzoReader::SetFileName
void SetFileName(const char *fileName) override
See vtkAMRBaseReader::SetFileName.
vtkAMREnzoReader::~vtkAMREnzoReader
~vtkAMREnzoReader() override
vtkAMREnzoReader::ParseCFactor
void ParseCFactor(const std::string &labelString, int &idx, double &factor)
Given the label string, this method parses the corresponding attribute index and conversion factor.
vtkAMREnzoReader::SetUpDataArraySelections
void SetUpDataArraySelections() override
See vtkAMRBaseReader::SetUpDataArraySelections.
vtkUniformGrid
image data with blanking
Definition: vtkUniformGrid.h:41
vtkEnzoReaderInternal
Definition: vtkAMREnzoReaderInternal.h:113
vtkAMREnzoReader::ComputeStats
void ComputeStats(vtkEnzoReaderInternal *internal, std::vector< int > &blocksPerLevel, double min[3])
vtkAMREnzoReader::GetBlockLevel
int GetBlockLevel(const int blockIdx) override
See vtkAMRBaseReader::GetBlockLevel.
vtkAMREnzoReader::GetAMRGrid
vtkUniformGrid * GetAMRGrid(const int blockIdx) override
See vtkAMRBaseReader::GetAMRGrid.
vtkAMREnzoReader::IsReady
bool IsReady
Definition: vtkAMREnzoReader.h:145
vtkAMREnzoReader::GetAMRGridPointData
void GetAMRGridPointData(const int vtkNotUsed(blockIdx), vtkUniformGrid *vtkNotUsed(block), const char *vtkNotUsed(field)) override
See vtkAMRBaseReader::GetAMRGridData.
Definition: vtkAMREnzoReader.h:136
vtkAMRBaseReader
An abstract class that encapsulates common functionality for all AMR readers.
Definition: vtkAMRBaseReader.h:43
vtkAMREnzoReader::GetIndexFromArrayName
int GetIndexFromArrayName(std::string arrayName)
Given an array name of the form "array[idx]" this method extracts and returns the corresponding index...
vtkAMREnzoReader::ConvertToCGS
vtkTypeBool ConvertToCGS
Definition: vtkAMREnzoReader.h:144
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkAMREnzoReader::GetAMRGridData
void GetAMRGridData(const int blockIdx, vtkUniformGrid *block, const char *field) override
See vtkAMRBaseReader::GetAMRGridData.
vtkX3D::field
@ field
Definition: vtkX3D.h:177
vtkAMREnzoReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkOverlappingAMR
hierarchical dataset of vtkUniformGrids
Definition: vtkOverlappingAMR.h:47
vtkAMREnzoReader::GetConversionFactor
double GetConversionFactor(const std::string &name)
Given the variable name, return the conversion factor used to convert the data to CGS.
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkAMREnzoReader::FillMetaData
int FillMetaData() override
See vtkAMRBaseReader::FillMetaData.
vtkX3D::string
@ string
Definition: vtkX3D.h:490
vtkAMREnzoReader::ParseLabel
void ParseLabel(const std::string &labelString, int &idx, std::string &label)
Given the label string, this method parses the attribute label and the string index.
vtkAMREnzoReader::GetNumberOfLevels
int GetNumberOfLevels() override
See vtkAMRBaseReader::GetNumberOfLevels.
vtkAMREnzoReader::ParseConversionFactors
void ParseConversionFactors()
Parses the parameters file and extracts the conversion factors that are used to convert to CGS units.
vtkAMREnzoReader::GetNumberOfBlocks
int GetNumberOfBlocks() override
See vtkAMRBaseReader::GetNumberOfBlocks.
vtkAMREnzoReader::New
static vtkAMREnzoReader * New()
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkAMRBaseReader.h
vtkAMREnzoReader::ReadMetaData
void ReadMetaData() override
See vtkAMRBaseReader::ReadMetaData.
vtkAMREnzoReader
A concrete instance of vtkAMRBaseReader that implements functionality for reading Enzo AMR datasets.
Definition: vtkAMREnzoReader.h:39