src/base/util/PISMComponent.hh

Go to the documentation of this file.

// Copyright (C) 2008-2011 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 2 of the License, or (at your option) any later
// version.
//
// PISM is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
//
// You should have received a copy of the GNU General Public License
// along with PISM; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

#ifndef __PISMComponent_hh
#define __PISMComponent_hh

#include <petsc.h>
#include <gsl/gsl_math.h>
#include "NCVariable.hh"
#include "PISMVars.hh"
#include "grid.hh"
#include "PISMDiagnostic.hh"


class PISMComponent {
public:
  PISMComponent(IceGrid &g, const NCConfigVariable &conf)
    : grid(g), config(conf) {}
  virtual ~PISMComponent() {}

  virtual PetscErrorCode init(PISMVars &vars) = 0;


  virtual void add_vars_to_output(string /*keyword*/, set<string> &/*result*/) {}

  virtual PetscErrorCode define_variables(set<string> /*vars*/, const NCTool &/*nc*/,
                                          nc_type /*nctype*/)
  { return 0; }

  virtual PetscErrorCode write_variables(set<string> /*vars*/, string /*filename*/)
  { return 0; }

  virtual void get_diagnostics(map<string, PISMDiagnostic*> &/*dict*/) {}

  // //! Add pointers to scalar diagnostic quantities to a dictionary.
  // virtual void get_scalar_diagnostics(map<string, PISMDiagnostic_Scalar*> &/*dict*/) {}
protected:
  virtual PetscErrorCode find_pism_input(string &filename, bool &regrid, int &start);
  IceGrid &grid;
  const NCConfigVariable &config;
};


class PISMComponent_Diag : public PISMComponent
{
public:
  PISMComponent_Diag(IceGrid &g, const NCConfigVariable &conf)
    : PISMComponent(g, conf) {}
  virtual ~PISMComponent_Diag() {}

  virtual PetscErrorCode update(bool /*fast*/)
  { return 0; }
};

class PISMComponent_TS : public PISMComponent
{
public:
  PISMComponent_TS(IceGrid &g, const NCConfigVariable &conf)
    : PISMComponent(g, conf)
  { t = dt = GSL_NAN; }
  virtual ~PISMComponent_TS() {}

  virtual PetscErrorCode max_timestep(PetscReal /*t_years*/, PetscReal &dt_years)
  { dt_years = -1; return 0; }

  virtual PetscErrorCode update(PetscReal /*t_years*/, PetscReal /*dt_years*/) = 0;

protected:
  PetscReal t,                  
    dt;                         
};


template<class Model>
class Modifier : public Model
{
public:
  Modifier(IceGrid &g, const NCConfigVariable &conf, Model* in)
    : Model(g, conf), input_model(in) {}
  virtual ~Modifier()
  {
    delete input_model;
  }

  virtual void add_vars_to_output(string keyword, set<string> &result)
  {
    input_model->add_vars_to_output(keyword, result);
  }

  virtual PetscErrorCode define_variables(set<string> vars, const NCTool &nc,
                                          nc_type nctype)
  {
    PetscErrorCode ierr = input_model->define_variables(vars, nc, nctype); CHKERRQ(ierr);
    return 0;
  }

  virtual PetscErrorCode write_variables(set<string> vars, string filename)
  {
    PetscErrorCode ierr = input_model->write_variables(vars, filename); CHKERRQ(ierr);
    return 0;
  }

  virtual void get_diagnostics(map<string, PISMDiagnostic*> &dict)
  {
    input_model->get_diagnostics(dict);
  }

  virtual PetscErrorCode max_timestep(PetscReal t_years, PetscReal &dt_years)
  {
    PetscErrorCode ierr = input_model->max_timestep(t_years, dt_years); CHKERRQ(ierr);
    return 0;
  }

  virtual PetscErrorCode update(PetscReal t_years, PetscReal dt_years)
  {
    Model::t = t_years;
    Model::dt = dt_years;
    PetscErrorCode ierr = input_model->update(t_years, dt_years); CHKERRQ(ierr);
    return 0;
  }

protected:
  Model *input_model;
};

#endif // __PISMComponent_hh