SurfaceModel.hh

Go to the documentation of this file.

// Copyright (C) 2008-2018, 2021, 2023 Ed Bueler, Constantine Khroulev, Ricarda Winkelmann,
// Gudfinna Adalgeirsdottir and Andy Aschwanden
//
// This file is part of PISM.
//
// PISM is free software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the Free Software
// Foundation; either version 3 of the License, or (at your option) any later
// version.
//
// PISM is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
//
// You should have received a copy of the GNU General Public License
// along with PISM; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
#ifndef __PISMSurfaceModel_hh
#define __PISMSurfaceModel_hh
 
/*!
 * This file should contain the class definition and nothing else.
 * Implementations should go in separate files.
 */
 
#include "pism/util/Component.hh"
 
namespace pism {
 
namespace atmosphere {
class AtmosphereModel;
}
 
//! @brief Surface models and modifiers: provide top-surface
//! temperature, mass flux, liquid water fraction, mass and thickness of the surface
//! layer.
namespace surface {
 
//! \brief The interface of PISM's surface models.
class SurfaceModel : public Component {
public:
  SurfaceModel(std::shared_ptr<const Grid> g);
  SurfaceModel(std::shared_ptr<const Grid> g, std::shared_ptr<SurfaceModel> input);
  SurfaceModel(std::shared_ptr<const Grid> g, std::shared_ptr<atmosphere::AtmosphereModel> atmosphere);
 
  virtual ~SurfaceModel() = default;
 
  void init(const Geometry &geometry);
 
  // the interface:
  void update(const Geometry &geometry, double t, double dt);
 
  const array::Scalar& accumulation() const;
  const array::Scalar& layer_mass() const;
  const array::Scalar& layer_thickness() const;
  const array::Scalar& liquid_water_fraction() const;
  const array::Scalar& mass_flux() const;
  const array::Scalar& melt() const;
  const array::Scalar& runoff() const;
  const array::Scalar& temperature() const;
  
protected:
 
  virtual const array::Scalar& accumulation_impl() const;
  virtual const array::Scalar& layer_mass_impl() const;
  virtual const array::Scalar& layer_thickness_impl() const;
  virtual const array::Scalar& liquid_water_fraction_impl() const;
  virtual const array::Scalar& mass_flux_impl() const;
  virtual const array::Scalar& melt_impl() const;
  virtual const array::Scalar& runoff_impl() const;
  virtual const array::Scalar& temperature_impl() const;
 
  virtual void init_impl(const Geometry &geometry);
  virtual void update_impl(const Geometry &geometry, double t, double dt);
 
  virtual void define_model_state_impl(const File &output) const;
  virtual void write_model_state_impl(const File &output) const;
 
  virtual MaxTimestep max_timestep_impl(double my_t) const;
 
  virtual DiagnosticList diagnostics_impl() const;
  virtual TSDiagnosticList ts_diagnostics_impl() const;
 
  void dummy_accumulation(const array::Scalar& smb, array::Scalar& result);
  void dummy_melt(const array::Scalar& smb, array::Scalar& result);
  void dummy_runoff(const array::Scalar& smb, array::Scalar& result);
 
  static std::shared_ptr<array::Scalar> allocate_layer_mass(std::shared_ptr<const Grid> grid);
  static std::shared_ptr<array::Scalar> allocate_layer_thickness(std::shared_ptr<const Grid> grid);
  static std::shared_ptr<array::Scalar> allocate_liquid_water_fraction(std::shared_ptr<const Grid> grid);
  static std::shared_ptr<array::Scalar> allocate_mass_flux(std::shared_ptr<const Grid> grid);
  static std::shared_ptr<array::Scalar> allocate_temperature(std::shared_ptr<const Grid> grid);
  static std::shared_ptr<array::Scalar> allocate_accumulation(std::shared_ptr<const Grid> grid);
  static std::shared_ptr<array::Scalar> allocate_melt(std::shared_ptr<const Grid> grid);
  static std::shared_ptr<array::Scalar> allocate_runoff(std::shared_ptr<const Grid> grid);
 
 
  std::shared_ptr<array::Scalar> m_liquid_water_fraction;
  std::shared_ptr<array::Scalar> m_layer_mass;
  std::shared_ptr<array::Scalar> m_layer_thickness;
  std::shared_ptr<array::Scalar> m_accumulation;
  std::shared_ptr<array::Scalar> m_melt;
  std::shared_ptr<array::Scalar> m_runoff;
  
  std::shared_ptr<SurfaceModel> m_input_model;
  std::shared_ptr<atmosphere::AtmosphereModel> m_atmosphere;
};
 
} // end of namespace surface
} // end of namespace pism
 
#endif  // __PISMSurfaceModel_hh