Chaste  Release::2018.1
Hdf5DataReader.hpp
1 /*
2 
3 Copyright (c) 2005-2018, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef HDF5DATAREADER_HPP_
37 #define HDF5DATAREADER_HPP_
38 
39 #include <petscvec.h>
40 #include <vector>
41 #include <map>
42 
43 #include "AbstractHdf5Access.hpp"
44 
51 {
52 private:
53 
58  std::vector<std::string> mVariableNames;
59  std::map<std::string, unsigned> mVariableToColumnIndex;
60  std::map<std::string, std::string> mVariableToUnit;
62  bool mClosed;
67  void CommonConstructor();
68 
69 public:
70 
80  Hdf5DataReader(const std::string& rDirectory,
81  const std::string& rBaseName,
82  bool makeAbsolute=true,
83  std::string datasetName="Data");
84 
92  Hdf5DataReader(const FileFinder& rDirectory,
93  const std::string& rBaseName,
94  std::string datasetName="Data");
95 
102  std::vector<double> GetVariableOverTime(const std::string& rVariableName,
103  unsigned nodeIndex);
104 
112  std::vector<std::vector<double> > GetVariableOverTimeOverMultipleNodes(const std::string& rVariableName,
113  unsigned lowerIndex,
114  unsigned upperIndex);
115 
123  void GetVariableOverNodes(Vec data, const std::string& rVariableName, unsigned timestep=0);
124 
128  std::vector<double> GetUnlimitedDimensionValues();
129 
133  unsigned GetNumberOfRows();
134 
138  std::vector<std::string> GetVariableNames();
139 
145  std::string GetUnit(const std::string& rVariableName);
146 
150  void Close();
151 
155  ~Hdf5DataReader();
156 };
157 
158 #endif /*HDF5DATAREADER_HPP_*/
hsize_t mNumberTimesteps
unsigned GetNumberOfRows()
std::string GetUnit(const std::string &rVariableName)
void CommonConstructor()
void GetVariableOverNodes(Vec data, const std::string &rVariableName, unsigned timestep=0)
std::map< std::string, unsigned > mVariableToColumnIndex
std::vector< std::vector< double > > GetVariableOverTimeOverMultipleNodes(const std::string &rVariableName, unsigned lowerIndex, unsigned upperIndex)
std::vector< std::string > mVariableNames
std::vector< double > GetUnlimitedDimensionValues()
Hdf5DataReader(const std::string &rDirectory, const std::string &rBaseName, bool makeAbsolute=true, std::string datasetName="Data")
std::vector< double > GetVariableOverTime(const std::string &rVariableName, unsigned nodeIndex)
std::map< std::string, std::string > mVariableToUnit
unsigned mVariablesDatasetRank
std::vector< std::string > GetVariableNames()