diagnostics.cc

Go to the documentation of this file.

// Copyright (C) 2010--2023 Constantine Khroulev
//
// 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
 
#include <algorithm>
#include <cassert>
#include <memory>
 
#include "pism/age/AgeModel.hh"
#include "pism/energy/EnergyModel.hh"
#include "pism/energy/utilities.hh"
#include "pism/geometry/grounded_cell_fraction.hh"
#include "pism/geometry/part_grid_threshold_thickness.hh"
#include "pism/icemodel/IceModel.hh"
#include "pism/rheology/FlowLaw.hh"
#include "pism/stressbalance/SSB_Modifier.hh"
#include "pism/stressbalance/ShallowStressBalance.hh"
#include "pism/stressbalance/StressBalance.hh"
#include "pism/util/Diagnostic.hh"
#include "pism/util/EnthalpyConverter.hh"
#include "pism/util/error_handling.hh"
#include "pism/util/pism_utilities.hh"
#include "pism/util/projection.hh"
 
#if (Pism_USE_PROJ == 1)
#include "pism/util/Proj.hh"
#endif
 
// Flux balance code
namespace pism {
namespace diagnostics {
 
enum AmountKind { AMOUNT, MASS };
 
//! @brief Computes tendency_of_ice_amount, the ice amount rate of change.
class TendencyOfIceAmount : public Diag<IceModel> {
public:
  TendencyOfIceAmount(const IceModel *Model, AmountKind kind)
      : Diag<IceModel>(Model),
        m_kind(kind),
        m_last_amount(m_grid, "last_ice_amount"),
        m_interval_length(0.0) {
 
    std::string name = "tendency_of_ice_amount", long_name = "rate of change of the ice amount",
                internal_units = "kg m-2 second-1", external_units = "kg m-2 year-1";
    if (kind == MASS) {
      name           = "tendency_of_ice_mass";
      long_name      = "rate of change of the ice mass";
      internal_units = "kg second-1";
      external_units = "Gt year-1";
    }
 
    // set metadata:
    m_vars = { { m_sys, name } };
    m_vars[0].long_name(long_name).units(internal_units).output_units(external_units);
 
    auto large_number         = to_internal(1e6);
    m_vars[0]["valid_range"]  = { -large_number, large_number };
    m_vars[0]["_FillValue"]   = { to_internal(m_fill_value) };
    m_vars[0]["cell_methods"] = "time: mean";
 
    m_last_amount.metadata()
        .long_name("ice amount at the time of the last report of " + name)
        .units(internal_units + " second");
  }
 
protected:
  std::shared_ptr<array::Array> compute_impl() const {
 
    auto result        = std::make_shared<array::Scalar>(m_grid, "");
    result->metadata() = m_vars[0];
 
    if (m_interval_length > 0.0) {
      double ice_density = m_config->get_number("constants.ice.density");
 
      auto cell_area = m_grid->cell_area();
 
      const auto &thickness            = model->geometry().ice_thickness;
      const auto &area_specific_volume = model->geometry().ice_area_specific_volume;
 
      array::AccessScope list{ result.get(), &thickness, &area_specific_volume, &m_last_amount };
 
      for (auto p = m_grid->points(); p; p.next()) {
        const int i = p.i(), j = p.j();
 
        // m * (kg / m^3) = kg / m^2
        double amount = (thickness(i, j) + area_specific_volume(i, j)) * ice_density;
 
        (*result)(i, j) = (amount - m_last_amount(i, j)) / m_interval_length;
 
        if (m_kind == MASS) {
          // kg / m^2 * m^2 = kg
          (*result)(i, j) *= cell_area;
        }
      }
    } else {
      result->set(m_fill_value);
    }
 
    return result;
  }
 
  void reset_impl() {
    m_interval_length = 0.0;
 
    const array::Scalar &thickness            = model->geometry().ice_thickness;
    const array::Scalar &area_specific_volume = model->geometry().ice_area_specific_volume;
 
    double ice_density = m_config->get_number("constants.ice.density");
 
    array::AccessScope list{ &m_last_amount, &thickness, &area_specific_volume };
 
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      // m * (kg / m^3) = kg / m^2
      m_last_amount(i, j) = (thickness(i, j) + area_specific_volume(i, j)) * ice_density;
    }
  }
 
  void update_impl(double dt) {
    m_interval_length += dt;
  }
 
protected:
  AmountKind m_kind;
  array::Scalar m_last_amount;
  double m_interval_length;
};
 
//! @brief Computes tendency_of_ice_amount_due_to_flow, the rate of change of ice amount due to
//! flow.
/*! @brief Report rate of change of ice amount due to flow. */
class TendencyOfIceAmountDueToFlow : public DiagAverageRate<IceModel> {
public:
  TendencyOfIceAmountDueToFlow(const IceModel *Model, AmountKind kind)
      : DiagAverageRate<IceModel>(Model,
                                  kind == AMOUNT ? "tendency_of_ice_amount_due_to_flow" :
                                                   "tendency_of_ice_mass_due_to_flow",
                                  TOTAL_CHANGE),
        m_kind(kind) {
 
    std::string name              = "tendency_of_ice_amount_due_to_flow",
                long_name         = "rate of change of ice amount due to flow",
                accumulator_units = "kg m-2", internal_units = "kg m-2 second-1",
                external_units = "kg m-2 year-1";
 
    if (kind == MASS) {
      name              = "tendency_of_ice_mass_due_to_flow";
      long_name         = "rate of change of ice mass due to flow";
      accumulator_units = "kg";
      internal_units    = "kg second-1";
      external_units    = "Gt year-1";
    }
 
    m_factor = m_config->get_number("constants.ice.density");
 
    m_accumulator.metadata().units(accumulator_units);
 
    m_vars = { { m_sys, name } };
    m_vars[0].long_name(long_name).units(internal_units).output_units(external_units);
    m_vars[0]["cell_methods"] = "time: mean";
    m_vars[0]["_FillValue"]   = { to_internal(m_fill_value) };
    m_vars[0]["comment"]      = "positive flux corresponds to ice gain";
  }
 
protected:
  void update_impl(double dt) {
    const array::Scalar &dH = model->geometry_evolution().thickness_change_due_to_flow(),
                        &dV = model->geometry_evolution().area_specific_volume_change_due_to_flow();
 
    auto cell_area = m_grid->cell_area();
 
    array::AccessScope list{ &m_accumulator, &dH, &dV };
 
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      double C = m_factor * (m_kind == AMOUNT ? 1.0 : cell_area);
 
      m_accumulator(i, j) += C * (dH(i, j) + dV(i, j));
    }
 
    m_interval_length += dt;
  }
  AmountKind m_kind;
};
 
/*! @brief Report surface mass balance flux, averaged over the reporting interval */
class SurfaceFlux : public DiagAverageRate<IceModel> {
public:
  SurfaceFlux(const IceModel *m, AmountKind kind)
      : DiagAverageRate<IceModel>(m,
                                  kind == AMOUNT ?
                                      "tendency_of_ice_amount_due_to_surface_mass_flux" :
                                      "tendency_of_ice_mass_due_to_surface_mass_flux",
                                  TOTAL_CHANGE),
        m_kind(kind) {
    m_factor = m_config->get_number("constants.ice.density");
 
    auto ismip6 = m_config->get_flag("output.ISMIP6");
 
    std::string name = ismip6 ? "acabf" : "tendency_of_ice_amount_due_to_surface_mass_flux",
                accumulator_units = "kg m-2",
                long_name         = "average surface mass flux over reporting interval",
                standard_name     = "land_ice_surface_specific_mass_balance_flux",
                internal_units = "kg m-2 s-1", external_units = "kg m-2 year-1";
    if (kind == MASS) {
      name = "tendency_of_ice_mass_due_to_surface_mass_flux", accumulator_units = "kg",
      long_name = "average surface mass flux over reporting interval", standard_name = "",
      internal_units = "kg second-1", external_units = "Gt year-1";
    }
 
    m_accumulator.metadata()["units"] = accumulator_units;
 
    m_vars = { { m_sys, name } };
    m_vars[0]
        .long_name(long_name)
        .standard_name(standard_name)
        .units(internal_units)
        .output_units(external_units);
    m_vars[0]["_FillValue"]   = { to_internal(m_fill_value) };
    m_vars[0]["cell_methods"] = "time: mean";
    m_vars[0]["comment"]      = "positive flux corresponds to ice gain";
  }
 
protected:
  void update_impl(double dt) {
    const array::Scalar &SMB = model->geometry_evolution().top_surface_mass_balance();
 
    auto cell_area = m_grid->cell_area();
 
    array::AccessScope list{ &m_accumulator, &SMB };
 
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      double C = m_factor * (m_kind == AMOUNT ? 1.0 : cell_area);
 
      m_accumulator(i, j) += C * SMB(i, j);
    }
 
    m_interval_length += dt;
  }
  AmountKind m_kind;
};
 
/*! @brief Report basal mass balance flux, averaged over the reporting interval */
class BasalFlux : public DiagAverageRate<IceModel> {
public:
  BasalFlux(const IceModel *m, AmountKind kind)
      : DiagAverageRate<IceModel>(m,
                                  kind == AMOUNT ? "tendency_of_ice_amount_due_to_basal_mass_flux" :
                                                   "tendency_of_ice_mass_due_to_basal_mass_flux",
                                  TOTAL_CHANGE),
        m_kind(kind) {
    m_factor = m_config->get_number("constants.ice.density");
 
    std::string name              = "tendency_of_ice_amount_due_to_basal_mass_flux",
                accumulator_units = "kg m-2",
                long_name      = "average basal mass flux over reporting interval", standard_name,
                internal_units = "kg m-2 second-1", external_units = "kg m-2 year-1";
    if (kind == MASS) {
      name = "tendency_of_ice_mass_due_to_basal_mass_flux", accumulator_units = "kg",
      long_name      = "average basal mass flux over reporting interval",
      standard_name  = "tendency_of_land_ice_mass_due_to_basal_mass_balance",
      internal_units = "kg second-1", external_units = "Gt year-1";
    }
    m_accumulator.metadata()["units"] = accumulator_units;
 
    m_vars = { { m_sys, name } };
    m_vars[0]
        .long_name(long_name)
        .standard_name(standard_name)
        .units(internal_units)
        .output_units(external_units);
    m_vars[0]["_FillValue"]   = { to_internal(m_fill_value) };
    m_vars[0]["cell_methods"] = "time: mean";
    m_vars[0]["comment"]      = "positive flux corresponds to ice gain";
  }
 
protected:
  void update_impl(double dt) {
    const array::Scalar &BMB = model->geometry_evolution().bottom_surface_mass_balance();
 
    auto cell_area = m_grid->cell_area();
 
    array::AccessScope list{ &m_accumulator, &BMB };
 
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      double C = m_factor * (m_kind == AMOUNT ? 1.0 : cell_area);
 
      m_accumulator(i, j) += C * BMB(i, j);
    }
 
    m_interval_length += dt;
  }
  AmountKind m_kind;
};
 
class ConservationErrorFlux : public DiagAverageRate<IceModel> {
public:
  ConservationErrorFlux(const IceModel *m, AmountKind kind)
      : DiagAverageRate<IceModel>(m,
                                  kind == AMOUNT ?
                                      "tendency_of_ice_amount_due_to_conservation_error" :
                                      "tendency_of_ice_mass_due_to_conservation_error",
                                  TOTAL_CHANGE),
        m_kind(kind) {
    m_factor = m_config->get_number("constants.ice.density");
 
    std::string name              = "tendency_of_ice_amount_due_to_conservation_error",
                accumulator_units = "kg m-2",
                long_name         = "average mass conservation error flux over reporting interval",
                internal_units = "kg m-2 second-1", external_units = "kg m-2 year-1";
    if (kind == MASS) {
      name = "tendency_of_ice_mass_due_to_conservation_error", accumulator_units = "kg",
      long_name     = "average mass conservation error flux over reporting interval",
      internal_units = "kg second-1", external_units = "Gt year-1";
    }
 
    m_accumulator.metadata()["units"] = accumulator_units;
 
    m_vars = { { m_sys, name } };
    m_vars[0]
        .long_name(long_name)
        .units(internal_units)
        .output_units(external_units);
    m_vars[0]["_FillValue"] = {to_internal(m_fill_value)};
    m_vars[0]["cell_methods"] = "time: mean";
    m_vars[0]["comment"] = "positive flux corresponds to ice gain";
  }
 
protected:
  void update_impl(double dt) {
    const array::Scalar
      &error = model->geometry_evolution().conservation_error();
 
    array::AccessScope list{&m_accumulator, &error};
 
    auto cell_area = m_grid->cell_area();
 
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      double C = m_factor * (m_kind == AMOUNT ? 1.0 : cell_area);
 
      m_accumulator(i, j) += C * error(i, j);
    }
 
    m_interval_length += dt;
  }
  AmountKind m_kind;
};
 
enum ChangeKind {CALVING, FRONTAL_MELT, FORCED_RETREAT, TOTAL_DISCHARGE};
 
static void accumulate_changes(const IceModel *model, double factor, ChangeKind kind,
                               array::Scalar &accumulator) {
 
  const auto &calving        = model->calving();
  const auto &frontal_melt   = model->frontal_melt();
  const auto &forced_retreat = model->forced_retreat();
 
  auto grid = accumulator.grid();
 
  bool add_calving        = (kind == CALVING or kind == TOTAL_DISCHARGE);
  bool add_frontal_melt   = (kind == FRONTAL_MELT or kind == TOTAL_DISCHARGE);
  bool add_forced_retreat = (kind == FORCED_RETREAT or kind == TOTAL_DISCHARGE);
 
  array::AccessScope scope{ &accumulator };
  if (add_calving) {
    scope.add(calving);
  }
  if (add_frontal_melt) {
    scope.add(frontal_melt);
  }
  if (add_forced_retreat) {
    scope.add(forced_retreat);
  }
 
  for (auto p = grid->points(); p; p.next()) {
    const int i = p.i(), j = p.j();
 
    if (add_calving) {
      accumulator(i, j) += factor * calving(i, j);
    }
    if (add_frontal_melt) {
      accumulator(i, j) += factor * frontal_melt(i, j);
    }
    if (add_forced_retreat) {
      accumulator(i, j) += factor * forced_retreat(i, j);
    }
  }
}
 
 
/*! @brief Report discharge (calving and frontal melt) flux. */
class DischargeFlux : public DiagAverageRate<IceModel> {
public:
  DischargeFlux(const IceModel *m, AmountKind kind)
      : DiagAverageRate<IceModel>(m,
                                  kind == AMOUNT ? "tendency_of_ice_amount_due_to_discharge" :
                                                   "tendency_of_ice_mass_due_to_discharge",
                                  TOTAL_CHANGE),
        m_kind(kind) {
 
    m_factor = m_config->get_number("constants.ice.density");
 
    auto ismip6 = m_config->get_flag("output.ISMIP6");
 
    std::string name      = ismip6 ? "lifmassbf" : "tendency_of_ice_amount_due_to_discharge",
                long_name = "discharge flux (calving, frontal melt, forced retreat)",
                accumulator_units = "kg m-2",
                standard_name  = "land_ice_specific_mass_flux_due_to_calving_and_ice_front_melting",
                internal_units = "kg m-2 s-1", external_units = "kg m-2 year-1";
    if (kind == MASS) {
      name              = "tendency_of_ice_mass_due_to_discharge";
      long_name         = "discharge flux (calving, frontal melt, forced retreat)";
      accumulator_units = "kg";
      standard_name     = "";
      internal_units    = "kg second-1";
      external_units    = "Gt year-1";
    }
 
    m_accumulator.metadata()["units"] = accumulator_units;
 
    m_vars = { { m_sys, name } };
    m_vars[0]
        .long_name(long_name)
        .standard_name(standard_name)
        .units(internal_units)
        .output_units(external_units);
    m_vars[0]["cell_methods"] = "time: mean";
    m_vars[0]["_FillValue"]   = { to_internal(m_fill_value) };
    m_vars[0]["comment"]      = "positive flux corresponds to ice gain";
  }
 
protected:
  void update_impl(double dt) {
    accumulate_changes(model,
                       m_factor * (m_kind == AMOUNT ? 1.0 : m_grid->cell_area()),
                       TOTAL_DISCHARGE,
                       m_accumulator);
 
    m_interval_length += dt;
  }
  AmountKind m_kind;
};
 
/*! @brief Report the calving flux. */
class CalvingFlux : public DiagAverageRate<IceModel>
{
public:
  CalvingFlux(const IceModel *m, AmountKind kind)
    : DiagAverageRate<IceModel>(m,
                                kind == AMOUNT
                                ? "tendency_of_ice_amount_due_to_calving"
                                : "tendency_of_ice_mass_due_to_calving",
                                TOTAL_CHANGE),
    m_kind(kind) {
 
    m_factor = m_config->get_number("constants.ice.density");
 
    auto ismip6 = m_config->get_flag("output.ISMIP6");
 
    std::string
      name              = ismip6 ? "licalvf" : "tendency_of_ice_amount_due_to_calving",
      long_name         = "calving flux",
      accumulator_units = "kg m-2",
      standard_name     = "land_ice_specific_mass_flux_due_to_calving",
      internal_units    = "kg m-2 s-1",
      external_units    = "kg m-2 year-1";
    if (kind == MASS) {
      name              = "tendency_of_ice_mass_due_to_calving";
      long_name         = "calving flux";
      accumulator_units = "kg";
      standard_name     = "";
      internal_units    = "kg second-1";
      external_units    = "Gt year-1";
    }
 
    m_accumulator.metadata().units(accumulator_units);
 
    m_vars = { { m_sys, name } };
    m_vars[0]
        .long_name(long_name)
        .standard_name(standard_name)
        .units(internal_units)
        .output_units(external_units);
    m_vars[0]["cell_methods"] = "time: mean";
 
    m_vars[0]["_FillValue"] = {to_internal(m_fill_value)};
    m_vars[0]["comment"] = "positive flux corresponds to ice gain";
  }
 
protected:
  void update_impl(double dt) {
 
    accumulate_changes(model,
                       m_factor * (m_kind == AMOUNT ? 1.0 : m_grid->cell_area()),
                       CALVING,
                       m_accumulator);
 
    m_interval_length += dt;
  }
  AmountKind m_kind;
};
 
/*! @brief Report the frontal melt flux. */
class FrontalMeltFlux : public DiagAverageRate<IceModel>
{
public:
  FrontalMeltFlux(const IceModel *m, AmountKind kind)
    : DiagAverageRate<IceModel>(m,
                                kind == AMOUNT
                                ? "tendency_of_ice_amount_due_to_frontal_melt"
                                : "tendency_of_ice_mass_due_to_frontal_melt",
                                TOTAL_CHANGE),
    m_kind(kind) {
 
    m_factor = m_config->get_number("constants.ice.density");
 
    std::string name = "tendency_of_ice_amount_due_to_frontal_melt", accumulator_units = "kg m-2",
                internal_units = "kg m-2 s-1", external_units = "kg m-2 year-1";
    if (kind == MASS) {
      name              = "tendency_of_ice_mass_due_to_frontal_melt";
      accumulator_units = "kg";
      internal_units    = "kg second-1";
      external_units    = "Gt year-1";
    }
 
    m_accumulator.metadata().units(accumulator_units);
 
    m_vars = { { m_sys, name } };
    m_vars[0].long_name("frontal melt flux").units(internal_units).output_units(external_units);
    m_vars[0]["cell_methods"] = "time: mean";
    m_vars[0]["_FillValue"] = { to_internal(m_fill_value) };
    m_vars[0]["comment"] = "positive flux corresponds to ice gain";
  }
 
protected:
  void update_impl(double dt) {
 
    accumulate_changes(model,
                       m_factor * (m_kind == AMOUNT ? 1.0 : m_grid->cell_area()),
                       FRONTAL_MELT,
                       m_accumulator);
 
    m_interval_length += dt;
  }
  AmountKind m_kind;
};
 
/*! @brief Report the frontal melt flux. */
class ForcedRetreatFlux : public DiagAverageRate<IceModel>
{
public:
  ForcedRetreatFlux(const IceModel *m, AmountKind kind)
      : DiagAverageRate<IceModel>(m,
                                  kind == AMOUNT ? "tendency_of_ice_amount_due_to_forced_retreat" :
                                                   "tendency_of_ice_mass_due_to_forced_retreat",
                                  TOTAL_CHANGE),
        m_kind(kind) {
 
    m_factor = m_config->get_number("constants.ice.density");
 
    std::string name = "tendency_of_ice_amount_due_to_forced_retreat", accumulator_units = "kg m-2",
                internal_units = "kg m-2 s-1", external_units = "kg m-2 year-1";
    if (kind == MASS) {
      name              = "tendency_of_ice_mass_due_to_forced_retreat";
      accumulator_units = "kg";
      internal_units    = "kg second-1";
      external_units    = "Gt year-1";
    }
 
    m_accumulator.metadata().units(accumulator_units);
 
    m_vars = { { m_sys, name } };
    m_vars[0]
        .long_name("forced (prescribed) retreat flux")
        .units(internal_units)
        .output_units(external_units);
    m_vars[0]["cell_methods"] = "time: mean";
    m_vars[0]["_FillValue"] = { to_internal(m_fill_value) };
    m_vars[0]["comment"] = "positive flux corresponds to ice gain";
  }
 
protected:
  void update_impl(double dt) {
 
    accumulate_changes(model,
                       m_factor * (m_kind == AMOUNT ? 1.0 : m_grid->cell_area()),
                       FORCED_RETREAT,
                       m_accumulator);
 
    m_interval_length += dt;
  }
  AmountKind m_kind;
};
 
} // end of namespace diagnostics
} // end of namespace pism
 
namespace pism {
 
// Horrendous names used by InitMIP (and ISMIP6, and CMIP5). Ugh.
static const char* land_ice_area_fraction_name           = "sftgif";
static const char* grounded_ice_sheet_area_fraction_name = "sftgrf";
static const char* floating_ice_sheet_area_fraction_name = "sftflf";
 
namespace diagnostics {
 
enum AreaType {GROUNDED, SHELF, BOTH};
 
enum TermType {SMB, BMB, FLOW, ERROR};
 
/*! @brief Ocean pressure difference at calving fronts. Used to debug CF boundary conditins. */
class IceMarginPressureDifference : public Diag<IceModel>
{
public:
  IceMarginPressureDifference(IceModel *m);
 
protected:
  std::shared_ptr<array::Array> compute_impl() const;
};
 
IceMarginPressureDifference::IceMarginPressureDifference(IceModel *m) : Diag<IceModel>(m) {
 
  /* set metadata: */
  m_vars                  = { { m_sys, "ice_margin_pressure_difference" } };
  m_vars[0]["_FillValue"] = { m_fill_value };
  m_vars[0]
      .long_name(
          "vertically-averaged pressure difference at ice margins (including calving fronts)")
      .units("Pa");
}
 
std::shared_ptr<array::Array> IceMarginPressureDifference::compute_impl() const {
 
  auto result = allocate<array::Scalar>("ice_margin_pressure_difference");
 
  array::CellType1 mask(m_grid, "mask");
 
  const auto &H         = model->geometry().ice_thickness;
  const auto &bed       = model->geometry().bed_elevation;
  const auto &sea_level = model->geometry().sea_level_elevation;
 
  {
    const double H_threshold = m_config->get_number("stress_balance.ice_free_thickness_standard");
    GeometryCalculator gc(*m_config);
    gc.set_icefree_thickness(H_threshold);
 
    gc.compute_mask(sea_level, bed, H, mask);
  }
 
  const double rho_ice   = m_config->get_number("constants.ice.density"),
               rho_ocean = m_config->get_number("constants.sea_water.density"),
               g         = m_config->get_number("constants.standard_gravity");
 
  array::AccessScope list{ &H, &bed, &mask, &sea_level, result.get() };
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      double delta_p = 0.0;
      if (mask.grounded_ice(i, j) and grid::domain_edge(*m_grid, i, j)) {
        delta_p = 0.0;
      } else if (mask.icy(i, j) and mask.next_to_ice_free_ocean(i, j)) {
        double P_ice   = 0.5 * rho_ice * g * H(i, j),
               P_water = average_water_column_pressure(H(i, j), bed(i, j), sea_level(i, j), rho_ice,
                                                       rho_ocean, g);
 
        delta_p = P_ice - P_water;
      } else {
        delta_p = m_fill_value;
      }
 
      (*result)(i, j) = delta_p;
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
 
  return result;
}
 
/*! @brief Report average basal mass balance flux over the reporting interval (grounded or floating
  areas) */
class BMBSplit : public DiagAverageRate<IceModel> {
public:
  BMBSplit(const IceModel *m, AreaType flag)
      : DiagAverageRate<IceModel>(
            m, flag == GROUNDED ? "basal_mass_flux_grounded" : "basal_mass_flux_floating",
            TOTAL_CHANGE),
        m_kind(flag) {
    assert(flag != BOTH);
 
    auto ismip6 = m_config->get_flag("output.ISMIP6");
 
    std::string name, description, standard_name;
    if (m_kind == GROUNDED) {
      name          = ismip6 ? "libmassbfgr" : "basal_mass_flux_grounded";
      description   = "average basal mass flux over the reporting interval (grounded areas)";
      standard_name = ismip6 ? "land_ice_basal_specific_mass_balance_flux" : "";
    } else {
      name          = ismip6 ? "libmassbffl" : "basal_mass_flux_floating";
      description   = "average basal mass flux over the reporting interval (floating areas)";
      standard_name = ismip6 ? "land_ice_basal_specific_mass_balance_flux" : "";
    }
 
    m_accumulator.metadata()["units"] = "kg m-2";
 
    m_vars = { { m_sys, name } };
    m_vars[0]
        .long_name(description)
        .standard_name(standard_name)
        .units("kg m-2 s-1")
        .output_units("kg m-2 year-1");
    m_vars[0]["cell_methods"] = "time: mean";
    m_vars[0]["_FillValue"]   = { to_internal(m_fill_value) };
    m_vars[0]["comment"]      = "positive flux corresponds to ice gain";
  }
 
protected:
  AreaType m_kind;
  void update_impl(double dt) {
    const array::Scalar &input = model->geometry_evolution().bottom_surface_mass_balance();
    const auto &cell_type      = model->geometry().cell_type;
 
    double ice_density = m_config->get_number("constants.ice.density");
 
    // the accumulator has the units of kg/m^2, computed as
    //
    // accumulator += BMB (m) * ice_density (kg / m^3)
 
    array::AccessScope list{ &input, &cell_type, &m_accumulator };
 
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      if (m_kind == GROUNDED and cell_type.grounded(i, j)) {
        m_accumulator(i, j) += input(i, j) * ice_density;
      } else if (m_kind == SHELF and cell_type.ocean(i, j)) {
        m_accumulator(i, j) += input(i, j) * ice_density;
      } else {
        m_accumulator(i, j) = 0.0;
      }
    }
 
    m_interval_length += dt;
  }
};
 
//! \brief Computes vertically-averaged ice hardness.
class HardnessAverage : public Diag<IceModel> {
public:
  HardnessAverage(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
HardnessAverage::HardnessAverage(const IceModel *m) : Diag<IceModel>(m) {
 
  // set metadata:
  m_vars = { { m_sys, "hardav" } };
  m_vars[0]
      .long_name("vertical average of ice hardness")
      .set_units_without_validation(
          "Pa s^(1/n)"); // n is the Glen exponent used by the SSA (shallow stress balance) flow law
  m_vars[0]["valid_min"]  = { 0.0 };
  m_vars[0]["_FillValue"] = { m_fill_value };
  m_vars[0]["comment"]    = "units depend on the Glen exponent used by the flow law";
}
 
//! \brief Computes vertically-averaged ice hardness.
std::shared_ptr<array::Array> HardnessAverage::compute_impl() const {
 
  const rheology::FlowLaw *flow_law = model->stress_balance()->shallow()->flow_law().get();
  if (flow_law == NULL) {
    flow_law = model->stress_balance()->modifier()->flow_law().get();
    if (flow_law == NULL) {
      throw RuntimeError(PISM_ERROR_LOCATION,
                         "Can't compute vertically-averaged hardness: no flow law is used.");
    }
  }
 
  auto result        = std::make_shared<array::Scalar>(m_grid, "hardav");
  result->metadata() = m_vars[0];
 
  const auto &cell_type = model->geometry().cell_type;
 
  const array::Array3D &ice_enthalpy = model->energy_balance_model()->enthalpy();
  const array::Scalar &ice_thickness = model->geometry().ice_thickness;
 
  array::AccessScope list{ &cell_type, &ice_enthalpy, &ice_thickness, result.get() };
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      const double *Eij = ice_enthalpy.get_column(i, j);
      const double H    = ice_thickness(i, j);
      if (cell_type.icy(i, j)) {
        (*result)(i, j) = rheology::averaged_hardness(*flow_law, H, m_grid->kBelowHeight(H),
                                                      &(m_grid->z()[0]), Eij);
      } else { // put negative value below valid range
        (*result)(i, j) = m_fill_value;
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  return result;
}
 
//! \brief Computes a diagnostic field filled with processor rank values.
class Rank : public Diag<IceModel> {
public:
  Rank(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
Rank::Rank(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, "rank" } };
  m_vars[0]
      .long_name("processor rank")
      .units("1")
      .set_time_independent(true)
      .set_output_type(io::PISM_INT);
}
 
std::shared_ptr<array::Array> Rank::compute_impl() const {
 
  auto result        = std::make_shared<array::Scalar>(m_grid, "rank");
  result->metadata() = m_vars[0];
 
  array::AccessScope list{ result.get() };
 
  for (auto p = m_grid->points(); p; p.next()) {
    (*result)(p.i(), p.j()) = m_grid->rank();
  }
 
  return result;
}
 
//! \brief Computes CTS, CTS = E/E_s(p).
class CTS : public Diag<IceModel> {
public:
  CTS(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
CTS::CTS(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, "cts", m_grid->z() } };
  m_vars[0]
      .long_name("cts = E/E_s(p), so cold-temperate transition surface is at cts = 1")
      .units("1");
}
 
std::shared_ptr<array::Array> CTS::compute_impl() const {
 
  std::shared_ptr<array::Array3D> result(new array::Array3D(m_grid, "cts", array::WITHOUT_GHOSTS, m_grid->z()));
  result->metadata() = m_vars[0];
 
  energy::compute_cts(model->energy_balance_model()->enthalpy(), model->geometry().ice_thickness,
                      *result);
 
  return result;
}
 
//! \brief Computes ice temperature from enthalpy.
class Temperature : public Diag<IceModel> {
public:
  Temperature(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
Temperature::Temperature(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, "temp", m_grid->z() } };
  m_vars[0]
      .long_name("ice temperature")
      .standard_name("land_ice_temperature")
      .units("K");
  m_vars[0]["valid_min"] = { 0.0 };
}
 
std::shared_ptr<array::Array> Temperature::compute_impl() const {
 
  std::shared_ptr<array::Array3D> result(
      new array::Array3D(m_grid, "temp", array::WITHOUT_GHOSTS, m_grid->z()));
  result->metadata() = m_vars[0];
 
  const auto &thickness = model->geometry().ice_thickness;
  const auto &enthalpy  = model->energy_balance_model()->enthalpy();
 
  EnthalpyConverter::Ptr EC = model->ctx()->enthalpy_converter();
 
  double *Tij;
  const double *Enthij; // columns of these values
 
  array::AccessScope list{result.get(), &enthalpy, &thickness};
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      Tij = result->get_column(i,j);
      Enthij = enthalpy.get_column(i,j);
      for (unsigned int k=0; k <m_grid->Mz(); ++k) {
        const double depth = thickness(i,j) - m_grid->z(k);
        Tij[k] = EC->temperature(Enthij[k], EC->pressure(depth));
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  return result;
}
 
//! \brief Compute the pressure-adjusted temperature in degrees C corresponding
//! to ice temperature.
class TemperaturePA : public Diag<IceModel>
{
public:
  TemperaturePA(const IceModel *m);
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
 
TemperaturePA::TemperaturePA(const IceModel *m)
  : Diag<IceModel>(m) {
  m_vars = {{m_sys, "temp_pa", m_grid->z()}};
  m_vars[0]
      .long_name("pressure-adjusted ice temperature (degrees above pressure-melting point)")
      .units("deg_C");
  m_vars[0]["valid_max"] = {0};
}
 
std::shared_ptr<array::Array> TemperaturePA::compute_impl() const {
  bool cold_mode = m_config->get_flag("energy.temperature_based");
  double melting_point_temp = m_config->get_number("constants.fresh_water.melting_point_temperature");
 
  auto result = std::make_shared<array::Array3D>(m_grid, "temp_pa", array::WITHOUT_GHOSTS, m_grid->z());
  result->metadata() = m_vars[0];
 
  const auto &thickness = model->geometry().ice_thickness;
  const auto &enthalpy  = model->energy_balance_model()->enthalpy();
 
  EnthalpyConverter::Ptr EC = model->ctx()->enthalpy_converter();
 
  double *Tij;
  const double *Enthij; // columns of these values
 
  array::AccessScope list{result.get(), &enthalpy, &thickness};
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto pt = m_grid->points(); pt; pt.next()) {
      const int i = pt.i(), j = pt.j();
 
      Tij = result->get_column(i,j);
      Enthij = enthalpy.get_column(i,j);
      for (unsigned int k=0; k < m_grid->Mz(); ++k) {
        const double depth = thickness(i,j) - m_grid->z(k),
          p = EC->pressure(depth);
        Tij[k] = EC->pressure_adjusted_temperature(Enthij[k], p);
 
        if (cold_mode) { // if ice is temperate then its pressure-adjusted temp
          // is 273.15
          if (EC->is_temperate_relaxed(Enthij[k],p) && (thickness(i,j) > 0)) {
            Tij[k] = melting_point_temp;
          }
        }
 
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  result->shift(-melting_point_temp);
 
  return result;
}
 
//! \brief Computes basal values of the pressure-adjusted temperature.
class TemperaturePABasal : public Diag<IceModel>
{
public:
  TemperaturePABasal(const IceModel *m);
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
TemperaturePABasal::TemperaturePABasal(const IceModel *m)
  : Diag<IceModel>(m) {
  m_vars = { { m_sys, "temppabase" } };
  m_vars[0].long_name("pressure-adjusted ice temperature at the base of ice").units("Celsius");
}
 
std::shared_ptr<array::Array> TemperaturePABasal::compute_impl() const {
 
  bool cold_mode = m_config->get_flag("energy.temperature_based");
  double melting_point_temp = m_config->get_number("constants.fresh_water.melting_point_temperature");
 
  auto result = std::make_shared<array::Scalar>(m_grid, "temp_pa_base");
  result->metadata() = m_vars[0];
 
  const auto &thickness = model->geometry().ice_thickness;
  const auto &enthalpy = model->energy_balance_model()->enthalpy();
 
  EnthalpyConverter::Ptr EC = model->ctx()->enthalpy_converter();
 
  array::AccessScope list{result.get(), &enthalpy, &thickness};
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto pt = m_grid->points(); pt; pt.next()) {
      const int i = pt.i(), j = pt.j();
 
      auto Enthij = enthalpy.get_column(i,j);
 
      const double depth = thickness(i,j),
        p = EC->pressure(depth);
      (*result)(i,j) = EC->pressure_adjusted_temperature(Enthij[0], p);
 
      if (cold_mode) { // if ice is temperate then its pressure-adjusted temp
        // is 273.15
        if (EC->is_temperate_relaxed(Enthij[0],p) && (thickness(i,j) > 0)) {
          (*result)(i,j) = melting_point_temp;
        }
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  result->shift(-melting_point_temp);
 
  return result;
}
 
//! \brief Computes surface values of ice enthalpy.
class IceEnthalpySurface : public Diag<IceModel>
{
public:
  IceEnthalpySurface(const IceModel *m);
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
IceEnthalpySurface::IceEnthalpySurface(const IceModel *m)
  : Diag<IceModel>(m) {
  m_vars = { { m_sys, "enthalpysurf" } };
  m_vars[0].long_name("ice enthalpy at 1m below the ice surface").units("J kg-1");
  m_vars[0]["_FillValue"] = {m_fill_value};
}
 
std::shared_ptr<array::Array> IceEnthalpySurface::compute_impl() const {
 
  auto result = std::make_shared<array::Scalar>(m_grid, "enthalpysurf");
  result->metadata() = m_vars[0];
 
  // compute levels corresponding to 1 m below the ice surface:
 
  const array::Array3D& ice_enthalpy = model->energy_balance_model()->enthalpy();
  const array::Scalar& ice_thickness = model->geometry().ice_thickness;
 
  array::AccessScope list{&ice_thickness, result.get()};
 
  for (auto p = m_grid->points(); p; p.next()) {
    const int i = p.i(), j = p.j();
 
    (*result)(i,j) = std::max(ice_thickness(i,j) - 1.0, 0.0);
  }
 
  extract_surface(ice_enthalpy, *result, *result);  // slice at 1 m below the surface
 
  for (auto p = m_grid->points(); p; p.next()) {
    const int i = p.i(), j = p.j();
 
    if (ice_thickness(i,j) <= 1.0) {
      (*result)(i,j) = m_fill_value;
    }
  }
 
  return result;
}
 
//! \brief Computes enthalpy at the base of the ice.
class IceEnthalpyBasal : public Diag<IceModel>
{
public:
  IceEnthalpyBasal(const IceModel *m);
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
IceEnthalpyBasal::IceEnthalpyBasal(const IceModel *m)
  : Diag<IceModel>(m) {
  m_vars = {{m_sys, "enthalpybase"}};
  m_vars[0].long_name("ice enthalpy at the base of ice").units("J kg-1");
  m_vars[0]["_FillValue"] = {m_fill_value};
}
 
std::shared_ptr<array::Array> IceEnthalpyBasal::compute_impl() const {
 
  auto result = std::make_shared<array::Scalar>(m_grid, "enthalpybase");
  result->metadata() = m_vars[0];
 
  extract_surface(model->energy_balance_model()->enthalpy(), 0.0, *result);  // z=0 slice
 
  apply_mask(model->geometry().ice_thickness, m_fill_value, *result);
 
  return result;
}
 
//! \brief Computes ice temperature at the base of the ice.
class TemperatureBasal : public Diag<IceModel>
{
public:
  TemperatureBasal(const IceModel *m, AreaType flag);
private:
  std::shared_ptr<array::Array> compute_impl() const;
 
  AreaType m_area_type;
};
 
TemperatureBasal::TemperatureBasal(const IceModel *m, AreaType area_type)
  : Diag<IceModel>(m), m_area_type(area_type) {
 
  std::string name, long_name, standard_name;
  switch (area_type) {
  case GROUNDED:
    name          = "litempbotgr";
    long_name     = "ice temperature at the bottom surface of grounded ice";
    standard_name = "temperature_at_base_of_ice_sheet_model";
    break;
  case SHELF:
    name          = "litempbotfl";
    long_name     = "ice temperature at the bottom surface of floating ice";
    standard_name = "temperature_at_base_of_ice_sheet_model";
    break;
  case BOTH:
    name          = "tempbase";
    long_name     = "ice temperature at the base of ice";
    standard_name = "land_ice_basal_temperature";
    break;
  }
 
  m_vars = { { m_sys, name } };
  m_vars[0].long_name(long_name).standard_name(standard_name).units("K");
  m_vars[0]["_FillValue"] = { m_fill_value };
}
 
std::shared_ptr<array::Array> TemperatureBasal::compute_impl() const {
 
  auto result = allocate<array::Scalar>("basal_temperature");
 
  const auto &thickness = model->geometry().ice_thickness;
 
  EnthalpyConverter::Ptr EC = model->ctx()->enthalpy_converter();
 
  extract_surface(model->energy_balance_model()->enthalpy(), 0.0, *result); // z=0 (basal) slice
  // Now result contains basal enthalpy.
 
  const auto &cell_type = model->geometry().cell_type;
 
  array::AccessScope list{ &cell_type, result.get(), &thickness };
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      double depth = thickness(i, j), pressure = EC->pressure(depth),
             T = EC->temperature((*result)(i, j), pressure);
 
      if ((m_area_type == BOTH and cell_type.icy(i, j)) or
          (m_area_type == GROUNDED and cell_type.grounded_ice(i, j)) or
          (m_area_type == SHELF and cell_type.floating_ice(i, j))) {
        (*result)(i, j) = T;
      } else {
        (*result)(i, j) = m_fill_value;
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  return result;
}
 
//! \brief Computes ice temperature at the surface of the ice.
class TemperatureSurface : public Diag<IceModel> {
public:
  TemperatureSurface(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
TemperatureSurface::TemperatureSurface(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, "tempsurf" } };
  m_vars[0]
      .long_name("ice temperature at 1m below the ice surface")
      .standard_name("temperature_at_ground_level_in_snow_or_firn") // InitMIP "standard" name
      .units("K");
  m_vars[0]["_FillValue"] = { m_fill_value };
}
 
std::shared_ptr<array::Array> TemperatureSurface::compute_impl() const {
 
  const array::Scalar &thickness = model->geometry().ice_thickness;
 
  auto enth   = IceEnthalpySurface(model).compute();
  auto result = array::cast<array::Scalar>(enth);
 
  EnthalpyConverter::Ptr EC = model->ctx()->enthalpy_converter();
 
  // result contains surface enthalpy; note that it is allocated by
  // IceEnthalpySurface::compute().
 
  array::AccessScope list{ result.get(), &thickness };
 
  double depth = 1.0, pressure = EC->pressure(depth);
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      if (thickness(i, j) > 1) {
        (*result)(i, j) = EC->temperature((*result)(i, j), pressure);
      } else {
        (*result)(i, j) = m_fill_value;
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  result->metadata(0) = m_vars[0];
  return result;
}
 
//! \brief Computes the liquid water fraction.
class LiquidFraction : public Diag<IceModel> {
public:
  LiquidFraction(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
LiquidFraction::LiquidFraction(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, "liqfrac", m_grid->z() } };
  m_vars[0].long_name("liquid water fraction in ice (between 0 and 1)").units("1");
  m_vars[0]["valid_range"] = { 0.0, 1.0 };
}
 
std::shared_ptr<array::Array> LiquidFraction::compute_impl() const {
 
  std::shared_ptr<array::Array3D> result(
      new array::Array3D(m_grid, "liqfrac", array::WITHOUT_GHOSTS, m_grid->z()));
  result->metadata(0) = m_vars[0];
 
  bool cold_mode = m_config->get_flag("energy.temperature_based");
 
  if (cold_mode) {
    result->set(0.0);
  } else {
    energy::compute_liquid_water_fraction(model->energy_balance_model()->enthalpy(),
                                          model->geometry().ice_thickness, *result);
  }
 
  return result;
}
 
//! \brief Computes the total thickness of temperate ice in a column.
class TemperateIceThickness : public Diag<IceModel> {
public:
  TemperateIceThickness(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
TemperateIceThickness::TemperateIceThickness(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, "tempicethk" } };
  m_vars[0].long_name("temperate ice thickness (total column content)").units("m");
  m_vars[0]["_FillValue"] = { m_fill_value };
}
 
std::shared_ptr<array::Array> TemperateIceThickness::compute_impl() const {
 
  auto result = allocate<array::Scalar>("tempicethk");
 
  const auto &cell_type     = model->geometry().cell_type;
  const auto &ice_enthalpy  = model->energy_balance_model()->enthalpy();
  const auto &ice_thickness = model->geometry().ice_thickness;
 
  array::AccessScope list{ &cell_type, result.get(), &ice_enthalpy, &ice_thickness };
 
  EnthalpyConverter::Ptr EC = model->ctx()->enthalpy_converter();
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      if (cell_type.icy(i, j)) {
        const double *Enth    = ice_enthalpy.get_column(i, j);
        double H_temperate    = 0.0;
        const double H        = ice_thickness(i, j);
        const unsigned int ks = m_grid->kBelowHeight(H);
 
        for (unsigned int k = 0; k < ks; ++k) { // FIXME issue #15
          double pressure = EC->pressure(H - m_grid->z(k));
 
          if (EC->is_temperate_relaxed(Enth[k], pressure)) {
            H_temperate += m_grid->z(k + 1) - m_grid->z(k);
          }
        }
 
        double pressure = EC->pressure(H - m_grid->z(ks));
        if (EC->is_temperate_relaxed(Enth[ks], pressure)) {
          H_temperate += H - m_grid->z(ks);
        }
 
        (*result)(i, j) = H_temperate;
      } else {
        // ice-free
        (*result)(i, j) = m_fill_value;
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  return result;
}
 
//! \brief Computes the thickness of the basal layer of temperate ice.
class TemperateIceThicknessBasal : public Diag<IceModel> {
public:
  TemperateIceThicknessBasal(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
TemperateIceThicknessBasal::TemperateIceThicknessBasal(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, "tempicethk_basal" } };
  m_vars[0].long_name("thickness of the basal layer of temperate ice").units("m");
  m_vars[0]["_FillValue"] = { m_fill_value };
}
 
/*!
 * Uses linear interpolation to go beyond vertical grid resolution.
 */
std::shared_ptr<array::Array> TemperateIceThicknessBasal::compute_impl() const {
 
  auto result = allocate<array::Scalar>("tempicethk_basal");
 
  EnthalpyConverter::Ptr EC = model->ctx()->enthalpy_converter();
 
  const auto &cell_type     = model->geometry().cell_type;
  const auto &ice_enthalpy  = model->energy_balance_model()->enthalpy();
  const auto &ice_thickness = model->geometry().ice_thickness;
 
  array::AccessScope list{ &cell_type, result.get(), &ice_thickness, &ice_enthalpy };
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      double H = ice_thickness(i, j);
 
      // if we have no ice, go on to the next grid point (this cell will be
      // marked as "missing" later)
      if (cell_type.ice_free(i, j)) {
        (*result)(i, j) = m_fill_value;
        continue;
      }
 
      const double *Enth = ice_enthalpy.get_column(i, j);
 
      unsigned int ks = m_grid->kBelowHeight(H);
 
      unsigned int k  = 0;
      double pressure = EC->pressure(H - m_grid->z(k));
      while (k <= ks) { // FIXME issue #15
        pressure = EC->pressure(H - m_grid->z(k));
 
        if (EC->is_temperate_relaxed(Enth[k], pressure)) {
          k++;
        } else {
          break;
        }
      }
      // after this loop 'pressure' is equal to the pressure at the first level
      // that is cold
 
      // no temperate ice at all; go to the next grid point
      if (k == 0) {
        (*result)(i, j) = 0.0;
        continue;
      }
 
      // the whole column is temperate (except, possibly, some ice between
      // z(ks) and the total thickness; we ignore it)
      if (k == ks + 1) {
        (*result)(i, j) = m_grid->z(ks);
        continue;
      }
 
      double pressure_0 = EC->pressure(H - m_grid->z(k - 1)), dz = m_grid->z(k) - m_grid->z(k - 1),
             slope1 = (Enth[k] - Enth[k - 1]) / dz,
             slope2 = (EC->enthalpy_cts(pressure) - EC->enthalpy_cts(pressure_0)) / dz;
 
      if (slope1 != slope2) {
        (*result)(i, j) =
            m_grid->z(k - 1) + (EC->enthalpy_cts(pressure_0) - Enth[k - 1]) / (slope1 - slope2);
 
        // check if the resulting thickness is valid:
        (*result)(i, j) = std::max((*result)(i, j), m_grid->z(k - 1));
        (*result)(i, j) = std::min((*result)(i, j), m_grid->z(k));
      } else {
        throw RuntimeError::formatted(PISM_ERROR_LOCATION,
                                      "Linear interpolation of the thickness of"
                                      " the basal temperate layer failed:\n"
                                      "(i=%d, j=%d, k=%d, ks=%d)\n",
                                      i, j, k, ks);
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
 
  return result;
}
 
namespace scalar {
 
//! \brief Computes the total ice volume in glacierized areas.
class IceVolumeGlacierized : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceVolumeGlacierized(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_volume_glacierized") {
 
    set_units("m3", "m3");
    m_variable["long_name"] = "volume of the ice in glacierized areas";
    m_variable["valid_min"] = { 0.0 };
  }
  double compute() {
    return ice_volume(model->geometry(),
                      m_config->get_number("output.ice_free_thickness_standard"));
  }
};
 
//! \brief Computes the total ice volume.
class IceVolume : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceVolume(IceModel *m) : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_volume") {
 
    set_units("m3", "m3");
    m_variable["long_name"] = "volume of the ice, including seasonal cover";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return ice_volume(model->geometry(), 0.0);
  }
};
 
//! \brief Computes the total ice volume which is relevant for sea-level
class SeaLevelRisePotential : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  SeaLevelRisePotential(const IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "sea_level_rise_potential") {
 
    set_units("m", "m");
    m_variable["long_name"] = "the sea level rise that would result if all the ice were melted";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return sea_level_rise_potential(model->geometry(),
                                    m_config->get_number("output.ice_free_thickness_standard"));
  }
};
 
//! \brief Computes the rate of change of the total ice volume in glacierized areas.
class IceVolumeRateOfChangeGlacierized : public TSDiag<TSRateDiagnostic, IceModel> {
public:
  IceVolumeRateOfChangeGlacierized(IceModel *m)
      : TSDiag<TSRateDiagnostic, IceModel>(m, "tendency_of_ice_volume_glacierized") {
 
    set_units("m3 s-1", "m3 year-1");
    m_variable["long_name"] = "rate of change of the ice volume in glacierized areas";
  }
 
  double compute() {
    return ice_volume(model->geometry(),
                      m_config->get_number("output.ice_free_thickness_standard"));
  }
};
 
//! \brief Computes the rate of change of the total ice volume.
class IceVolumeRateOfChange : public TSDiag<TSRateDiagnostic, IceModel> {
public:
  IceVolumeRateOfChange(IceModel *m)
      : TSDiag<TSRateDiagnostic, IceModel>(m, "tendency_of_ice_volume") {
 
    set_units("m3 s-1", "m3 year-1");
    m_variable["long_name"] = "rate of change of the ice volume, including seasonal cover";
  }
 
  double compute() {
    return ice_volume(model->geometry(), 0.0);
  }
};
 
//! \brief Computes the total ice area.
class IceAreaGlacierized : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceAreaGlacierized(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_area_glacierized") {
 
    set_units("m2", "m2");
    m_variable["long_name"] = "glacierized area";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return ice_area(model->geometry(), m_config->get_number("output.ice_free_thickness_standard"));
  }
};
 
//! \brief Computes the total mass of the ice not displacing sea water.
class IceMassNotDisplacingSeaWater : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceMassNotDisplacingSeaWater(const IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "limnsw") {
 
    set_units("kg", "kg");
    m_variable["long_name"]     = "mass of the ice not displacing sea water";
    m_variable["standard_name"] = "land_ice_mass_not_displacing_sea_water";
    m_variable["valid_min"]     = { 0.0 };
  }
 
  double compute() {
 
    const double thickness_standard = m_config->get_number("output.ice_free_thickness_standard"),
                 ice_density        = m_config->get_number("constants.ice.density"),
                 ice_volume =
                     ice_volume_not_displacing_seawater(model->geometry(), thickness_standard),
                 ice_mass = ice_volume * ice_density;
 
    return ice_mass;
  }
};
 
//! \brief Computes the total ice mass in glacierized areas.
class IceMassGlacierized : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceMassGlacierized(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_mass_glacierized") {
 
    set_units("kg", "kg");
    m_variable["long_name"] = "mass of the ice in glacierized areas";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    double ice_density        = m_config->get_number("constants.ice.density"),
           thickness_standard = m_config->get_number("output.ice_free_thickness_standard");
    return ice_volume(model->geometry(), thickness_standard) * ice_density;
  }
};
 
//! \brief Computes the total ice mass.
class IceMass : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceMass(IceModel *m) : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_mass") {
 
    if (m_config->get_flag("output.ISMIP6")) {
      m_variable.set_name("lim");
    }
 
    set_units("kg", "kg");
    m_variable["long_name"]     = "mass of the ice, including seasonal cover";
    m_variable["standard_name"] = "land_ice_mass";
    m_variable["valid_min"]     = { 0.0 };
  }
 
  double compute() {
    return (ice_volume(model->geometry(), 0.0) * m_config->get_number("constants.ice.density"));
  }
};
 
//! \brief Computes the rate of change of the total ice mass in glacierized areas.
class IceMassRateOfChangeGlacierized : public TSDiag<TSRateDiagnostic, IceModel> {
public:
  IceMassRateOfChangeGlacierized(IceModel *m)
      : TSDiag<TSRateDiagnostic, IceModel>(m, "tendency_of_ice_mass_glacierized") {
 
    set_units("kg s-1", "Gt year-1");
    m_variable["long_name"] = "rate of change of the ice mass in glacierized areas";
  }
 
  double compute() {
    double ice_density         = m_config->get_number("constants.ice.density"),
           thickness_threshold = m_config->get_number("output.ice_free_thickness_standard");
    return ice_volume(model->geometry(), thickness_threshold) * ice_density;
  }
};
 
//! \brief Computes the rate of change of the total ice mass due to flow (influx due to
//! prescribed constant-in-time ice thickness).
/*!
 * This is the change in mass resulting from prescribing (fixing) ice thickness.
 */
class IceMassRateOfChangeDueToFlow : public TSDiag<TSFluxDiagnostic, IceModel> {
public:
  IceMassRateOfChangeDueToFlow(IceModel *m)
      : TSDiag<TSFluxDiagnostic, IceModel>(m, "tendency_of_ice_mass_due_to_flow") {
 
    set_units("kg s-1", "Gt year-1");
    m_variable["long_name"] = "rate of change of the mass of ice due to flow"
                              " (i.e. prescribed ice thickness)";
  }
 
  double compute() {
 
    const double ice_density = m_config->get_number("constants.ice.density");
 
    const array::Scalar &dH = model->geometry_evolution().thickness_change_due_to_flow(),
                        &dV = model->geometry_evolution().area_specific_volume_change_due_to_flow();
 
    auto cell_area = m_grid->cell_area();
 
    array::AccessScope list{ &dH, &dV };
 
    double volume_change = 0.0;
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
      // m * m^2 = m^3
      volume_change += (dH(i, j) + dV(i, j)) * cell_area;
    }
 
    // (kg/m^3) * m^3 = kg
    return ice_density * GlobalSum(m_grid->com, volume_change);
  }
};
 
//! \brief Computes the rate of change of the total ice mass.
class IceMassRateOfChange : public TSDiag<TSRateDiagnostic, IceModel> {
public:
  IceMassRateOfChange(IceModel *m) : TSDiag<TSRateDiagnostic, IceModel>(m, "tendency_of_ice_mass") {
 
    set_units("kg s-1", "Gt year-1");
    m_variable["long_name"] = "rate of change of the mass of ice, including seasonal cover";
  }
 
  double compute() {
    const double ice_density = m_config->get_number("constants.ice.density");
    return ice_volume(model->geometry(), 0.0) * ice_density;
  }
};
 
 
//! \brief Computes the total volume of the temperate ice in glacierized areas.
class IceVolumeGlacierizedTemperate : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceVolumeGlacierizedTemperate(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_volume_glacierized_temperate") {
 
    set_units("m3", "m3");
    m_variable["long_name"] = "volume of temperate ice in glacierized areas";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return model->ice_volume_temperate(m_config->get_number("output.ice_free_thickness_standard"));
  }
};
 
//! \brief Computes the total volume of the temperate ice.
class IceVolumeTemperate : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceVolumeTemperate(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_volume_temperate") {
 
    set_units("m3", "m3");
    m_variable["long_name"] = "volume of temperate ice, including seasonal cover";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return model->ice_volume_temperate(0.0);
  }
};
 
//! \brief Computes the total volume of the cold ice in glacierized areas.
class IceVolumeGlacierizedCold : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceVolumeGlacierizedCold(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_volume_glacierized_cold") {
 
    set_units("m3", "m3");
    m_variable["long_name"] = "volume of cold ice in glacierized areas";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return model->ice_volume_cold(m_config->get_number("output.ice_free_thickness_standard"));
  }
};
 
//! \brief Computes the total volume of the cold ice.
class IceVolumeCold : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceVolumeCold(IceModel *m) : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_volume_cold") {
 
    set_units("m3", "m3");
    m_variable["long_name"] = "volume of cold ice, including seasonal cover";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return model->ice_volume_cold(0.0);
  }
};
 
//! \brief Computes the total area of the temperate ice.
class IceAreaGlacierizedTemperateBase : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceAreaGlacierizedTemperateBase(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_area_glacierized_temperate_base") {
 
    set_units("m2", "m2");
    m_variable["long_name"] = "glacierized area where basal ice is temperate";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return model->temperate_base_area(m_config->get_number("output.ice_free_thickness_standard"));
  }
};
 
//! \brief Computes the total area of the cold ice.
class IceAreaGlacierizedColdBase : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceAreaGlacierizedColdBase(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_area_glacierized_cold_base") {
 
    set_units("m2", "m2");
    m_variable["long_name"] = "glacierized area where basal ice is cold";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return model->cold_base_area(m_config->get_number("output.ice_free_thickness_standard"));
  }
};
 
//! \brief Computes the total ice enthalpy in glacierized areas.
class IceEnthalpyGlacierized : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceEnthalpyGlacierized(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_enthalpy_glacierized") {
 
    set_units("J", "J");
    m_variable["long_name"] = "enthalpy of the ice in glacierized areas";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return energy::total_ice_enthalpy(m_config->get_number("output.ice_free_thickness_standard"),
                                      model->energy_balance_model()->enthalpy(),
                                      model->geometry().ice_thickness);
  }
};
 
//! \brief Computes the total ice enthalpy.
class IceEnthalpy : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceEnthalpy(IceModel *m) : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_enthalpy") {
 
    set_units("J", "J");
    m_variable["long_name"] = "enthalpy of the ice, including seasonal cover";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return energy::total_ice_enthalpy(0.0, model->energy_balance_model()->enthalpy(),
                                      model->geometry().ice_thickness);
  }
};
 
//! \brief Computes the total grounded ice area.
class IceAreaGlacierizedGrounded : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceAreaGlacierizedGrounded(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_area_glacierized_grounded") {
 
    if (m_config->get_flag("output.ISMIP6")) {
      m_variable.set_name("iareagr");
    }
 
    set_units("m2", "m2");
    m_variable["long_name"]     = "area of grounded ice in glacierized areas";
    m_variable["standard_name"] = "grounded_ice_sheet_area";
    m_variable["valid_min"]     = { 0.0 };
  }
 
  double compute() {
    return ice_area_grounded(model->geometry(),
                             m_config->get_number("output.ice_free_thickness_standard"));
  }
};
 
//! \brief Computes the total floating ice area.
class IceAreaGlacierizedShelf : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceAreaGlacierizedShelf(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_area_glacierized_floating") {
 
    if (m_config->get_flag("output.ISMIP6")) {
      m_variable.set_name("iareafl");
    }
 
    set_units("m2", "m2");
    m_variable["long_name"]     = "area of ice shelves in glacierized areas";
    m_variable["standard_name"] = "floating_ice_shelf_area";
    m_variable["valid_min"]     = { 0.0 };
  }
 
  double compute() {
    return ice_area_floating(model->geometry(),
                             m_config->get_number("output.ice_free_thickness_standard"));
  }
};
 
//! \brief Computes the total grounded ice volume.
class IceVolumeGlacierizedGrounded : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceVolumeGlacierizedGrounded(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_volume_glacierized_grounded") {
 
    set_units("m3", "m3");
    m_variable["long_name"] = "volume of grounded ice in glacierized areas";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    const auto &cell_type = model->geometry().cell_type;
 
    const array::Scalar &ice_thickness = model->geometry().ice_thickness;
 
    const double thickness_threshold = m_config->get_number("output.ice_free_thickness_standard"),
                 cell_area           = m_grid->cell_area();
 
    array::AccessScope list{ &ice_thickness, &cell_type };
 
    double volume = 0.0;
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      const double H = ice_thickness(i, j);
 
      if (cell_type.grounded(i, j) and H >= thickness_threshold) {
        volume += cell_area * H;
      }
    }
 
    return GlobalSum(m_grid->com, volume);
  }
};
 
//! \brief Computes the total floating ice volume.
class IceVolumeGlacierizedShelf : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  IceVolumeGlacierizedShelf(IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "ice_volume_glacierized_floating") {
 
    set_units("m3", "m3");
    m_variable["long_name"] = "volume of ice shelves in glacierized areas";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    const auto &cell_type = model->geometry().cell_type;
 
    const array::Scalar &ice_thickness = model->geometry().ice_thickness;
 
    const double thickness_threshold = m_config->get_number("output.ice_free_thickness_standard"),
                 cell_area           = m_grid->cell_area();
 
    array::AccessScope list{ &ice_thickness, &cell_type };
 
    double volume = 0.0;
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      const double H = ice_thickness(i, j);
 
      if (cell_type.ocean(i, j) and H >= thickness_threshold) {
        volume += cell_area * H;
      }
    }
 
    return GlobalSum(m_grid->com, volume);
  }
};
 
//! \brief Reports the mass continuity time step.
class TimeStepLength : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  TimeStepLength(const IceModel *m) : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "dt") {
 
    set_units("second", "year");
    m_variable["long_name"] = "mass continuity time step";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return model->dt();
  }
};
 
//! \brief Reports the mass continuity time step.
class TimeStepRatio : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  TimeStepRatio(const IceModel *m) : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "dt_ratio") {
 
    set_units("1", "1");
    m_variable["long_name"] = "ratio of max. allowed time steps "
        "according to CFL and SIA diffusivity criteria";
    m_variable["valid_min"] = { 0.0 };
    m_variable["_FillValue"] = { -1.0 };
  }
 
  double compute() {
 
    const auto *stress_balance = model->stress_balance();
 
    auto cfl_2d = stress_balance->max_timestep_cfl_2d();
    auto cfl_3d = stress_balance->max_timestep_cfl_3d();
 
    auto dt_diff = max_timestep_diffusivity(stress_balance->max_diffusivity(),
                                            model->grid()->dx(),
                                            model->grid()->dy(),
                                            m_config->get_number("time_stepping.adaptive_ratio"));
 
    auto dt_cfl = std::min(cfl_2d.dt_max, cfl_3d.dt_max);
 
    if (dt_cfl.finite() and dt_diff.finite() and dt_diff.value() > 0.0) {
      return dt_cfl.value() / dt_diff.value();
    }
 
    return -1.0;
  }
};
 
//! \brief Reports maximum diffusivity.
class MaxDiffusivity : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  MaxDiffusivity(const IceModel *m) : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "max_diffusivity") {
 
    set_units("m2 s-1", "m2 s-1");
    m_variable["long_name"] = "maximum diffusivity of the flow (usually from the SIA model)";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    return model->stress_balance()->max_diffusivity();
  }
};
 
//! \brief Reports the maximum horizontal absolute velocity component over the grid.
/*!
 * This is the value used by the adaptive time-stepping code in the CFL condition
 * for horizontal advection (i.e. in energy and mass conservation time steps).
 *
 * This is not the maximum horizontal speed, but rather the maximum of components.
 *
 * Note that this picks up the value computed during the time-step taken at a
 * reporting time. (It is not the "average over the reporting interval computed using
 * differencing in time", as other rate-of-change diagnostics.)
 */
class MaxHorizontalVelocity : public TSDiag<TSSnapshotDiagnostic, IceModel> {
public:
  MaxHorizontalVelocity(const IceModel *m)
      : TSDiag<TSSnapshotDiagnostic, IceModel>(m, "max_horizontal_vel") {
 
    set_units("m second-1", "m year-1");
    m_variable["long_name"] = "max(max(abs(u)), max(abs(v))) for the horizontal velocity of ice"
                              " over volume of the ice in last time step during time-series reporting interval";
    m_variable["valid_min"] = { 0.0 };
  }
 
  double compute() {
    CFLData cfl = model->stress_balance()->max_timestep_cfl_3d();
 
    return std::max(cfl.u_max, cfl.v_max);
  }
};
 
/*!
 * Return total mass change due to one of the terms in the mass continuity equation.
 *
 * Possible terms are
 *
 * - SMB: surface mass balance
 * - BMB: basal mass balance
 * - FLOW: ice flow
 * - ERROR: numerical flux needed to preserve non-negativity of thickness
 *
 * This computation can be restricted to grounded and floating areas
 * using the `area` argument.
 *
 * - BOTH: include all contributions
 * - GROUNDED: include grounded areas only
 * - SHELF: include floating areas only
 *
 * When computing mass changes due to flow it is important to remember
 * that ice mass in a cell can be represented by its thickness *or* an
 * "area specific volume". Transferring mass from one representation
 * to the other does not change the mass in a cell. This explains the
 * special case used when `term == FLOW`. (Note that surface and basal
 * mass balances do not affect the area specific volume field.)
 */
double mass_change(const IceModel *model, TermType term, AreaType area) {
  const Grid &grid     = *model->grid();
  const Config &config = *grid.ctx()->config();
 
  const double ice_density = config.get_number("constants.ice.density"),
               cell_area   = grid.cell_area();
 
  const auto &cell_type = model->geometry().cell_type;
 
  const array::Scalar *thickness_change = nullptr;
 
  switch (term) {
  case FLOW:
    thickness_change = &model->geometry_evolution().thickness_change_due_to_flow();
    break;
  case SMB:
    thickness_change = &model->geometry_evolution().top_surface_mass_balance();
    break;
  case BMB:
    thickness_change = &model->geometry_evolution().bottom_surface_mass_balance();
    break;
  case ERROR:
    thickness_change = &model->geometry_evolution().conservation_error();
    break;
  default:
    // can't happen
    throw RuntimeError::formatted(PISM_ERROR_LOCATION, "invalid term type");
  }
 
  const array::Scalar &dV_flow =
      model->geometry_evolution().area_specific_volume_change_due_to_flow();
 
  array::AccessScope list{ &cell_type, thickness_change };
 
  if (term == FLOW) {
    list.add(dV_flow);
  }
 
  double volume_change = 0.0;
  for (auto p = grid.points(); p; p.next()) {
    const int i = p.i(), j = p.j();
 
    if ((area == BOTH) or (area == GROUNDED and cell_type.grounded(i, j)) or
        (area == SHELF and cell_type.ocean(i, j))) {
 
      double dV = term == FLOW ? dV_flow(i, j) : 0.0;
 
      // m^3 = m^2 * m
      volume_change += cell_area * ((*thickness_change)(i, j) + dV);
    }
  }
 
  // (kg / m^3) * m^3 = kg
  return ice_density * GlobalSum(grid.com, volume_change);
}
 
//! \brief Reports the total bottom surface ice flux.
class IceMassFluxBasal : public TSDiag<TSFluxDiagnostic, IceModel> {
public:
  IceMassFluxBasal(const IceModel *m)
      : TSDiag<TSFluxDiagnostic, IceModel>(m, "tendency_of_ice_mass_due_to_basal_mass_flux") {
 
    if (m_config->get_flag("output.ISMIP6")) {
      m_variable.set_name("tendlibmassbf");
    }
 
    set_units("kg s-1", "Gt year-1");
    m_variable["long_name"]     = "total over ice domain of bottom surface ice mass flux";
    m_variable["standard_name"] = "tendency_of_land_ice_mass_due_to_basal_mass_balance";
    m_variable["comment"]       = "positive means ice gain";
  }
 
  double compute() {
    return mass_change(model, BMB, BOTH);
  }
};
 
//! \brief Reports the total top surface ice flux.
class IceMassFluxSurface : public TSDiag<TSFluxDiagnostic, IceModel> {
public:
  IceMassFluxSurface(const IceModel *m)
      : TSDiag<TSFluxDiagnostic, IceModel>(m, "tendency_of_ice_mass_due_to_surface_mass_flux") {
 
    if (m_config->get_flag("output.ISMIP6")) {
      m_variable.set_name("tendacabf");
    }
 
    set_units("kg s-1", "Gt year-1");
    m_variable["long_name"]     = "total over ice domain of top surface ice mass flux";
    m_variable["standard_name"] = "tendency_of_land_ice_mass_due_to_surface_mass_balance";
    m_variable["comment"]       = "positive means ice gain";
  }
 
  double compute() {
    return mass_change(model, SMB, BOTH);
  }
};
 
//! \brief Reports the total basal ice flux over the grounded region.
class IceMassFluxBasalGrounded : public TSDiag<TSFluxDiagnostic, IceModel> {
public:
  IceMassFluxBasalGrounded(const IceModel *m)
      : TSDiag<TSFluxDiagnostic, IceModel>(m, "basal_mass_flux_grounded") {
 
    set_units("kg s-1", "Gt year-1");
    m_variable["long_name"]     = "total over grounded ice domain of basal mass flux";
    m_variable["standard_name"] = "tendency_of_land_ice_mass_due_to_basal_mass_balance";
    m_variable["comment"]       = "positive means ice gain";
  }
 
  double compute() {
    return mass_change(model, BMB, GROUNDED);
  }
};
 
//! \brief Reports the total sub-shelf ice flux.
class IceMassFluxBasalFloating : public TSDiag<TSFluxDiagnostic, IceModel> {
public:
  IceMassFluxBasalFloating(const IceModel *m)
      : TSDiag<TSFluxDiagnostic, IceModel>(m, "basal_mass_flux_floating") {
 
    if (m_config->get_flag("output.ISMIP6")) {
      m_variable.set_name("tendlibmassbffl");
    }
 
    set_units("kg s-1", "Gt year-1");
    m_variable["long_name"]     = "total sub-shelf ice flux";
    m_variable["standard_name"] = "tendency_of_land_ice_mass_due_to_basal_mass_balance";
    m_variable["comment"]       = "positive means ice gain";
  }
 
  double compute() {
    return mass_change(model, BMB, SHELF);
  }
};
 
//! \brief Reports the total numerical mass flux needed to preserve
//! non-negativity of ice thickness.
class IceMassFluxConservationError : public TSDiag<TSFluxDiagnostic, IceModel> {
public:
  IceMassFluxConservationError(const IceModel *m)
      : TSDiag<TSFluxDiagnostic, IceModel>(m, "tendency_of_ice_mass_due_to_conservation_error") {
 
    set_units("kg s-1", "Gt year-1");
    m_variable["long_name"] = "total numerical flux needed to preserve non-negativity"
                              " of ice thickness";
    m_variable["comment"]   = "positive means ice gain";
  }
 
  double compute() {
    return mass_change(model, ERROR, BOTH);
  }
};
 
//! \brief Reports the total discharge flux.
class IceMassFluxDischarge : public TSDiag<TSFluxDiagnostic, IceModel> {
public:
  IceMassFluxDischarge(const IceModel *m)
      : TSDiag<TSFluxDiagnostic, IceModel>(m, "tendency_of_ice_mass_due_to_discharge") {
 
    if (m_config->get_flag("output.ISMIP6")) {
      m_variable.set_name("tendlifmassbf");
    }
 
    set_units("kg s-1", "Gt year-1");
    m_variable["long_name"]     = "discharge flux (frontal melt, calving, forced retreat)";
    m_variable["standard_name"] = "tendency_of_land_ice_mass_due_to_calving_and_ice_front_melting";
    m_variable["comment"]       = "positive means ice gain";
  }
 
  double compute() {
    const double ice_density = m_config->get_number("constants.ice.density");
 
    const array::Scalar &calving        = model->calving();
    const array::Scalar &frontal_melt   = model->frontal_melt();
    const array::Scalar &forced_retreat = model->forced_retreat();
 
    auto cell_area = m_grid->cell_area();
 
    double volume_change = 0.0;
 
    array::AccessScope list{ &calving, &frontal_melt, &forced_retreat };
 
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
      // m^2 * m = m^3
      volume_change += cell_area * (calving(i, j) + frontal_melt(i, j) + forced_retreat(i, j));
    }
 
    // (kg/m^3) * m^3 = kg
    return ice_density * GlobalSum(m_grid->com, volume_change);
  }
};
 
//! \brief Reports the total calving flux.
class IceMassFluxCalving : public TSDiag<TSFluxDiagnostic, IceModel> {
public:
  IceMassFluxCalving(const IceModel *m)
      : TSDiag<TSFluxDiagnostic, IceModel>(m, "tendency_of_ice_mass_due_to_calving") {
 
    if (m_config->get_flag("output.ISMIP6")) {
      m_variable.set_name("tendlicalvf");
    }
 
    set_units("kg s-1", "Gt year-1");
    m_variable["long_name"]     = "calving flux";
    m_variable["standard_name"] = "tendency_of_land_ice_mass_due_to_calving";
    m_variable["comment"]       = "positive means ice gain";
  }
 
  double compute() {
    const double ice_density = m_config->get_number("constants.ice.density");
 
    const array::Scalar &calving = model->calving();
 
    auto cell_area = m_grid->cell_area();
 
    double volume_change = 0.0;
 
    array::AccessScope list{ &calving };
 
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
      // m^2 * m = m^3
      volume_change += cell_area * calving(i, j);
    }
 
    // (kg/m^3) * m^3 = kg
    return ice_density * GlobalSum(m_grid->com, volume_change);
  }
};
 
//! @brief Reports the total flux across the grounding line.
class IceMassFluxAtGroundingLine : public TSDiag<TSFluxDiagnostic, IceModel> {
public:
  IceMassFluxAtGroundingLine(const IceModel *m)
      : TSDiag<TSFluxDiagnostic, IceModel>(m, "grounding_line_flux") {
 
    if (m_config->get_flag("output.ISMIP6")) {
      m_variable.set_name("tendligroundf");
      m_variable["standard_name"] = "tendency_of_grounded_ice_mass";
    }
 
    set_units("kg s-1", "Gt year-1");
    m_variable["long_name"] = "total ice flux across the grounding line";
    m_variable["comment"]   = "negative flux corresponds to ice loss into the ocean";
  }
 
  double compute() {
    return total_grounding_line_flux(model->geometry().cell_type,
                                     model->geometry_evolution().flux_staggered(), model->dt());
  }
};
 
} // end of namespace scalar
 
 
//! \brief Computes dHdt, the ice thickness rate of change.
class ThicknessRateOfChange : public Diag<IceModel> {
public:
  ThicknessRateOfChange(const IceModel *m)
      : Diag<IceModel>(m), m_last_thickness(m_grid, "last_ice_thickness"), m_interval_length(0.0) {
 
    auto ismip6 = m_config->get_flag("output.ISMIP6");
 
    // set metadata:
    m_vars = { { m_sys, ismip6 ? "dlithkdt" : "dHdt" } };
    m_vars[0]
        .long_name("ice thickness rate of change")
        .standard_name("tendency_of_land_ice_thickness")
        .units("m s-1")
        .output_units("m year-1");
 
    auto large_number = to_internal(1e6);
 
    m_vars[0]["valid_range"]  = { -large_number, large_number };
    m_vars[0]["_FillValue"]   = { to_internal(m_fill_value) };
    m_vars[0]["cell_methods"] = "time: mean";
 
    m_last_thickness.metadata(0)
        .long_name(
            "ice thickness at the time of the last report of the rate of change of ice thickness")
        .units("m")
        .standard_name("land_ice_thickness");
  }
 
protected:
  std::shared_ptr<array::Array> compute_impl() const {
 
    auto result        = std::make_shared<array::Scalar>(m_grid, "dHdt");
    result->metadata() = m_vars[0];
 
    if (m_interval_length > 0.0) {
      model->geometry().ice_thickness.add(-1.0, m_last_thickness, *result);
      result->scale(1.0 / m_interval_length);
    } else {
      result->set(m_fill_value);
    }
 
    return result;
  }
 
  void reset_impl() {
    m_interval_length = 0.0;
    m_last_thickness.copy_from(model->geometry().ice_thickness);
  }
 
  void update_impl(double dt) {
    m_interval_length += dt;
  }
 
protected:
  array::Scalar m_last_thickness;
  double m_interval_length;
};
 
//! \brief Computes latitude and longitude bounds.
class LatLonBounds : public Diag<IceModel> {
public:
  LatLonBounds(const IceModel *m, const std::string &var_name, const std::string &proj_string);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
 
  std::string m_var_name, m_proj_string;
};
 
LatLonBounds::LatLonBounds(const IceModel *m, const std::string &var_name,
                           const std::string &proj_string)
    : Diag<IceModel>(m) {
  assert(var_name == "lat" || var_name == "lon");
  m_var_name = var_name;
 
  // set metadata:
  m_vars = { { m_sys, m_var_name + "_bnds", { 0.0, 1.0, 2.0, 3.0 } } };
  m_vars[0].z().clear().set_name("nv4");
 
  m_vars[0].set_time_independent(true);
  if (m_var_name == "lon") {
    m_vars[0].long_name("longitude bounds").units("degree_east");
    m_vars[0]["valid_range"] = { -180, 180 };
  } else {
    m_vars[0].long_name("latitude bounds").units("degree_north");
    m_vars[0]["valid_range"] = { -90, 90 };
  }
 
  m_proj_string = proj_string;
 
#if (Pism_USE_PROJ == 1)
  // create the transformation from the provided projection to lat,lon to check if
  // proj_string is valid.
  Proj crs(m_proj_string, "EPSG:4326");
#endif
  // If PISM_USE_PROJ is not 1 we don't need to check validity of m_proj_string: this diagnostic
  // will not be available and so this code will not run.
}
 
std::shared_ptr<array::Array> LatLonBounds::compute_impl() const {
  std::shared_ptr<array::Array3D> result(new array::Array3D(
      m_grid, m_var_name + "_bnds", array::WITHOUT_GHOSTS, { 0.0, 1.0, 2.0, 3.0 }));
  result->metadata(0) = m_vars[0];
 
  if (m_var_name == "lat") {
    compute_lat_bounds(m_proj_string, *result);
  } else {
    compute_lon_bounds(m_proj_string, *result);
  }
 
  return result;
}
 
class IceAreaFraction : public Diag<IceModel> {
public:
  IceAreaFraction(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
IceAreaFraction::IceAreaFraction(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, land_ice_area_fraction_name } };
  m_vars[0]
      .long_name("fraction of a grid cell covered by ice (grounded or floating)")
      .standard_name("land_ice_area_fraction") // InitMIP "standard" name
      .units("1");
}
 
std::shared_ptr<array::Array> IceAreaFraction::compute_impl() const {
 
  auto result = allocate<array::Scalar>(land_ice_area_fraction_name);
 
  const array::Scalar1 &thickness         = model->geometry().ice_thickness,
                       &surface_elevation = model->geometry().ice_surface_elevation,
                       &bed_topography    = model->geometry().bed_elevation;
 
  const array::CellType1 &cell_type = model->geometry().cell_type;
 
  array::AccessScope list{ &thickness, &surface_elevation, &bed_topography, &cell_type,
                           result.get() };
 
  const bool do_part_grid   = m_config->get_flag("geometry.part_grid.enabled");
  const array::Scalar &Href = model->geometry().ice_area_specific_volume;
  ;
  if (do_part_grid) {
    list.add(Href);
  }
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      if (cell_type.icy(i, j)) {
        // an "icy" cell: the area fraction is one
        (*result)(i, j) = 1.0;
      } else if (cell_type.ice_free_ocean(i, j)) {
        // an ice-free ocean cell may be "partially-filled", in which case we need to compute its
        // ice area fraction by dividing Href by the threshold thickness.
 
        double H_reference = do_part_grid ? Href(i, j) : 0.0;
 
        if (H_reference > 0.0) {
          const double H_threshold =
              part_grid_threshold_thickness(cell_type.star_int(i, j), thickness.star(i, j),
                                            surface_elevation.star(i, j), bed_topography(i, j));
          // protect from a division by zero
          if (H_threshold > 0.0) {
            (*result)(i, j) = std::min(H_reference / H_threshold, 1.0);
          } else {
            (*result)(i, j) = 1.0;
          }
        } else {
          // H_reference is zero
          (*result)(i, j) = 0.0;
        }
      } else {
        // an ice-free-ground cell: the area fraction is zero
        (*result)(i, j) = 0.0;
      }
    } // end of the loop over grid points
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  return result;
}
 
class IceAreaFractionGrounded : public Diag<IceModel> {
public:
  IceAreaFractionGrounded(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
IceAreaFractionGrounded::IceAreaFractionGrounded(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, grounded_ice_sheet_area_fraction_name } };
  m_vars[0]
      .long_name("fraction of a grid cell covered by grounded ice")
      .standard_name("grounded_ice_sheet_area_fraction") // InitMIP "standard" name
      .units("1");
}
 
std::shared_ptr<array::Array> IceAreaFractionGrounded::compute_impl() const {
  auto result = std::make_shared<array::Scalar>(m_grid, grounded_ice_sheet_area_fraction_name);
  result->metadata() = m_vars[0];
 
  const double ice_density   = m_config->get_number("constants.ice.density"),
               ocean_density = m_config->get_number("constants.sea_water.density");
 
  const auto &ice_thickness  = model->geometry().ice_thickness;
  const auto &sea_level      = model->geometry().sea_level_elevation;
  const auto &bed_topography = model->geometry().bed_elevation;
 
  const auto &cell_type = model->geometry().cell_type;
 
  compute_grounded_cell_fraction(ice_density, ocean_density, sea_level, ice_thickness,
                                 bed_topography, *result);
 
  // All grounded areas have the grounded cell fraction of one, so now we make sure that ice-free
  // areas get the value of 0 (they are grounded but not covered by a grounded ice sheet).
 
  array::AccessScope list{ &cell_type, result.get() };
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
      if (cell_type.ice_free(i, j)) {
        (*result)(i, j) = 0.0;
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  return result;
}
 
class IceAreaFractionFloating : public Diag<IceModel> {
public:
  IceAreaFractionFloating(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
IceAreaFractionFloating::IceAreaFractionFloating(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, floating_ice_sheet_area_fraction_name } };
  m_vars[0]
      .long_name("fraction of a grid cell covered by floating ice")
      .standard_name("floating_ice_shelf_area_fraction")
      .units("1");
}
 
std::shared_ptr<array::Array> IceAreaFractionFloating::compute_impl() const {
 
  auto ice_area_fraction      = IceAreaFraction(model).compute();
  auto grounded_area_fraction = IceAreaFractionGrounded(model).compute();
 
  auto result        = ice_area_fraction;
  result->metadata() = m_vars[0];
 
  // Floating area fraction is total area fraction minus grounded area fraction.
  result->add(-1.0, *grounded_area_fraction);
 
  return result;
}
 
//! \brief Computes the 2D height above flotation.
class HeightAboveFloatation : public Diag<IceModel> {
public:
  HeightAboveFloatation(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
HeightAboveFloatation::HeightAboveFloatation(const IceModel *m) : Diag<IceModel>(m) {
 
  // set metadata:
  m_vars = { { m_sys, "height_above_flotation" } };
  m_vars[0].long_name("ice thickness in excess of the maximum floating ice thickness").units("m");
  m_vars[0]["_FillValue"] = { m_fill_value };
  m_vars[0]["comment"]    = "shows how close to floatation the ice is at a given location";
}
 
std::shared_ptr<array::Array> HeightAboveFloatation::compute_impl() const {
 
  auto result = allocate<array::Scalar>("height_above_flotation");
 
  const auto &cell_type = model->geometry().cell_type;
 
  const double ice_density   = m_config->get_number("constants.ice.density"),
               ocean_density = m_config->get_number("constants.sea_water.density");
 
  const auto &sea_level      = model->geometry().sea_level_elevation;
  const auto &ice_thickness  = model->geometry().ice_thickness;
  const auto &bed_topography = model->geometry().bed_elevation;
 
  array::AccessScope list{ &cell_type, result.get(), &ice_thickness, &bed_topography, &sea_level };
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      const double thickness = ice_thickness(i, j), bed = bed_topography(i, j),
                   ocean_depth = sea_level(i, j) - bed;
 
      if (cell_type.icy(i, j) and ocean_depth > 0.0) {
        const double max_floating_thickness = ocean_depth * (ocean_density / ice_density);
        (*result)(i, j)                     = thickness - max_floating_thickness;
      } else {
        (*result)(i, j) = m_fill_value;
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  return result;
}
 
//! \brief Computes the mass per cell.
class IceMass : public Diag<IceModel> {
public:
  IceMass(const IceModel *m);
 
protected:
  virtual std::shared_ptr<array::Array> compute_impl() const;
};
 
IceMass::IceMass(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, "ice_mass" } };
  m_vars[0].long_name("ice mass per cell").units("kg");
  m_vars[0]["_FillValue"] = { m_fill_value };
}
 
std::shared_ptr<array::Array> IceMass::compute_impl() const {
 
  auto result = allocate<array::Scalar>("ice_mass");
 
  const auto &cell_type = model->geometry().cell_type;
 
  const double ice_density = m_config->get_number("constants.ice.density");
 
  const array::Scalar &ice_thickness = model->geometry().ice_thickness;
 
  auto cell_area = m_grid->cell_area();
 
  array::AccessScope list{ &cell_type, result.get(), &ice_thickness };
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      // count all ice, including cells which have so little they
      // are considered "ice-free"
      if (ice_thickness(i, j) > 0.0) {
        (*result)(i, j) = ice_density * ice_thickness(i, j) * cell_area;
      } else {
        (*result)(i, j) = m_fill_value;
      }
    } // end of loop over grid points
 
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  // Add the mass of ice in Href:
  if (m_config->get_flag("geometry.part_grid.enabled")) {
    const array::Scalar &Href = model->geometry().ice_area_specific_volume;
    list.add(Href);
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      if (ice_thickness(i, j) <= 0.0 and Href(i, j) > 0.0) {
        (*result)(i, j) = ice_density * Href(i, j) * cell_area;
      }
    }
  }
 
  return result;
}
 
/*! @brief Sea-level adjusted bed topography (zero at sea level). */
class BedTopographySeaLevelAdjusted : public Diag<IceModel> {
public:
  BedTopographySeaLevelAdjusted(const IceModel *m);
 
protected:
  std::shared_ptr<array::Array> compute_impl() const;
};
 
BedTopographySeaLevelAdjusted::BedTopographySeaLevelAdjusted(const IceModel *m)
    : Diag<IceModel>(m) {
  m_vars = { { m_sys, "topg_sl_adjusted" } };
  m_vars[0].long_name("sea-level adjusted bed topography (zero is at sea level)").units("meters");
}
 
std::shared_ptr<array::Array> BedTopographySeaLevelAdjusted::compute_impl() const {
 
  auto result = allocate<array::Scalar>("topg_sl_adjusted");
 
  const auto &bed       = model->geometry().bed_elevation;
  const auto &sea_level = model->geometry().sea_level_elevation;
 
  array::AccessScope list{ &bed, &sea_level, result.get() };
 
  for (auto p = m_grid->points(); p; p.next()) {
    const int i = p.i(), j = p.j();
 
    (*result)(i, j) = bed(i, j) - sea_level(i, j);
  }
 
  return result;
}
 
/*! @brief Ice hardness computed using the SIA flow law. */
class IceHardness : public Diag<IceModel> {
public:
  IceHardness(const IceModel *m);
 
protected:
  std::shared_ptr<array::Array> compute_impl() const;
};
 
IceHardness::IceHardness(const IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, "hardness", m_grid->z() } };
  m_vars[0]
      .long_name("ice hardness computed using the SIA flow law")
      .set_units_without_validation(
          "Pa s^(1/n)"); // n is the Glen exponent used by the SIA (modifier) flow law
  m_vars[0]["comment"] = "units depend on the Glen exponent used by the flow law";
}
 
std::shared_ptr<array::Array> IceHardness::compute_impl() const {
 
  std::shared_ptr<array::Array3D> result(
      new array::Array3D(m_grid, "hardness", array::WITHOUT_GHOSTS, m_grid->z()));
  result->metadata(0) = m_vars[0];
 
  EnthalpyConverter::Ptr EC = m_grid->ctx()->enthalpy_converter();
 
  const array::Array3D &ice_enthalpy = model->energy_balance_model()->enthalpy();
  const array::Scalar &ice_thickness = model->geometry().ice_thickness;
 
  const rheology::FlowLaw &flow_law = *model->stress_balance()->modifier()->flow_law();
 
  array::AccessScope list{ &ice_enthalpy, &ice_thickness, result.get() };
 
  const unsigned int Mz = m_grid->Mz();
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
      const double *E = ice_enthalpy.get_column(i, j);
      const double H  = ice_thickness(i, j);
 
      double *hardness = result->get_column(i, j);
 
      for (unsigned int k = 0; k < Mz; ++k) {
        const double depth = H - m_grid->z(k);
 
        // EC->pressure() handles negative depths correctly
        const double pressure = EC->pressure(depth);
 
        hardness[k] = flow_law.hardness(E[k], pressure);
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  return result;
}
 
/*! @brief Effective viscosity of ice (3D). */
class IceViscosity : public Diag<IceModel> {
public:
  IceViscosity(IceModel *m);
 
protected:
  std::shared_ptr<array::Array> compute_impl() const;
};
 
IceViscosity::IceViscosity(IceModel *m) : Diag<IceModel>(m) {
  m_vars = { { m_sys, "effective_viscosity", m_grid->z() } };
  m_vars[0]
      .long_name("effective viscosity of ice")
      .units("Pascal second")
      .output_units("kPascal second");
  m_vars[0]["valid_min"]  = { 0.0 };
  m_vars[0]["_FillValue"] = { m_fill_value };
}
 
static inline double square(double x) {
  return x * x;
}
 
std::shared_ptr<array::Array> IceViscosity::compute_impl() const {
 
  std::shared_ptr<array::Array3D> result(
      new array::Array3D(m_grid, "effective_viscosity", array::WITHOUT_GHOSTS, m_grid->z()));
  result->metadata(0) = m_vars[0];
 
  array::Array3D W(m_grid, "wvel", array::WITH_GHOSTS, m_grid->z());
 
  using mask::ice_free;
 
  EnthalpyConverter::Ptr EC = m_grid->ctx()->enthalpy_converter();
 
  const rheology::FlowLaw &flow_law = *model->stress_balance()->modifier()->flow_law();
 
  const array::Scalar &ice_thickness = model->geometry().ice_thickness;
 
  const array::Array3D &ice_enthalpy     = model->energy_balance_model()->enthalpy(),
                       &U                = model->stress_balance()->velocity_u(),
                       &V                = model->stress_balance()->velocity_v(),
                       &W_without_ghosts = model->stress_balance()->velocity_w();
 
  W.copy_from(W_without_ghosts);
 
  const unsigned int Mz = m_grid->Mz();
  const double dx = m_grid->dx(), dy = m_grid->dy();
  const std::vector<double> &z = m_grid->z();
 
  const array::CellType1 &mask = model->geometry().cell_type;
 
  array::AccessScope list{ &U, &V, &W, &ice_enthalpy, &ice_thickness, &mask, result.get() };
 
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      const double *E = ice_enthalpy.get_column(i, j);
      const double H  = ice_thickness(i, j);
 
      const double *u = U.get_column(i, j), *u_n = U.get_column(i, j + 1),
                   *u_e = U.get_column(i + 1, j), *u_s = U.get_column(i, j - 1),
                   *u_w = U.get_column(i - 1, j);
 
      const double *v = V.get_column(i, j), *v_n = V.get_column(i, j + 1),
                   *v_e = V.get_column(i + 1, j), *v_s = V.get_column(i, j - 1),
                   *v_w = V.get_column(i - 1, j);
 
      const double *w = W.get_column(i, j), *w_n = W.get_column(i, j + 1),
                   *w_e = W.get_column(i + 1, j), *w_s = W.get_column(i, j - 1),
                   *w_w = W.get_column(i - 1, j);
 
      auto m                  = mask.star_int(i, j);
      const unsigned int east = ice_free(m.e) ? 0 : 1, west = ice_free(m.w) ? 0 : 1,
                         south = ice_free(m.s) ? 0 : 1, north = ice_free(m.n) ? 0 : 1;
 
      double *viscosity = result->get_column(i, j);
 
      if (ice_free(m.c)) {
        result->set_column(i, j, m_fill_value);
        continue;
      }
 
      for (unsigned int k = 0; k < Mz; ++k) {
        const double depth = H - z[k];
 
        if (depth < 0.0) {
          viscosity[k] = m_fill_value;
          continue;
        }
 
        // EC->pressure() handles negative depths correctly
        const double pressure = EC->pressure(depth);
 
        const double hardness = flow_law.hardness(E[k], pressure);
 
        double u_x = 0.0, v_x = 0.0, w_x = 0.0;
        if (west + east > 0) {
          const double D = 1.0 / (dx * (west + east));
          u_x            = D * (west * (u[k] - u_w[k]) + east * (u_e[k] - u[k]));
          v_x            = D * (west * (v[k] - v_w[k]) + east * (v_e[k] - v[k]));
          w_x            = D * (west * (w[k] - w_w[k]) + east * (w_e[k] - w[k]));
        }
 
        double u_y = 0.0, v_y = 0.0, w_y = 0.0;
        if (south + north > 0) {
          const double D = 1.0 / (dy * (south + north));
          u_y            = D * (south * (u[k] - u_s[k]) + north * (u_n[k] - u[k]));
          v_y            = D * (south * (v[k] - v_s[k]) + north * (v_n[k] - v[k]));
          w_y            = D * (south * (w[k] - w_s[k]) + north * (w_n[k] - w[k]));
        }
 
        double u_z = 0.0, v_z = 0.0, w_z = 0.0;
 
        if (k == 0) {
          const double dz = z[1] - z[0];
          u_z             = (u[1] - u[0]) / dz;
          v_z             = (v[1] - v[0]) / dz;
          w_z             = (w[1] - w[0]) / dz;
        } else if (k == Mz - 1) {
          const double dz = z[Mz - 1] - z[Mz - 2];
          u_z             = (u[Mz - 1] - u[Mz - 2]) / dz;
          v_z             = (v[Mz - 1] - v[Mz - 2]) / dz;
          w_z             = (w[Mz - 1] - w[Mz - 2]) / dz;
        } else {
          const double dz_p = z[k + 1] - z[k], dz_m = z[k] - z[k - 1];
          u_z = 0.5 * ((u[k + 1] - u[k]) / dz_p + (u[k] - u[k - 1]) / dz_m);
          v_z = 0.5 * ((v[k + 1] - v[k]) / dz_p + (v[k] - v[k - 1]) / dz_m);
          w_z = 0.5 * ((w[k + 1] - w[k]) / dz_p + (w[k] - w[k - 1]) / dz_m);
        }
 
        // These should be "epsilon dot", but that's just too long.
        const double eps_xx = u_x, eps_yy = v_y, eps_zz = w_z, eps_xy = 0.5 * (u_y + v_x),
                     eps_xz = 0.5 * (u_z + w_x), eps_yz = 0.5 * (v_z + w_y);
 
        // The second invariant of the 3D strain rate tensor; see equation 4.8 in [@ref
        // GreveBlatter2009]. Unlike secondInvariant_2D(), this code does not make assumptions about
        // the input velocity field: we do not ignore w_x and w_y and do not assume that u_z and v_z
        // are zero.
        const double gamma = (square(eps_xx) + square(eps_yy) + square(eps_zz) +
                              2.0 * (square(eps_xy) + square(eps_xz) + square(eps_yz)));
 
        double nu = 0.0;
        // Note: in PISM gamma has an extra factor of 1/2; compare to
        flow_law.effective_viscosity(hardness, 0.5 * gamma, &nu, NULL);
 
        viscosity[k] = nu;
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  return result;
}
 
/*! @brief Report ice thickness */
class IceThickness : public Diag<IceModel> {
public:
  IceThickness(const IceModel *m) : Diag<IceModel>(m) {
 
    auto ismip6 = m_config->get_flag("output.ISMIP6");
 
    m_vars = { { m_sys, ismip6 ? "lithk" : "thk" } };
 
    m_vars[0].long_name("land ice thickness").standard_name("land_ice_thickness").units("m");
    m_vars[0]["valid_min"] = { 0.0 };
  }
 
protected:
  std::shared_ptr<array::Array> compute_impl() const {
 
    auto result = allocate<array::Scalar>("thk");
 
    result->copy_from(model->geometry().ice_thickness);
 
    return result;
  }
};
 
/*! @brief Report ice top surface elevation */
class IceBottomSurfaceElevation : public Diag<IceModel> {
public:
  IceBottomSurfaceElevation(const IceModel *m) : Diag<IceModel>(m) {
 
    auto ismip6 = m_config->get_flag("output.ISMIP6");
 
    m_vars = { { m_sys, ismip6 ? "base" : "ice_base_elevation" } };
    m_vars[0].long_name("ice bottom surface elevation").units("m");
  }
 
protected:
  std::shared_ptr<array::Array> compute_impl() const {
 
    auto result = allocate<array::Scalar>("ice_base_elevation");
 
    ice_bottom_surface(model->geometry(), *result);
 
    return result;
  }
};
 
/*! @brief Report ice top surface elevation */
class IceSurfaceElevation : public Diag<IceModel> {
public:
  IceSurfaceElevation(const IceModel *m) : Diag<IceModel>(m) {
 
    auto ismip6 = m_config->get_flag("output.ISMIP6");
 
    m_vars = { { m_sys, ismip6 ? "orog" : "usurf" } };
    m_vars[0].long_name("ice top surface elevation").standard_name("surface_altitude").units("m");
  }
 
protected:
  std::shared_ptr<array::Array> compute_impl() const {
    auto result = allocate<array::Scalar>("usurf");
 
    result->copy_from(model->geometry().ice_surface_elevation);
 
    return result;
  }
};
 
/*! @brief Report grounding line flux. */
class GroundingLineFlux : public DiagAverageRate<IceModel> {
public:
  GroundingLineFlux(const IceModel *m) : DiagAverageRate<IceModel>(m, "grounding_line_flux", RATE) {
 
    m_accumulator.metadata()["units"] = "kg m-2";
 
    auto ismip6 = m_config->get_flag("output.ISMIP6");
 
    m_vars = { { m_sys, ismip6 ? "ligroundf" : "grounding_line_flux" } };
 
    m_vars[0]
        .long_name("grounding line flux")
        .units("kg m-2 second-1")
        .output_units("kg m-2 year-1");
    m_vars[0]["cell_methods"] = "time: mean";
 
    m_vars[0]["_FillValue"] = {to_internal(m_fill_value)};
    m_vars[0]["comment"] =
      "Positive flux corresponds to mass moving from the ocean to"
      " an icy grounded area. This convention makes it easier to compare"
      " grounding line flux to the total discharge into the ocean";
  }
 
protected:
  void update_impl(double dt) {
    bool add_values = true;
    grounding_line_flux(model->geometry().cell_type,
                        model->geometry_evolution().flux_staggered(),
                        dt,
                        add_values,
                        m_accumulator);
 
    m_interval_length += dt;
  }
};
 
 
} // end of namespace diagnostics
 
void IceModel::init_diagnostics() {
 
  using namespace diagnostics;
 
  typedef Diagnostic      d;
  typedef Diagnostic::Ptr f;    // "f" for "field"
  m_diagnostics = {
    // geometry
    {"cell_grounded_fraction",              d::wrap(m_geometry.cell_grounded_fraction)},
    {"height_above_flotation",              f(new HeightAboveFloatation(this))},
    {"ice_area_specific_volume",            d::wrap(m_geometry.ice_area_specific_volume)},
    {"ice_mass",                            f(new IceMass(this))},
    {"lat",                                 d::wrap(m_geometry.latitude)},
    {"lon",                                 d::wrap(m_geometry.longitude)},
    {"mask",                                d::wrap(m_geometry.cell_type)},
    {"thk",                                 f(new IceThickness(this))},
    {"topg_sl_adjusted",                    f(new BedTopographySeaLevelAdjusted(this))},
    {"usurf",                               f(new IceSurfaceElevation(this))},
    {"ice_base_elevation",                  f(new IceBottomSurfaceElevation(this))},
    {floating_ice_sheet_area_fraction_name, f(new IceAreaFractionFloating(this))},
    {grounded_ice_sheet_area_fraction_name, f(new IceAreaFractionGrounded(this))},
    {land_ice_area_fraction_name,           f(new IceAreaFraction(this))},
 
    // temperature, enthalpy, and liquid water fraction
    {"enthalpybase", f(new IceEnthalpyBasal(this))},
    {"enthalpysurf", f(new IceEnthalpySurface(this))},
    {"bedtoptemp",   d::wrap(m_bedtoptemp)},
    {"cts",          f(new CTS(this))},
    {"liqfrac",      f(new LiquidFraction(this))},
    {"temp",         f(new Temperature(this))},
    {"temp_pa",      f(new TemperaturePA(this))},
    {"tempbase",     f(new TemperatureBasal(this, BOTH))},
    {"temppabase",   f(new TemperaturePABasal(this))},
    {"tempsurf",     f(new TemperatureSurface(this))},
 
    // rheology-related stuff
    {"tempicethk",          f(new TemperateIceThickness(this))},
    {"tempicethk_basal",    f(new TemperateIceThicknessBasal(this))},
    {"hardav",              f(new HardnessAverage(this))},
    {"hardness",            f(new IceHardness(this))},
    {"effective_viscosity", f(new IceViscosity(this))},
 
    // boundary conditions
    {"vel_bc_mask",                    d::wrap(m_velocity_bc_mask)},
    {"vel_bc_values",                  d::wrap(m_velocity_bc_values)},
    {"ice_margin_pressure_difference", f(new IceMarginPressureDifference(this))},
    {"thk_bc_mask",                    d::wrap(m_ice_thickness_bc_mask)},
 
    // balancing the books
    // tendency_of_ice_amount = (tendency_of_ice_amount_due_to_flow +
    //                           tendency_of_ice_amount_due_to_conservation_error +
    //                           tendency_of_ice_amount_due_to_surface_mass_balance +
    //                           tendency_of_ice_amount_due_to_basal_mass_balance +
    //                           tendency_of_ice_amount_due_to_discharge)
    //
    // Also,
    // tendency_of_ice_amount_due_to_discharge = (tendency_of_ice_amount_due_to_calving +
    //                                            tendency_of_ice_amount_due_to_frontal_melt +
    //                                            tendency_of_ice_amount_due_to_forced_retreat)
    {"tendency_of_ice_amount",                           f(new TendencyOfIceAmount(this,          AMOUNT))},
    {"tendency_of_ice_amount_due_to_flow",               f(new TendencyOfIceAmountDueToFlow(this, AMOUNT))},
    {"tendency_of_ice_amount_due_to_conservation_error", f(new ConservationErrorFlux(this,        AMOUNT))},
    {"tendency_of_ice_amount_due_to_surface_mass_flux",  f(new SurfaceFlux(this,                  AMOUNT))},
    {"tendency_of_ice_amount_due_to_basal_mass_flux",    f(new BasalFlux(this,                    AMOUNT))},
    {"tendency_of_ice_amount_due_to_discharge",          f(new DischargeFlux(this,                AMOUNT))},
    {"tendency_of_ice_amount_due_to_calving",            f(new CalvingFlux(this,                  AMOUNT))},
    {"tendency_of_ice_amount_due_to_frontal_melt",       f(new FrontalMeltFlux(this,              AMOUNT))},
    {"tendency_of_ice_amount_due_to_forced_retreat",     f(new ForcedRetreatFlux(this,            AMOUNT))},
 
    // same, in terms of mass
    // tendency_of_ice_mass = (tendency_of_ice_mass_due_to_flow +
    //                         tendency_of_ice_mass_due_to_conservation_error +
    //                         tendency_of_ice_mass_due_to_surface_mass_flux +
    //                         tendency_of_ice_mass_due_to_basal_mass_balance +
    //                         tendency_of_ice_mass_due_to_discharge)
    //
    // Also,
    // tendency_of_ice_mass_due_to_discharge = (tendency_of_ice_mass_due_to_calving +
    //                                          tendency_of_ice_mass_due_to_frontal_melt +
    //                                          tendency_of_ice_mass_due_to_forced_retreat)
    {"tendency_of_ice_mass",                           f(new TendencyOfIceAmount(this,          MASS))},
    {"tendency_of_ice_mass_due_to_flow",               f(new TendencyOfIceAmountDueToFlow(this, MASS))},
    {"tendency_of_ice_mass_due_to_conservation_error", f(new ConservationErrorFlux(this,        MASS))},
    {"tendency_of_ice_mass_due_to_surface_mass_flux",  f(new SurfaceFlux(this,                  MASS))},
    {"tendency_of_ice_mass_due_to_basal_mass_flux",    f(new BasalFlux(this,                    MASS))},
    {"tendency_of_ice_mass_due_to_discharge",          f(new DischargeFlux(this,                MASS))},
    {"tendency_of_ice_mass_due_to_calving",            f(new CalvingFlux(this,                  MASS))},
    {"tendency_of_ice_mass_due_to_frontal_melt",       f(new FrontalMeltFlux(this,              MASS))},
    {"tendency_of_ice_mass_due_to_forced_retreat",     f(new ForcedRetreatFlux(this,            MASS))},
 
    // other rates and fluxes
    {"basal_mass_flux_grounded", f(new BMBSplit(this, GROUNDED))},
    {"basal_mass_flux_floating", f(new BMBSplit(this, SHELF))},
    {"dHdt",                     f(new ThicknessRateOfChange(this))},
    {"bmelt",                    d::wrap(m_basal_melt_rate)},
    {"grounding_line_flux",      f(new GroundingLineFlux(this))},
 
    // misc
    {"rank", f(new Rank(this))},
  };
 
#if (Pism_USE_PROJ==1)
  std::string proj = m_grid->get_mapping_info().proj;
  if (not proj.empty()) {
    m_diagnostics["lat_bnds"] = f(new LatLonBounds(this, "lat", proj));
    m_diagnostics["lon_bnds"] = f(new LatLonBounds(this, "lon", proj));
  }
#endif
 
  // add ISMIP6 variable names
  if (m_config->get_flag("output.ISMIP6")) {
    m_diagnostics["base"]        = m_diagnostics["ice_base_elevation"];
    m_diagnostics["lithk"]       = m_diagnostics["thk"];
    m_diagnostics["dlithkdt"]    = m_diagnostics["dHdt"];
    m_diagnostics["orog"]        = m_diagnostics["usurf"];
    m_diagnostics["acabf"]       = m_diagnostics["tendency_of_ice_amount_due_to_surface_mass_flux"];
    m_diagnostics["libmassbfgr"] = m_diagnostics["basal_mass_flux_grounded"];
    m_diagnostics["libmassbffl"] = m_diagnostics["basal_mass_flux_floating"];
    m_diagnostics["lifmassbf"]   = m_diagnostics["tendency_of_ice_amount_due_to_discharge"];
    m_diagnostics["licalvf"]     = m_diagnostics["tendency_of_ice_amount_due_to_calving"];
    m_diagnostics["litempbotgr"] = f(new TemperatureBasal(this, GROUNDED));
    m_diagnostics["litempbotfl"] = f(new TemperatureBasal(this, SHELF));
    m_diagnostics["ligroundf"]   = m_diagnostics["grounding_line_flux"];
  }
 
  typedef TSDiagnostic::Ptr s; // "s" for "scalar"
  m_ts_diagnostics = {
    // area
    {"ice_area_glacierized",                s(new scalar::IceAreaGlacierized(this))},
    {"ice_area_glacierized_cold_base",      s(new scalar::IceAreaGlacierizedColdBase(this))},
    {"ice_area_glacierized_grounded",       s(new scalar::IceAreaGlacierizedGrounded(this))},
    {"ice_area_glacierized_floating",       s(new scalar::IceAreaGlacierizedShelf(this))},
    {"ice_area_glacierized_temperate_base", s(new scalar::IceAreaGlacierizedTemperateBase(this))},
    // mass
    {"ice_mass_glacierized",             s(new scalar::IceMassGlacierized(this))},
    {"ice_mass",                         s(new scalar::IceMass(this))},
    {"tendency_of_ice_mass_glacierized", s(new scalar::IceMassRateOfChangeGlacierized(this))},
    {"limnsw",                           s(new scalar::IceMassNotDisplacingSeaWater(this))},
    // volume
    {"ice_volume_glacierized",             s(new scalar::IceVolumeGlacierized(this))},
    {"ice_volume_glacierized_cold",        s(new scalar::IceVolumeGlacierizedCold(this))},
    {"ice_volume_glacierized_grounded",    s(new scalar::IceVolumeGlacierizedGrounded(this))},
    {"ice_volume_glacierized_floating",    s(new scalar::IceVolumeGlacierizedShelf(this))},
    {"ice_volume_glacierized_temperate",   s(new scalar::IceVolumeGlacierizedTemperate(this))},
    {"ice_volume",                         s(new scalar::IceVolume(this))},
    {"ice_volume_cold",                    s(new scalar::IceVolumeCold(this))},
    {"ice_volume_temperate",               s(new scalar::IceVolumeTemperate(this))},
    {"tendency_of_ice_volume_glacierized", s(new scalar::IceVolumeRateOfChangeGlacierized(this))},
    {"tendency_of_ice_volume",             s(new scalar::IceVolumeRateOfChange(this))},
    {"sea_level_rise_potential",           s(new scalar::SeaLevelRisePotential(this))},
    // energy
    {"ice_enthalpy_glacierized", s(new scalar::IceEnthalpyGlacierized(this))},
    {"ice_enthalpy",         s(new scalar::IceEnthalpy(this))},
    // time-stepping
    {"max_diffusivity", s(new scalar::MaxDiffusivity(this))},
    {"max_horizontal_vel", s(new scalar::MaxHorizontalVelocity(this))},
    {"dt",              s(new scalar::TimeStepLength(this))},
    {"dt_ratio",        s(new scalar::TimeStepRatio(this))},
    // balancing the books
    {"tendency_of_ice_mass",                           s(new scalar::IceMassRateOfChange(this))},
    {"tendency_of_ice_mass_due_to_flow",               s(new scalar::IceMassRateOfChangeDueToFlow(this))},
    {"tendency_of_ice_mass_due_to_conservation_error", s(new scalar::IceMassFluxConservationError(this))},
    {"tendency_of_ice_mass_due_to_basal_mass_flux",    s(new scalar::IceMassFluxBasal(this))},
    {"tendency_of_ice_mass_due_to_surface_mass_flux",  s(new scalar::IceMassFluxSurface(this))},
    {"tendency_of_ice_mass_due_to_discharge",          s(new scalar::IceMassFluxDischarge(this))},
    {"tendency_of_ice_mass_due_to_calving",            s(new scalar::IceMassFluxCalving(this))},
    // other fluxes
    {"basal_mass_flux_grounded", s(new scalar::IceMassFluxBasalGrounded(this))},
    {"basal_mass_flux_floating", s(new scalar::IceMassFluxBasalFloating(this))},
    {"grounding_line_flux",      s(new scalar::IceMassFluxAtGroundingLine(this))},
  };
 
  // add ISMIP6 variable names
  if (m_config->get_flag("output.ISMIP6")) {
    m_ts_diagnostics["iareafl"]         = m_ts_diagnostics["ice_area_glacierized_floating"];
    m_ts_diagnostics["iareagr"]         = m_ts_diagnostics["ice_area_glacierized_grounded"];
    m_ts_diagnostics["lim"]             = m_ts_diagnostics["ice_mass"];
    m_ts_diagnostics["tendacabf"]       = m_ts_diagnostics["tendency_of_ice_mass_due_to_surface_mass_flux"];
    m_ts_diagnostics["tendlibmassbf"]   = m_ts_diagnostics["tendency_of_ice_mass_due_to_basal_mass_flux"];
    m_ts_diagnostics["tendlibmassbffl"] = m_ts_diagnostics["basal_mass_flux_floating"];
    m_ts_diagnostics["tendlicalvf"]     = m_ts_diagnostics["tendency_of_ice_mass_due_to_calving"];
    m_ts_diagnostics["tendlifmassbf"]   = m_ts_diagnostics["tendency_of_ice_mass_due_to_discharge"];
    m_ts_diagnostics["tendligroundf"]   = m_ts_diagnostics["grounding_line_flux"];
  }
 
  // get diagnostics from submodels
  for (auto m : m_submodels) {
    m_diagnostics = pism::combine(m_diagnostics, m.second->diagnostics());
    m_ts_diagnostics = pism::combine(m_ts_diagnostics, m.second->ts_diagnostics());
  }
}
 
typedef std::map<std::string, std::vector<VariableMetadata>> Metadata;
 
static void print_diagnostics(const Logger &log, const Metadata &list) {
  for (const auto &d : list) {
    const std::string &name = d.first;
    log.message(1, " Name: %s\n", name.c_str());
 
    for (const auto &v : d.second) {
 
      std::string
        var_name     = v.get_name(),
        units        = v["units"],
        output_units = v["output_units"],
        long_name    = v["long_name"],
        comment      = v["comment"];
 
      if (not output_units.empty()) {
        units = output_units;
      }
 
      log.message(1, "   %s [%s]\n", var_name.c_str(), units.c_str());
      log.message(1, "    %s\n", long_name.c_str());
      if (not comment.empty()) {
        log.message(1, "    %s\n", comment.c_str());
      }
    }
    log.message(1, "\n");
  }
}
 
static void print_diagnostics_json(const Logger &log, const Metadata &list) {
  log.message(1, "{\n");
  bool first_diagnostic = true;
  for (const auto &d : list) {
 
    if (not first_diagnostic) {
      log.message(1, ",\n");
    } else {
      first_diagnostic = false;
    }
 
    log.message(1, "\"%s\" : [\n", d.first.c_str());
 
    bool first_variable = true;
    for (const auto &variable : d.second) {
 
      std::string
        var_name      = variable.get_name(),
        units         = variable["units"],
        output_units  = variable["output_units"],
        long_name     = variable["long_name"],
        standard_name = variable["standard_name"],
        comment       = variable["comment"];
 
      if (not output_units.empty()) {
        units = output_units;
      }
 
      if (not first_variable) {
        log.message(1, ",\n");
      } else {
        first_variable = false;
      }
 
      log.message(1, "[\"%s\", \"%s\", \"%s\", \"%s\", \"%s\"]",
                  var_name.c_str(), units.c_str(), long_name.c_str(), standard_name.c_str(), comment.c_str());
    }
    log.message(1, "]");
  }
  log.message(1, "}\n");
}
 
/*!
 * Return metadata of 2D and 3D diagnostics.
 */
static Metadata diag_metadata(const std::map<std::string,Diagnostic::Ptr> &diags) {
  Metadata result;
 
  for (const auto& f : diags) {
    Diagnostic::Ptr diag = f.second;
 
    for (unsigned int k = 0; k < diag->n_variables(); ++k) {
      result[f.first].push_back(diag->metadata(k));
    }
  }
 
  return result;
}
 
/*!
 * Return metadata of scalar diagnostics.
 */
static Metadata ts_diag_metadata(const std::map<std::string,TSDiagnostic::Ptr> &ts_diags) {
  Metadata result;
 
  for (auto d : ts_diags) {
    // always one variable per diagnostic
    result[d.first] = {d.second->metadata()};
  }
 
  return result;
}
 
void IceModel::list_diagnostics(const std::string &list_type) const {
 
  if (list_type == "json") {
    m_log->message(1, "{\n");
 
    m_log->message(1, "\"spatial\" :\n");
    print_diagnostics_json(*m_log, diag_metadata(m_diagnostics));
 
    m_log->message(1, ",\n");        // separator
 
    m_log->message(1, "\"scalar\" :\n");
    print_diagnostics_json(*m_log, ts_diag_metadata(m_ts_diagnostics));
 
    m_log->message(1, "}\n");
 
    return;
  }
 
  if (member(list_type, {"all", "spatial"})) {
    m_log->message(1, "\n");
    m_log->message(1, "======== Available 2D and 3D diagnostics ========\n");
 
    print_diagnostics(*m_log, diag_metadata(m_diagnostics));
  }
 
  if (member(list_type, {"all", "scalar"})) {
    // scalar time-series
    m_log->message(1, "======== Available time-series ========\n");
 
    print_diagnostics(*m_log, ts_diag_metadata(m_ts_diagnostics));
  }
}
 
/*!
  Computes fraction of the base which is melted.
 
  Communication occurs here.
 */
double IceModel::compute_temperate_base_fraction(double total_ice_area) {
 
  EnthalpyConverter::Ptr EC = m_ctx->enthalpy_converter();
 
  auto cell_area = m_grid->cell_area();
 
  double result = 0.0, meltarea = 0.0;
 
  const array::Array3D &enthalpy = m_energy_model->enthalpy();
 
  array::AccessScope list{&enthalpy, &m_geometry.cell_type, &m_geometry.ice_thickness};
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      if (m_geometry.cell_type.icy(i, j)) {
        const double
          E_basal  = enthalpy.get_column(i, j)[0],
          pressure = EC->pressure(m_geometry.ice_thickness(i,j)); // FIXME issue #15
        // accumulate area of base which is at melt point
        if (EC->is_temperate_relaxed(E_basal, pressure)) {
          meltarea += cell_area;
        }
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  // convert from m2 to km2
  meltarea = units::convert(m_sys, meltarea, "m2", "km2");
  // communication
  result = GlobalSum(m_grid->com, meltarea);
 
  // normalize fraction correctly
  if (total_ice_area > 0.0) {
    result = result / total_ice_area;
  } else {
    result = 0.0;
  }
  return result;
}
 
 
/*!
  Computes fraction of the ice which is as old as the start of the run (original).
  Communication occurs here.
 */
double IceModel::compute_original_ice_fraction(double total_ice_volume) {
 
  double result = -1.0;  // result value if not age.enabled
 
  if (not m_age_model) {
    return result;  // leave now
  }
 
  const double a = m_grid->cell_area() * 1e-3 * 1e-3, // area unit (km^2)
    currtime = m_time->current(); // seconds
 
  const array::Array3D &ice_age = m_age_model->age();
 
  array::AccessScope list{&m_geometry.cell_type, &m_geometry.ice_thickness, &ice_age};
 
  const double one_year = units::convert(m_sys, 1.0, "year", "seconds");
  double original_ice_volume = 0.0;
 
  // compute local original volume
  ParallelSection loop(m_grid->com);
  try {
    for (auto p = m_grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      if (m_geometry.cell_type.icy(i, j)) {
        // accumulate volume of ice which is original
        const double *age = ice_age.get_column(i, j);
        const int  ks = m_grid->kBelowHeight(m_geometry.ice_thickness(i,j));
        for (int k = 1; k <= ks; k++) {
          // ice in segment is original if it is as old as one year less than current time
          if (0.5 * (age[k - 1] + age[k]) > currtime - one_year) {
            original_ice_volume += a * 1.0e-3 * (m_grid->z(k) - m_grid->z(k - 1));
          }
        }
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
 
  // communicate to turn into global original fraction
  result = GlobalSum(m_grid->com, original_ice_volume);
 
  // normalize fraction correctly
  if (total_ice_volume > 0.0) {
    result = result / total_ice_volume;
  } else {
    result = 0.0;
  }
  return result;
}
 
namespace details {
enum IceKind {ICE_COLD, ICE_TEMPERATE};
 
static double ice_volume(const array::Scalar &ice_thickness,
                         const array::Array3D &ice_enthalpy,
                         IceKind kind,
                         double thickness_threshold) {
 
  auto grid = ice_thickness.grid();
  auto ctx = grid->ctx();
  auto EC = ctx->enthalpy_converter();
 
  auto cell_area = grid->cell_area();
  const auto& z = grid->z();
 
  double volume = 0.0;
 
  // count the volume of a 3D grid cell if
  //
  // - it is temperate and we're asked for the temperate ice volume
  // - it is cold and we're asked for the cold ice volume
  //
  // return zero otherwise
  //
  // uses the depth at the *bottom* of a cell to compute pressure
  auto volume_counter = [EC, kind, cell_area](double z_min, double z_max, double H, double E) {
    double depth = H - z_min;
    double P = EC->pressure(depth);
    double V = cell_area * (z_max - z_min);
    bool temperate = EC->is_temperate_relaxed(E, P); // FIXME issue #15
 
    switch (kind) {
    case ICE_TEMPERATE:
      return temperate ? V : 0.0;
    default:
    case ICE_COLD:
      return (not temperate) ? V : 0.0;
    }
  };
 
  array::AccessScope list{&ice_thickness, &ice_enthalpy};
  ParallelSection loop(grid->com);
  try {
    for (auto p = grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      double H = ice_thickness(i, j);
 
      if (H >= thickness_threshold) {
        const int ks = grid->kBelowHeight(H);
        const double *E = ice_enthalpy.get_column(i, j);
 
        for (int k = 0; k < ks; ++k) {
          volume += volume_counter(z[k], z[k + 1], H, E[k]);
        }
 
        volume += volume_counter(z[ks], H, H, E[ks]);
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  return GlobalSum(grid->com, volume);
}
 
static double base_area(const array::Scalar &ice_thickness,
                        const array::Array3D &ice_enthalpy,
                        IceKind kind,
                        double thickness_threshold) {
 
  auto grid = ice_thickness.grid();
  auto ctx = grid->ctx();
  auto EC = ctx->enthalpy_converter();
 
  auto cell_area = grid->cell_area();
 
  double area = 0.0;
 
  array::AccessScope list{&ice_thickness, &ice_enthalpy};
  ParallelSection loop(grid->com);
  try {
    for (auto p = grid->points(); p; p.next()) {
      const int i = p.i(), j = p.j();
 
      double thickness = ice_thickness(i, j);
 
      if (thickness >= thickness_threshold) {
        double basal_enthalpy = ice_enthalpy.get_column(i, j)[0];
 
        bool temperate = EC->is_temperate_relaxed(basal_enthalpy,
                                                  EC->pressure(thickness)); // FIXME issue #15
 
        switch (kind) {
        case ICE_TEMPERATE:
          area += temperate ? cell_area : 0.0;
          break;
        default:
        case ICE_COLD:
          area += (not temperate) ? cell_area : 0.0;
        }
      }
    }
  } catch (...) {
    loop.failed();
  }
  loop.check();
 
  return GlobalSum(grid->com, area);
}
 
} // end of namespace details
 
//! Computes the temperate ice volume, in m^3.
double IceModel::ice_volume_temperate(double thickness_threshold) const {
  return details::ice_volume(m_geometry.ice_thickness, m_energy_model->enthalpy(),
                             details::ICE_TEMPERATE, thickness_threshold);
}
 
//! Computes the cold ice volume, in m^3.
double IceModel::ice_volume_cold(double thickness_threshold) const {
  return details::ice_volume(m_geometry.ice_thickness, m_energy_model->enthalpy(),
                             details::ICE_COLD, thickness_threshold);
}
 
//! Computes area of basal ice which is temperate, in m^2.
double IceModel::temperate_base_area(double thickness_threshold) const {
  return details::base_area(m_geometry.ice_thickness, m_energy_model->enthalpy(),
                            details::ICE_TEMPERATE, thickness_threshold);
}
 
//! Computes area of basal ice which is cold, in m^2.
double IceModel::cold_base_area(double thickness_threshold) const {
  return details::base_area(m_geometry.ice_thickness, m_energy_model->enthalpy(),
                            details::ICE_COLD, thickness_threshold);
}
 
} // end of namespace pism