RegionalYieldStress.cc

Go to the documentation of this file.

/* Copyright (C) 2015, 2016, 2017, 2018, 2019, 2022, 2023, 2024, 2025, 2026 PISM Authors
 *
 * This file is part of PISM.
 *
 * PISM is free software; you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * PISM is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with PISM; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#include "pism/regional/RegionalYieldStress.hh"
#include "pism/util/pism_utilities.hh" // pism::combine()
#include "pism/util/MaxTimestep.hh"
#include "pism/util/array/Scalar.hh"
#include "pism/util/Interpolation1D.hh"
 
namespace pism {
 
RegionalYieldStress::RegionalYieldStress(std::shared_ptr<YieldStress> input)
  : YieldStress(input->grid()), m_input(input) {
 
  m_high_tauc = m_config->get_number("regional.no_model_yield_stress", "Pa");
 
  m_name = "regional " + m_input->name();
}
 
/*!
 * Set `basal_yield_stress` to `tauc` in areas indicated using `mask`.
 */
static void set_no_model_yield_stress(double tauc,
                                      const array::Scalar &mask,
                                      array::Scalar &basal_yield_stress) {
  auto grid = mask.grid();
 
  array::AccessScope list{&mask, &basal_yield_stress};
 
  for (auto p : grid->points()) {
    const int i = p.i(), j = p.j();
 
    if (mask(i, j) > 0.5) {
      basal_yield_stress(i, j) = tauc;
    }
  }
}
 
void RegionalYieldStress::restart_impl(const File &input_file, int record) {
  m_input->restart(input_file, record);
 
  // m_basal_yield_stress is a part of the model state for all yield stress models, so the
  // call above should read it in.
  m_basal_yield_stress.copy_from(m_input->basal_material_yield_stress());
 
  array::Scalar no_model_mask(m_grid, "no_model_mask");
  no_model_mask.set_interpolation_type(NEAREST);
  no_model_mask.metadata(0)
      .long_name(
          "mask: zeros (modeling domain) and ones (no-model buffer near grid edges)"); // no units and no standard name
  // We are re-starting a simulation, so the input file has to contain no_model_mask.
  no_model_mask.read(input_file, record);
  // However, the used can set "-regrid_vars no_model_mask,...", so we have to try this,
  // too.
  regrid(name(), no_model_mask);
 
  set_no_model_yield_stress(m_high_tauc, no_model_mask, m_basal_yield_stress);
}
 
void RegionalYieldStress::bootstrap_impl(const File &input_file, const YieldStressInputs &inputs) {
  m_input->bootstrap(input_file, inputs);
 
  m_basal_yield_stress.copy_from(m_input->basal_material_yield_stress());
 
  set_no_model_yield_stress(m_high_tauc, *inputs.no_model_mask, m_basal_yield_stress);
}
 
void RegionalYieldStress::init_impl(const YieldStressInputs &inputs) {
  m_input->init(inputs);
 
  m_basal_yield_stress.copy_from(m_input->basal_material_yield_stress());
 
  set_no_model_yield_stress(m_high_tauc, *inputs.no_model_mask, m_basal_yield_stress);
}
 
void RegionalYieldStress::update_impl(const YieldStressInputs &inputs,
                                      double t, double dt) {
  m_input->update(inputs, t, dt);
 
  m_basal_yield_stress.copy_from(m_input->basal_material_yield_stress());
 
  set_no_model_yield_stress(m_high_tauc, *inputs.no_model_mask, m_basal_yield_stress);
}
 
std::set<VariableMetadata> RegionalYieldStress::state_impl() const {
  auto variables = array::metadata({&m_basal_yield_stress});
 
  return pism::combine(variables, m_input->state());
}
 
void RegionalYieldStress::write_state_impl(const OutputFile &output) const {
  m_input->write_state(output);
  // Write basal yield stress that includes the modification containing high yield stress
  // in "no model" areas, overwriting the field written by m_input.
  m_basal_yield_stress.write(output);
}
 
DiagnosticList RegionalYieldStress::spatial_diagnostics_impl() const {
  // Override the tauc diagnostic with the one that includes the regional modification
  return combine({{"tauc", Diagnostic::wrap(m_basal_yield_stress)}},
                 m_input->spatial_diagnostics());
}
 
MaxTimestep RegionalYieldStress::max_timestep_impl(double t) const {
  auto dt = m_input->max_timestep(t);
 
  if (dt.finite()) {
    return MaxTimestep(dt.value(), name());
  }
 
  return MaxTimestep(name());
}
 
TSDiagnosticList RegionalYieldStress::scalar_diagnostics_impl() const {
  return m_input->scalar_diagnostics();
}
 
} // end of namespace pism