ticeModelVec3Custom.hh - pism - [fork] customized build of PISM, the parallel ice sheet model (tillflux branch)
HTML git clone git://src.adamsgaard.dk/pism
DIR Log
DIR Files
DIR Refs
DIR LICENSE
---
ticeModelVec3Custom.hh (1905B)
---
1 /* Copyright (C) 2013, 2014, 2015, 2016, 2019 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
20 #ifndef _ICEMODELVEC3CUSTOM_H_
21 #define _ICEMODELVEC3CUSTOM_H_
22
23 #include <memory>
24
25 #include "iceModelVec.hh"
26
27 namespace pism {
28
29 /**
30 * This class allows storing and saving 3D (or 2D with dof>1) data
31 * using *one* NetCDF variable. (Using a "custom" vertical grid.) It
32 * is used to store 3D velocity components on the scaled ("sigma")
33 * vertical grid by the BlatterStressBalance class and for latitude
34 * and longitude bounds by IceModel.
35 *
36 * @note DOF>1 2D data that should be stored in and read from several
37 * variables can be stored using IceModelVec2.
38 */
39 class IceModelVec3Custom : public IceModelVec3D {
40 public:
41 IceModelVec3Custom(IceGrid::ConstPtr mygrid,
42 const std::string &short_name,
43 const std::string &z_name,
44 const std::vector<double> &my_zlevels,
45 const std::map<std::string, std::string> &z_attrs);
46 virtual ~IceModelVec3Custom();
47
48 typedef std::shared_ptr<IceModelVec3Custom> Ptr;
49 typedef std::shared_ptr<const IceModelVec3Custom> ConstPtr;
50 };
51
52 } // end of namespace pism
53
54 #endif /* _ICEMODELVEC3CUSTOM_H_ */