SeaLevel.hh

Go to the documentation of this file.

/* Copyright (C) 2018, 2021, 2025 PISM Authors
 *
 * 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 SEALEVEL_H
#define SEALEVEL_H
 
#include "pism/util/Component.hh"
 
namespace pism {
 
class Geometry;
 
namespace ocean {
namespace sea_level {
 
class SeaLevel : public Component {
public:
  // "modifier" constructor
  SeaLevel(std::shared_ptr<const Grid> g, std::shared_ptr<SeaLevel> input);
  // "model" constructor
  SeaLevel(std::shared_ptr<const Grid> g);
 
  virtual ~SeaLevel() = default;
 
  void init(const Geometry &geometry);
 
  void update(const Geometry &geometry, double t, double dt);
 
  const array::Scalar& elevation() const;
 
protected:
  virtual void init_impl(const Geometry &geometry);
 
  virtual void update_impl(const Geometry &geometry, double t, double dt);
 
  virtual MaxTimestep max_timestep_impl(double t) const;
 
  virtual std::set<VariableMetadata> state_impl() const;
  virtual void write_state_impl(const OutputFile &output) const;
 
  virtual DiagnosticList spatial_diagnostics_impl() const;
  virtual TSDiagnosticList scalar_diagnostics_impl() const;
 
protected:
  std::shared_ptr<SeaLevel> m_input_model;
  array::Scalar m_sea_level;
};
 
} // end of namespace sea_level
} // end of namespace ocean
} // end of namespace pism
 
#endif /* SEALEVEL_H */