PISM, A Parallel Ice Sheet Model  stable v2.1-1-g6902d5502 committed by Ed Bueler on 2023-12-20 08:38:27 -0800
GivenClimate.hh
Go to the documentation of this file.
1 // Copyright (C) 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 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 #ifndef _PSGIVEN_H_
20 #define _PSGIVEN_H_
21 
22 #include "pism/coupler/SurfaceModel.hh"
23 
24 namespace pism {
25 namespace surface {
26 
27 class Given : public SurfaceModel {
28 public:
29  Given(std::shared_ptr<const Grid> g, std::shared_ptr<atmosphere::AtmosphereModel> input);
30  virtual ~Given() = default;
31 protected:
32  void init_impl(const Geometry &geometry);
33  void update_impl(const Geometry &geometry, double t, double dt);
34 
35  const array::Scalar &temperature_impl() const;
36  const array::Scalar &mass_flux_impl() const;
37 
38  const array::Scalar& accumulation_impl() const;
39  const array::Scalar& melt_impl() const;
40  const array::Scalar& runoff_impl() const;
41 
42  void define_model_state_impl(const File &output) const;
43  void write_model_state_impl(const File &output) const;
44 
45  std::shared_ptr<array::Forcing> m_mass_flux;
46  std::shared_ptr<array::Forcing> m_temperature;
47 };
48 
49 } // end of namespace surface
50 } // end of namespace pism
51 
52 #endif /* _PSGIVEN_H_ */
High-level PISM I/O class.
Definition: File.hh:56
const array::Scalar & accumulation_impl() const
const array::Scalar & melt_impl() const
const array::Scalar & runoff_impl() const
const array::Scalar & mass_flux_impl() const
Given(std::shared_ptr< const Grid > g, std::shared_ptr< atmosphere::AtmosphereModel > input)
Definition: GivenClimate.cc:29
std::shared_ptr< array::Forcing > m_temperature
Definition: GivenClimate.hh:46
void update_impl(const Geometry &geometry, double t, double dt)
Definition: GivenClimate.cc:90
void init_impl(const Geometry &geometry)
Definition: GivenClimate.cc:73
std::shared_ptr< array::Forcing > m_mass_flux
Definition: GivenClimate.hh:45
void write_model_state_impl(const File &output) const
The default (empty implementation).
const array::Scalar & temperature_impl() const
void define_model_state_impl(const File &output) const
The default (empty implementation).
virtual ~Given()=default
The interface of PISM's surface models.
Definition: SurfaceModel.hh:42
static const double g
Definition: exactTestP.cc:36