PISM, A Parallel Ice Sheet Model  stable v2.1-1-g6902d5502 committed by Ed Bueler on 2023-12-20 08:38:27 -0800
ConstantPIK.hh
Go to the documentation of this file.
1 // Copyright (C) 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 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 #ifndef _PSCONSTANTPIK_H_
20 #define _PSCONSTANTPIK_H_
21 
22 #include "pism/coupler/SurfaceModel.hh"
23 
24 namespace pism {
25 namespace surface {
26 
27 //! \brief A class implementing a constant-in-time surface model for the surface mass balance.
28 //!
29 //! Reads data from a PISM input file.
30 //!
31 //! Ice surface temperature is parameterized as in PISM-PIK, using a latitude
32 //! and surface elevation-dependent formula.
33 
34 class PIK : public SurfaceModel {
35 public:
36  PIK(std::shared_ptr<const Grid> g, std::shared_ptr<atmosphere::AtmosphereModel> atmosphere);
37 protected:
38  void init_impl(const Geometry &geometry);
39  void update_impl(const Geometry &geometry, double t, double dt);
40 
41  const array::Scalar& mass_flux_impl() const;
42  const array::Scalar& temperature_impl() const;
43 
44  const array::Scalar& accumulation_impl() const;
45  const array::Scalar& melt_impl() const;
46  const array::Scalar& runoff_impl() const;
47 
48  void define_model_state_impl(const File &output) const;
49  void write_model_state_impl(const File &output) const;
50 
51  MaxTimestep max_timestep_impl(double t) const;
52 
53 protected:
54  std::shared_ptr<array::Scalar> m_mass_flux;
55  std::shared_ptr<array::Scalar> m_temperature;
56 };
57 
58 } // end of namespace surface
59 } // end of namespace pism
60 
61 #endif /* _PSCONSTANTPIK_H_ */
High-level PISM I/O class.
Definition: File.hh:56
Combines the max. time step with the flag indicating if a restriction is active. Makes is possible to...
Definition: MaxTimestep.hh:31
MaxTimestep max_timestep_impl(double t) const
Definition: ConstantPIK.cc:68
std::shared_ptr< array::Scalar > m_temperature
Definition: ConstantPIK.hh:55
const array::Scalar & mass_flux_impl() const
Definition: ConstantPIK.cc:94
const array::Scalar & runoff_impl() const
Definition: ConstantPIK.cc:110
const array::Scalar & temperature_impl() const
Definition: ConstantPIK.cc:98
const array::Scalar & accumulation_impl() const
Definition: ConstantPIK.cc:102
PIK(std::shared_ptr< const Grid > g, std::shared_ptr< atmosphere::AtmosphereModel > atmosphere)
Definition: ConstantPIK.cc:34
void write_model_state_impl(const File &output) const
The default (empty implementation).
Definition: ConstantPIK.cc:119
void define_model_state_impl(const File &output) const
The default (empty implementation).
Definition: ConstantPIK.cc:114
const array::Scalar & melt_impl() const
Definition: ConstantPIK.cc:106
void update_impl(const Geometry &geometry, double t, double dt)
Definition: ConstantPIK.cc:73
std::shared_ptr< array::Scalar > m_mass_flux
Definition: ConstantPIK.hh:54
void init_impl(const Geometry &geometry)
Definition: ConstantPIK.cc:42
A class implementing a constant-in-time surface model for the surface mass balance.
Definition: ConstantPIK.hh:34
The interface of PISM's surface models.
Definition: SurfaceModel.hh:42
static const double g
Definition: exactTestP.cc:36