[591] | 1 | #ifndef __XIOS_INETCDF4__ |
---|
| 2 | #define __XIOS_INETCDF4__ |
---|
[219] | 3 | |
---|
[591] | 4 | /// XIOS headers /// |
---|
| 5 | #include "xios_spl.hpp" |
---|
[219] | 6 | #include "exception.hpp" |
---|
[369] | 7 | #include "array_new.hpp" |
---|
[219] | 8 | |
---|
[382] | 9 | #include "mpi.hpp" |
---|
| 10 | #include "netcdf.hpp" |
---|
[219] | 11 | |
---|
| 12 | #ifndef UNLIMITED_DIM |
---|
[599] | 13 | #define UNLIMITED_DIM (size_t)(-1) |
---|
| 14 | #endif // UNLIMITED_DIM |
---|
[219] | 15 | |
---|
[335] | 16 | namespace xios |
---|
[219] | 17 | { |
---|
[599] | 18 | typedef std::vector<StdString> CVarPath; |
---|
[219] | 19 | |
---|
[599] | 20 | class CINetCDF4 |
---|
| 21 | { |
---|
| 22 | public: |
---|
| 23 | /// Constructors /// |
---|
| 24 | CINetCDF4(const StdString& filename, const MPI_Comm* comm = NULL, bool multifile = true); |
---|
| 25 | CINetCDF4(const CINetCDF4& inetcdf4); // Not implemented. |
---|
| 26 | CINetCDF4(const CINetCDF4* const inetcdf4); // Not implemented. |
---|
[219] | 27 | |
---|
[599] | 28 | //------------------------------------------------------------- |
---|
[219] | 29 | |
---|
[599] | 30 | /// Destructor /// |
---|
| 31 | virtual ~CINetCDF4(void); |
---|
[219] | 32 | |
---|
[599] | 33 | //------------------------------------------------------------- |
---|
[219] | 34 | |
---|
[599] | 35 | void close(void); |
---|
[219] | 36 | |
---|
[599] | 37 | //------------------------------------------------------------- |
---|
[219] | 38 | |
---|
[599] | 39 | /// Getters /// |
---|
| 40 | StdSize getNbOfTimestep(const CVarPath* const path = NULL); |
---|
[219] | 41 | |
---|
[599] | 42 | StdString getUnlimitedDimensionName(const CVarPath* const path = NULL); |
---|
[219] | 43 | |
---|
[599] | 44 | StdString getCoordinatesId(const StdString& name, const CVarPath* const path = NULL); |
---|
[219] | 45 | |
---|
[599] | 46 | StdString getBoundsId(const StdString& name, const CVarPath* const path = NULL); |
---|
[219] | 47 | |
---|
[599] | 48 | StdString getLonCoordName(const StdString& varname, const CVarPath* const path = NULL); |
---|
| 49 | StdString getLatCoordName(const StdString& varname, const CVarPath* const path = NULL); |
---|
| 50 | StdString getVertCoordName(const StdString& varname, const CVarPath* const path = NULL); |
---|
[219] | 51 | |
---|
[599] | 52 | std::set<StdString> getCoordVariables(const CVarPath* const path = NULL); |
---|
| 53 | std::set<StdString> getBoundVariables(const CVarPath* const path = NULL); |
---|
[219] | 54 | |
---|
[599] | 55 | std::list<StdString> getGroups (const CVarPath* const path = NULL); |
---|
| 56 | std::list<StdString> getVariables(const CVarPath* const path = NULL); |
---|
[219] | 57 | |
---|
[599] | 58 | std::list<StdString> getDataVariables(bool _is3D = true, |
---|
| 59 | bool _isRecti = true, |
---|
| 60 | bool _isCurvi = true, |
---|
| 61 | bool _isUnstr = true, |
---|
| 62 | bool _isCellData = true, |
---|
| 63 | bool _isTemporal = true, |
---|
| 64 | const CVarPath* const path = NULL); |
---|
[219] | 65 | |
---|
[599] | 66 | std::list<StdString> getAttributes(const StdString* const var = NULL, |
---|
| 67 | const CVarPath* const path = NULL); |
---|
[219] | 68 | |
---|
[599] | 69 | std::list<StdString> getDimensionsList(const StdString* const var = NULL, |
---|
| 70 | const CVarPath* const path = NULL); |
---|
[219] | 71 | |
---|
[599] | 72 | std::list<StdString> getCoordinatesIdList(const StdString& name, |
---|
| 73 | const CVarPath* const path = NULL); |
---|
[219] | 74 | |
---|
[599] | 75 | std::map<StdString, StdSize> getDimensions(const StdString* const var = NULL, |
---|
| 76 | const CVarPath* const path = NULL); |
---|
[219] | 77 | |
---|
[599] | 78 | StdSize getNbVertex(const StdString& name, const CVarPath* const path = NULL); |
---|
[219] | 79 | |
---|
[599] | 80 | //------------------------------------------------------------- |
---|
[219] | 81 | |
---|
[599] | 82 | template <class T> |
---|
| 83 | T getMissingValue(const StdString& name, const CVarPath* const path = NULL); |
---|
[219] | 84 | |
---|
[599] | 85 | template <class T> |
---|
[686] | 86 | std::vector<T> getAttributeValue(const StdString& name, |
---|
| 87 | const StdString* const var = NULL, |
---|
| 88 | const CVarPath* const path = NULL); |
---|
[219] | 89 | |
---|
[686] | 90 | StdString getAttributeValue(const StdString& name, |
---|
| 91 | const StdString* const var, |
---|
| 92 | const CVarPath* const path); |
---|
| 93 | |
---|
[599] | 94 | template <class T> |
---|
| 95 | void getData(CArray<T, 1>& data, |
---|
| 96 | const StdString& var, |
---|
| 97 | const CVarPath* const path = NULL, |
---|
| 98 | StdSize record = UNLIMITED_DIM); |
---|
[219] | 99 | |
---|
[599] | 100 | template <class T> |
---|
| 101 | void getData(CArray<T, 1>& data, const StdString& var, |
---|
| 102 | bool collective, StdSize record, |
---|
| 103 | const std::vector<StdSize>* start = NULL, |
---|
| 104 | const std::vector<StdSize>* count = NULL); |
---|
[219] | 105 | |
---|
[599] | 106 | //------------------------------------------------------------- |
---|
[219] | 107 | |
---|
[599] | 108 | /// Tests /// |
---|
| 109 | bool hasMissingValue(const StdString& name, const CVarPath* const path = NULL); |
---|
[219] | 110 | |
---|
[599] | 111 | bool hasAttribute(const StdString& name, const StdString* const var = NULL, const CVarPath* const path = NULL); |
---|
[219] | 112 | |
---|
[599] | 113 | bool hasVariable(const StdString& name, const CVarPath* const path = NULL); |
---|
[219] | 114 | |
---|
[599] | 115 | bool hasCoordinates(const StdString& name, const CVarPath* const path = NULL); |
---|
[219] | 116 | |
---|
[599] | 117 | bool hasTemporalDim(const CVarPath* const path = NULL); |
---|
[219] | 118 | |
---|
[599] | 119 | bool hasBounds(const StdString& name, const CVarPath* const path = NULL); |
---|
[219] | 120 | |
---|
[599] | 121 | //------------------------------------------------------------- |
---|
[219] | 122 | |
---|
[599] | 123 | bool isBound(const StdString& name, const CVarPath* const path = NULL); |
---|
| 124 | bool isCoordinate(const StdString& name, const CVarPath* const path = NULL); |
---|
| 125 | bool isRectilinear(const StdString& name, const CVarPath* const path = NULL); |
---|
| 126 | bool isCurvilinear(const StdString& name, const CVarPath* const path = NULL); |
---|
| 127 | bool isUnknown(const StdString& name, const CVarPath* const path = NULL); |
---|
| 128 | bool isUnstructured(const StdString& name, const CVarPath* const path = NULL); |
---|
[219] | 129 | |
---|
[599] | 130 | bool isTemporal(const StdString& name, const CVarPath* const path = NULL); |
---|
| 131 | bool is3Dim(const StdString& name, const CVarPath* const path = NULL); |
---|
| 132 | bool isCellGrid(const StdString& name, const CVarPath* const path = NULL); |
---|
[219] | 133 | |
---|
[599] | 134 | protected: |
---|
| 135 | /// Getters /// |
---|
| 136 | int getGroup (const CVarPath* const path = NULL); |
---|
| 137 | int getVariable(const StdString& varname, const CVarPath* const path = NULL); |
---|
| 138 | int getDimension(const StdString& dimname, const CVarPath* const path = NULL); |
---|
| 139 | int getUnlimitedDimension(const CVarPath* const path = NULL); |
---|
| 140 | int getAttributeId(const StdString& name, |
---|
| 141 | const StdString* const var = NULL, |
---|
| 142 | const CVarPath* const path = NULL); |
---|
[219] | 143 | |
---|
[599] | 144 | std::pair<nc_type , StdSize> getAttribute(const StdString& attname, |
---|
| 145 | const StdString* const var = NULL, |
---|
| 146 | const CVarPath* const path = NULL); |
---|
[219] | 147 | |
---|
[599] | 148 | //------------------------------------------------------------- |
---|
[219] | 149 | |
---|
[599] | 150 | void getDataInfo(const StdString& var, const CVarPath* const path, StdSize record, |
---|
| 151 | std::vector<StdSize>& sstart, std::vector<StdSize>& scount, StdSize& array_size, |
---|
| 152 | const std::vector<StdSize>* start = NULL, const std::vector<StdSize>* count = NULL); |
---|
[219] | 153 | |
---|
[599] | 154 | private: |
---|
[686] | 155 | int ncidp; //< Id of the NetCDF file |
---|
| 156 | bool mpi; //< Whether parallel file access is used |
---|
[599] | 157 | }; // class CINetCDF4 |
---|
[591] | 158 | } // namespace xios |
---|
[219] | 159 | |
---|
[591] | 160 | #endif //__XIOS_INETCDF4__ |
---|