PISM, A Parallel Ice Sheet Model 2.2.1-cd005eec8 committed by Constantine Khrulev on 2025-03-07
Loading...
Searching...
No Matches
NC4File.hh
Go to the documentation of this file.
1// Copyright (C) 2012, 2013, 2014, 2015, 2017, 2019, 2020, 2021, 2023, 2024 PISM Authors
2//
3// This file is part of PISM.
4//
5// PISM is free software; you can redistribute it and/or modify it under the
6// terms of the GNU General Public License as published by the Free Software
7// Foundation; either version 3 of the License, or (at your option) any later
8// version.
9//
10// PISM is distributed in the hope that it will be useful, but WITHOUT ANY
11// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12// FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13// details.
14//
15// You should have received a copy of the GNU General Public License
16// along with PISM; if not, write to the Free Software
17// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19#ifndef _PISMNC4FILE_H_
20#define _PISMNC4FILE_H_
21
22#include "pism/util/io/NCFile.hh"
23
24namespace pism {
25namespace io {
26
27class NC4File : public NCFile
28{
29public:
30 NC4File(MPI_Comm com, unsigned int compression_level);
31 virtual ~NC4File() = default;
32
33protected:
34 // implementations:
35 // open/create/close
36
37 virtual void sync_impl() const;
38
39 virtual void close_impl();
40
41 // redef/enddef
42 virtual void enddef_impl() const;
43
44 virtual void redef_impl() const;
45
46 // dim
47 virtual void def_dim_impl(const std::string &name, size_t length) const;
48
49 virtual void inq_dimid_impl(const std::string &dimension_name, bool &exists) const;
50
51 virtual void inq_dimlen_impl(const std::string &dimension_name, unsigned int &result) const;
52
53 virtual void inq_unlimdim_impl(std::string &result) const;
54
55 // var
56 virtual void def_var_chunking_impl(const std::string &name,
57 std::vector<size_t> &dimensions) const;
58
59 virtual void def_var_impl(const std::string &name,
60 io::Type nctype, const std::vector<std::string> &dims) const;
61
62 virtual void get_vara_double_impl(const std::string &variable_name,
63 const std::vector<unsigned int> &start,
64 const std::vector<unsigned int> &count,
65 double *ip) const;
66
67 virtual void put_vara_double_impl(const std::string &variable_name,
68 const std::vector<unsigned int> &start,
69 const std::vector<unsigned int> &count,
70 const double *op) const;
71
72 virtual void inq_nvars_impl(int &result) const;
73
74 virtual void inq_vardimid_impl(const std::string &variable_name, std::vector<std::string> &result) const;
75
76 virtual void inq_varnatts_impl(const std::string &variable_name, int &result) const;
77
78 virtual void inq_varid_impl(const std::string &variable_name, bool &exists) const;
79
80 virtual void inq_varname_impl(unsigned int j, std::string &result) const;
81
82 // att
83 virtual void get_att_double_impl(const std::string &variable_name, const std::string &att_name, std::vector<double> &result) const;
84
85 virtual void get_att_text_impl(const std::string &variable_name, const std::string &att_name, std::string &result) const;
86
87 virtual void put_att_double_impl(const std::string &variable_name, const std::string &att_name, io::Type xtype, const std::vector<double> &data) const;
88
89 virtual void put_att_text_impl(const std::string &variable_name, const std::string &att_name, const std::string &value) const;
90
91 virtual void inq_attname_impl(const std::string &variable_name, unsigned int n, std::string &result) const;
92
93 virtual void inq_atttype_impl(const std::string &variable_name, const std::string &att_name, io::Type &result) const;
94
95 // misc
96 virtual void set_fill_impl(int fillmode, int &old_modep) const;
97
98 virtual void del_att_impl(const std::string &variable_name, const std::string &att_name) const;
99protected:
100 virtual void set_access_mode(int varid) const;
101 virtual void get_put_var_double(const std::string &variable_name,
102 const std::vector<unsigned int> &start,
103 const std::vector<unsigned int> &count, double *ip,
104 bool get) const;
105
106 mutable unsigned int m_compression_level;
107
108 int get_varid(const std::string &variable_name) const;
109};
110
111} // end of namespace io
112} // end of namespace pism
113
114#endif /* _PISMNC4FILE_H_ */
virtual void get_att_double_impl(const std::string &variable_name, const std::string &att_name, std::vector< double > &result) const
Definition NC4File.cc:244
virtual void inq_attname_impl(const std::string &variable_name, unsigned int n, std::string &result) const
Definition NC4File.cc:361
virtual void inq_nvars_impl(int &result) const
Definition NC4File.cc:177
virtual void get_put_var_double(const std::string &variable_name, const std::vector< unsigned int > &start, const std::vector< unsigned int > &count, double *ip, bool get) const
Definition NC4File.cc:396
virtual void put_att_double_impl(const std::string &variable_name, const std::string &att_name, io::Type xtype, const std::vector< double > &data) const
Definition NC4File.cc:344
virtual void get_att_text_impl(const std::string &variable_name, const std::string &att_name, std::string &result) const
Definition NC4File.cc:317
virtual void close_impl()
Definition NC4File.cc:54
virtual void inq_varid_impl(const std::string &variable_name, bool &exists) const
Definition NC4File.cc:225
virtual void sync_impl() const
Definition NC4File.cc:49
virtual void inq_dimid_impl(const std::string &dimension_name, bool &exists) const
Definition NC4File.cc:77
virtual void enddef_impl() const
Definition NC4File.cc:61
virtual void inq_unlimdim_impl(std::string &result) const
Definition NC4File.cc:101
unsigned int m_compression_level
Definition NC4File.hh:106
virtual void def_var_chunking_impl(const std::string &name, std::vector< size_t > &dimensions) const
Definition NC4File.cc:147
virtual void redef_impl() const
Definition NC4File.cc:65
virtual void inq_dimlen_impl(const std::string &dimension_name, unsigned int &result) const
Definition NC4File.cc:89
virtual void del_att_impl(const std::string &variable_name, const std::string &att_name) const
Definition NC4File.cc:339
virtual void set_access_mode(int varid) const
Definition NC4File.cc:392
virtual void put_att_text_impl(const std::string &variable_name, const std::string &att_name, const std::string &value) const
Definition NC4File.cc:353
virtual ~NC4File()=default
virtual void def_dim_impl(const std::string &name, size_t length) const
Definition NC4File.cc:70
virtual void inq_vardimid_impl(const std::string &variable_name, std::vector< std::string > &result) const
Definition NC4File.cc:181
virtual void set_fill_impl(int fillmode, int &old_modep) const
Definition NC4File.cc:388
virtual void def_var_impl(const std::string &name, io::Type nctype, const std::vector< std::string > &dims) const
Definition NC4File.cc:117
virtual void put_vara_double_impl(const std::string &variable_name, const std::vector< unsigned int > &start, const std::vector< unsigned int > &count, const double *op) const
Definition NC4File.cc:167
int get_varid(const std::string &variable_name) const
Definition NC4File.cc:208
virtual void inq_varname_impl(unsigned int j, std::string &result) const
Definition NC4File.cc:233
virtual void get_vara_double_impl(const std::string &variable_name, const std::vector< unsigned int > &start, const std::vector< unsigned int > &count, double *ip) const
Definition NC4File.cc:158
virtual void inq_atttype_impl(const std::string &variable_name, const std::string &att_name, io::Type &result) const
Definition NC4File.cc:371
virtual void inq_varnatts_impl(const std::string &variable_name, int &result) const
Definition NC4File.cc:220
The PISM wrapper for a subset of the NetCDF C API.
Definition NCFile.hh:59
#define n
Definition exactTestM.c:37
int count
Definition test_cube.c:16