PISM, A Parallel Ice Sheet Model  stable v2.1-1-g6902d5502 committed by Ed Bueler on 2023-12-20 08:38:27 -0800
Initialization.hh
Go to the documentation of this file.
1 /* Copyright (C) 2016, 2017, 2018, 2021, 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 POINITIALIZATION_H
21 #define POINITIALIZATION_H
22 
23 #include "pism/coupler/OceanModel.hh"
24 
25 namespace pism {
26 namespace ocean {
27 
28 /*! Ocean model "modifier" that helps with initialization.
29  *
30  * This modifier saves *all* fields a ocean model provides as a part of the model state and re-loads
31  * them during initialization so that they are available *before* the first time step in a
32  * re-started run.
33  *
34  * It is
35  *
36  * - not visible to the user,
37  * - is added automatically, and
38  * - does not have a corresponding "keyword" in ocean::Factory.
39  */
41 public:
42  InitializationHelper(std::shared_ptr<const Grid> g, std::shared_ptr<OceanModel> in);
43 
44 private:
45  void define_model_state_impl(const File &output) const;
46  void write_model_state_impl(const File &output) const;
47 
48  void update_impl(const Geometry &geometry, double t, double dt);
49  void init_impl(const Geometry &geometry);
50 
54 
55  // storage for average_water_column_pressure is inherited from OceanModel
56  std::shared_ptr<array::Scalar> m_shelf_base_temperature;
57  std::shared_ptr<array::Scalar> m_shelf_base_mass_flux;
58 };
59 
60 } // end of namespace ocean
61 } // end of namespace pism
62 
63 #endif /* POINITIALIZATION_H */
High-level PISM I/O class.
Definition: File.hh:56
const array::Scalar & shelf_base_mass_flux_impl() const
const array::Scalar & average_water_column_pressure_impl() const
void update_impl(const Geometry &geometry, double t, double dt)
std::shared_ptr< array::Scalar > m_shelf_base_mass_flux
void write_model_state_impl(const File &output) const
The default (empty implementation).
void init_impl(const Geometry &geometry)
void define_model_state_impl(const File &output) const
The default (empty implementation).
InitializationHelper(std::shared_ptr< const Grid > g, std::shared_ptr< OceanModel > in)
const array::Scalar & shelf_base_temperature_impl() const
std::shared_ptr< array::Scalar > m_shelf_base_temperature
A very rudimentary PISM ocean model.
Definition: OceanModel.hh:33
bool ocean(int M)
An ocean cell (floating ice or ice-free).
Definition: Mask.hh:40
static const double g
Definition: exactTestP.cc:36