Component.cc

Go to the documentation of this file.

// Copyright (C) 2008-2020, 2022, 2023, 2025, 2026 Ed Bueler and 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 <cassert>
 
#include "pism/util/Component.hh"
#include "pism/util/Profiling.hh"
#include "pism/util/io/File.hh"
#include "pism/util/Grid.hh"
#include "pism/util/pism_utilities.hh"
#include "pism/util/VariableMetadata.hh"
#include "pism/util/Config.hh"
#include "pism/util/MaxTimestep.hh"
#include "pism/util/Time.hh"
#include "pism/util/Context.hh"
#include "pism/util/Logger.hh"
#include "pism/util/io/IO_Flags.hh"
 
namespace pism {
 
InputOptions::InputOptions(InitializationType t, const std::string &file, unsigned int index) {
  type     = t;
  filename = file;
  record   = index;
}
 
/*! Process command-line options -i and -bootstrap.
 *
 */
InputOptions process_input_options(MPI_Comm com, std::shared_ptr<const Config> config) {
  InitializationType type = INIT_OTHER;
  unsigned int record     = 0;
 
  std::string input_filename = config->get_string("input.file");
 
  bool bootstrap = config->get_flag("input.bootstrap") and (not input_filename.empty());
  bool restart   = (not config->get_flag("input.bootstrap")) and (not input_filename.empty());
 
  if (restart) {
    // re-start a run by initializing from an input file
    type = INIT_RESTART;
  } else if (bootstrap) {
    // initialize from an input file using bootstrapping heuristics
    type = INIT_BOOTSTRAP;
  } else {
    // other types of initialization (usually from formulas)
    type = INIT_OTHER;
  }
 
  // get the index of the last record in the input file
  if (not input_filename.empty()) {
    File input_file(com, input_filename, io::PISM_NETCDF3, io::PISM_READONLY);
 
    // Find the index of the last record in the input file.
    unsigned int last_record = input_file.nrecords();
    if (last_record > 0) {
      last_record -= 1;
    }
 
    record = last_record;
  } else {
    record = 0;
  }
 
  return InputOptions(type, input_filename, record);
}
 
Component::Component(std::shared_ptr<const Grid> g)
    : m_grid(g),
      m_config(g->ctx()->config()),
      m_sys(g->ctx()->unit_system()),
      m_log(g->ctx()->log()) {
  // empty
}
 
DiagnosticList Component::spatial_diagnostics() const {
  return this->spatial_diagnostics_impl();
}
 
TSDiagnosticList Component::scalar_diagnostics() const {
  return this->scalar_diagnostics_impl();
}
 
DiagnosticList Component::spatial_diagnostics_impl() const {
  return {};
}
 
TSDiagnosticList Component::scalar_diagnostics_impl() const {
  return {};
}
 
std::shared_ptr<const Grid> Component::grid() const {
  return m_grid;
}
 
const Time &Component::time() const {
  return *m_grid->ctx()->time();
}
 
const Profiling &Component::profiling() const {
  return m_grid->ctx()->profiling();
}
 
/*! @brief Write model state variables to an output file. */
void Component::write_state(const OutputFile &output) const {
  this->write_state_impl(output);
}
 
std::set<VariableMetadata> Component::state() const {
  return state_impl();
}
 
std::set<VariableMetadata> Component::state_impl() const {
  return {};
}
 
/*! @brief The default (empty implementation). */
void Component::write_state_impl(const OutputFile &output) const {
  (void) output;
}
 
/**
 * Regrid a variable by processing -regrid_file and -regrid_vars.
 *
 * @param[in] module_name Module name, used to annotate options when run with -help.
 *
 * @param[out] variable pointer to an array::Array; @c variable has to
 *             have metadata set for this to work.
 *
 * @param[in] flag Regridding flag. If set to
 *            REGRID_WITHOUT_REGRID_VARS, regrid this variable by
 *            default, if `-regrid_vars` was not set. Otherwise a
 *            variable is only regridded if both `-regrid_file` and
 *            `-regrid_vars` are set *and* the name of the variable is
 *            found in the set of names given with `-regrid_vars`.
 */
void Component::regrid(const std::string &module_name, array::Array &variable,
                       RegriddingFlag flag) {
 
  auto regrid_file = m_config->get_string("input.regrid.file");
  auto regrid_vars = set_split(m_config->get_string("input.regrid.vars"), ',');
 
  if (regrid_file.empty()) {
    return;
  }
 
  auto &m = variable.metadata();
 
  if (((not regrid_vars.empty()) and set_member(m["short_name"], regrid_vars)) or
      (regrid_vars.empty() and flag == REGRID_WITHOUT_REGRID_VARS)) {
 
    m_log->message(2,
               "  %s: regridding '%s' from file '%s' ...\n",
               module_name.c_str(),
               m.get_string("short_name").c_str(), regrid_file.c_str());
 
    variable.regrid(regrid_file, io::Default::Nil());
  }
}
 
MaxTimestep Component::max_timestep(double t) const {
  return this->max_timestep_impl(t);
}
 
MaxTimestep Component::max_timestep_impl(double t) const {
  (void) t;
  return MaxTimestep();
}
 
 
} // end of namespace pism