src/coupler/PISMOcean.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 __PISMOceanModel_hh
#define __PISMOceanModel_hh

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

class PISMOceanModel : public PISMComponent_TS {
public:
  PISMOceanModel(IceGrid &g, const NCConfigVariable &conf)
    : PISMComponent_TS(g, conf)
  {
    sea_level = 0;
  }
  virtual ~PISMOceanModel() {};
  virtual PetscErrorCode sea_level_elevation(PetscReal &result) = 0;
  virtual PetscErrorCode shelf_base_temperature(IceModelVec2S &result) = 0;
  virtual PetscErrorCode shelf_base_mass_flux(IceModelVec2S &result) = 0;
protected:
  PetscReal sea_level;
};

class POConstant : public PISMOceanModel {
public:
  POConstant(IceGrid &g, const NCConfigVariable &conf);
  virtual ~POConstant() {}
  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 sea_level_elevation(PetscReal &result);
  virtual PetscErrorCode shelf_base_temperature(IceModelVec2S &result);
  virtual PetscErrorCode shelf_base_mass_flux(IceModelVec2S &result);

  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);
protected:
  IceModelVec2S *ice_thickness; // is not owned by this class
  NCSpatialVariable shelfbmassflux, shelfbtemp;
};


class POConstantPIK : public PISMOceanModel {
public:
  POConstantPIK(IceGrid &g, const NCConfigVariable &conf);
  virtual ~POConstantPIK() {}
  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 sea_level_elevation(PetscReal &result);
  virtual PetscErrorCode shelf_base_temperature(IceModelVec2S &result);
  virtual PetscErrorCode shelf_base_mass_flux(IceModelVec2S &result);

  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);
protected:
  IceModelVec2S *ice_thickness; // is not owned by this class
  NCSpatialVariable shelfbmassflux, shelfbtemp;
};

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

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

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

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

};


#endif  // __PISMOceanModel_hh