src/base/enthalpyConverter.hh

Go to the documentation of this file.

// Copyright (C) 2009-2011 Andreas Aschwanden, 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 __enthalpyConverter_hh
#define __enthalpyConverter_hh

#include "NCVariable.hh"


class EnthalpyConverter {
public:
  EnthalpyConverter(const NCConfigVariable &config);
  virtual ~EnthalpyConverter() {}

  virtual PetscErrorCode viewConstants(PetscViewer viewer) const;

  virtual double         getPressureFromDepth(double depth) const;
  virtual double         getMeltingTemp(double p) const;
  virtual double         getEnthalpyCTS(double p) const;
  virtual PetscErrorCode getEnthalpyInterval(double p, double &E_s, double &E_l) const;
  virtual double         getCTS(double E, double p) const;

  virtual bool           isTemperate(double E, double p) const;
  virtual bool           isLiquified(double E, double p) const;

  virtual PetscErrorCode getAbsTemp(double E, double p, double &T) const;
  virtual PetscErrorCode getPATemp(double E, double p, double &T_pa) const;

  virtual PetscErrorCode getWaterFraction(double E, double p, double &omega) const;

  virtual PetscErrorCode getEnth(double T, double omega, double p, double &E) const;
  virtual PetscErrorCode getEnthPermissive(double T, double omega, double p, double &E) const;
  virtual PetscErrorCode getEnthAtWaterFraction(double omega, double p, double &E) const;

protected:
  double T_melting, L, c_i, rho_i, g, p_air, beta, T_tol;
  double T_0;
  bool   do_cold_ice_methods;
};



class ICMEnthalpyConverter : public EnthalpyConverter {
public:
  ICMEnthalpyConverter(const NCConfigVariable &config) : EnthalpyConverter(config) {
    do_cold_ice_methods = true;
  }

  virtual ~ICMEnthalpyConverter() {}

  virtual double getMeltingTemp(double /*p*/) const {
    return T_melting; }

  virtual PetscErrorCode getAbsTemp(double E, double /*p*/,
                                    double &T) const {
    T = (E / c_i) + T_0;
    return 0; }

  virtual PetscErrorCode getWaterFraction(double /*E*/, double /*p*/,
                                          double &omega) const {
    omega = 0.0;
    return 0; }

  virtual PetscErrorCode getEnth(double T, double /*omega*/, double /*p*/, 
                                 double &E) const {
    E = c_i * (T - T_0);
    return 0; }

  virtual PetscErrorCode getEnthPermissive(double T, double /*omega*/, double /*p*/,
                                           double &E) const {
    E = c_i * (T - T_0);
    return 0; }

  virtual PetscErrorCode getEnthAtWaterFraction(double /*omega*/, double p,
                                                double &E) const {
    E = getEnthalpyCTS(p);
    return 0; }

  virtual bool isTemperate(double /*E*/, double /*p*/) const {
    return false; }
};


#endif // __enthalpyConverter_hh