PISM, A Parallel Ice Sheet Model  stable v2.1-1-g6902d5502 committed by Ed Bueler on 2023-12-20 08:38:27 -0800
Grid_Regional.hh
Go to the documentation of this file.
1 /* Copyright (C) 2015, 2020, 2023 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 _ICEGRID_REGIONAL_H_
21 #define _ICEGRID_REGIONAL_H_
22 
23 namespace pism {
24 
25 /**
26  * Select a subset of the computational grid in an input file.
27  *
28  * @param ctx execution context
29  *
30  * @return A pointer to a new grid instance.
31  */
32 std::shared_ptr<Grid> regional_grid_from_options(std::shared_ptr<Context> ctx);
33 
34 } // end of namespace pism
35 
36 #endif /* _ICEGRID_REGIONAL_H_ */
std::shared_ptr< Grid > regional_grid_from_options(std::shared_ptr< Context > ctx)
Create a grid using command-line options and (possibly) an input file.