src/coupler/PISMAtmosphere.hh

Go to the documentation of this file.

// Copyright (C) 2008-2011 Ed Bueler, Constantine Khroulev, Ricarda Winkelmann,
// Gudfinna Adalgeirsdottir and Andy Aschwanden
//
// 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 __PISMAtmosphere_hh
#define __PISMAtmosphere_hh

#include "PISMComponent.hh"
#include "iceModelVec.hh"
#include "Timeseries.hh"
#include "iceModelVec2T.hh"



class PISMAtmosphereModel : public PISMComponent_TS {
public:
  PISMAtmosphereModel(IceGrid &g, const NCConfigVariable &conf)
    : PISMComponent_TS(g, conf) {};

  virtual PetscErrorCode mean_precip(IceModelVec2S &result) = 0;

  virtual PetscErrorCode mean_annual_temp(IceModelVec2S &result) = 0;

  virtual PetscErrorCode begin_pointwise_access() = 0;
  virtual PetscErrorCode end_pointwise_access() = 0;
  
  virtual PetscErrorCode temp_time_series(int i, int j, int N,
                                          PetscReal *ts, PetscReal *values) = 0;
  virtual PetscErrorCode temp_snapshot(IceModelVec2S &result) = 0;
};


class PAConstant : public PISMAtmosphereModel {
public:
  PAConstant(IceGrid &g, const NCConfigVariable &conf)
    : PISMAtmosphereModel(g, conf) {};
  virtual PetscErrorCode init(PISMVars &vars);
  virtual PetscErrorCode update(PetscReal t_years, PetscReal dt_years)
  { t = t_years; dt = dt_years; return 0; } // do nothing
  virtual PetscErrorCode mean_precip(IceModelVec2S &result);
  virtual PetscErrorCode mean_annual_temp(IceModelVec2S &result);
  virtual PetscErrorCode begin_pointwise_access();
  virtual PetscErrorCode end_pointwise_access();
  virtual PetscErrorCode temp_time_series(int i, int j, int N,
                                          PetscReal *ts, PetscReal *values);
  virtual void add_vars_to_output(string keyword, set<string> &result);
  virtual PetscErrorCode define_variables(set<string> vars, const NCTool &nc, nc_type nctype);
  virtual PetscErrorCode write_variables(set<string> vars, string filename);
  virtual PetscErrorCode temp_snapshot(IceModelVec2S &result);
protected:
  string input_file;
  IceModelVec2S precip, temperature;
  NCSpatialVariable airtemp_var;
};


class PAYearlyCycle : public PISMAtmosphereModel {
public:
  PAYearlyCycle(IceGrid &g, const NCConfigVariable &conf)
    : PISMAtmosphereModel(g, conf) {}
  virtual PetscErrorCode init(PISMVars &vars);
  virtual void add_vars_to_output(string keyword, set<string> &result);
  virtual PetscErrorCode define_variables(set<string> vars, const NCTool &nc, nc_type nctype);
  virtual PetscErrorCode write_variables(set<string> vars, string filename);
  virtual PetscErrorCode update(PetscReal t_years, PetscReal dt_years) = 0;
  virtual PetscErrorCode mean_precip(IceModelVec2S &result);
  virtual PetscErrorCode mean_annual_temp(IceModelVec2S &result);
  virtual PetscErrorCode begin_pointwise_access();
  virtual PetscErrorCode end_pointwise_access();
  virtual PetscErrorCode temp_time_series(int i, int j, int N,
                                          PetscReal *ts, PetscReal *values);
  virtual PetscErrorCode temp_snapshot(IceModelVec2S &result);
protected:
  PISMVars *variables;
  PetscScalar snow_temp_july_day;
  string reference, precip_filename;
  IceModelVec2S temp_ma, temp_mj, precip;
  NCSpatialVariable airtemp_var;
};


class PA_SeaRISE_Greenland : public PAYearlyCycle {
public:
  PA_SeaRISE_Greenland(IceGrid &g, const NCConfigVariable &conf)
    : PAYearlyCycle(g, conf)
  {
    paleo_precipitation_correction = false;
    dTforcing = NULL;
  }

  virtual ~PA_SeaRISE_Greenland()
  {
    delete dTforcing;
  }
  virtual PetscErrorCode init(PISMVars &vars);
  virtual PetscErrorCode update(PetscReal t_years, PetscReal dt_years);
  virtual PetscErrorCode mean_precip(IceModelVec2S &result);
protected:
  bool paleo_precipitation_correction;
  Timeseries *dTforcing;
  IceModelVec2S *lat, *lon, *surfelev;
};

class PAModifier : public Modifier<PISMAtmosphereModel>
{
public:
  PAModifier(IceGrid &g, const NCConfigVariable &conf, PISMAtmosphereModel* in)
    : Modifier<PISMAtmosphereModel>(g, conf, in) {}
  virtual ~PAModifier() {}

  virtual PetscErrorCode mean_precip(IceModelVec2S &result)
  {
    PetscErrorCode ierr = input_model->mean_precip(result); CHKERRQ(ierr);
    return 0;
  }

  virtual PetscErrorCode mean_annual_temp(IceModelVec2S &result)
  {
    PetscErrorCode ierr = input_model->mean_annual_temp(result); CHKERRQ(ierr);
    return 0;
  }

  virtual PetscErrorCode begin_pointwise_access()
  {
    PetscErrorCode ierr = input_model->begin_pointwise_access(); CHKERRQ(ierr);
    return 0;
  }

  virtual PetscErrorCode end_pointwise_access()
  {
    PetscErrorCode ierr = input_model->end_pointwise_access(); CHKERRQ(ierr);
    return 0;
  }
  
  virtual PetscErrorCode temp_time_series(int i, int j, int N,
                                          PetscReal *ts, PetscReal *values)
  {
    PetscErrorCode ierr = input_model->temp_time_series(i, j, N, ts, values); CHKERRQ(ierr);
    return 0;
  }

  virtual PetscErrorCode temp_snapshot(IceModelVec2S &result)
  {
    PetscErrorCode ierr = input_model->temp_snapshot(result); CHKERRQ(ierr);
    return 0;
  }
};


class PAForcing : public PAModifier {
public:
  PAForcing(IceGrid &g, const NCConfigVariable &conf, PISMAtmosphereModel *input);
  virtual ~PAForcing();
  virtual PetscErrorCode max_timestep(PetscReal t_years, PetscReal &dt_years);
  virtual PetscErrorCode init(PISMVars &vars);
  virtual void add_vars_to_output(string keyword, set<string> &result);
  virtual PetscErrorCode define_variables(set<string> vars, const NCTool &nc, nc_type nctype);
  virtual PetscErrorCode write_variables(set<string> vars, string filename);
  virtual PetscErrorCode update(PetscReal t_years, PetscReal dt_years);
  virtual PetscErrorCode mean_precip(IceModelVec2S &result);
  virtual PetscErrorCode mean_annual_temp(IceModelVec2S &result); 
  virtual PetscErrorCode begin_pointwise_access();
  virtual PetscErrorCode end_pointwise_access();  
  virtual PetscErrorCode temp_time_series(int i, int j, int N,
                                          PetscReal *ts, PetscReal *values);
  virtual PetscErrorCode temp_snapshot(IceModelVec2S &result);
protected:
  IceModelVec2T *temp_anomaly, *precip_anomaly;
  NCSpatialVariable airtemp_var;
};


#endif  // __PISMAtmosphere_hh