// Copyright (C) 2004-2014 Jed Brown, 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

#ifndef __iceCompModel_hh
#define __iceCompModel_hh

#include "iceModel.hh"
#include "bedrockThermalUnit.hh"

class BTU_Verification : public PISMBedThermalUnit
{
public:
  BTU_Verification(IceGrid &g, const PISMConfig &conf, int test, int bii)
    : PISMBedThermalUnit(g, conf) { testname = test; bedrock_is_ice = bii; }
  virtual ~BTU_Verification() {}

  virtual PetscErrorCode get_temp(IceModelVec3BTU* &result);
protected:
  virtual PetscErrorCode bootstrap();
  int testname, bedrock_is_ice;
};

class IceCompModel : public IceModel {

public:
  IceCompModel(IceGrid &g, PISMConfig &config, PISMConfig &overrides, int mytest);
  virtual ~IceCompModel() {}
  
  // re-defined steps of init() sequence:
  virtual PetscErrorCode set_grid_defaults();     // called by IceModel::grid_setup()
  virtual PetscErrorCode setFromOptions();
  virtual PetscErrorCode createVecs();
  virtual PetscErrorCode allocate_stressbalance();
  virtual PetscErrorCode allocate_bedrock_thermal_unit();
  virtual PetscErrorCode allocate_bed_deformation();
  virtual PetscErrorCode allocate_enthalpy_converter();
  virtual PetscErrorCode allocate_couplers();
  virtual PetscErrorCode set_vars_from_options(); // called by IceModel::model_state_setup()

  PetscErrorCode reportErrors();

protected:
  // related to all (or most) tests
  PetscBool   exactOnly;
  int          testname;
  virtual PetscErrorCode additionalAtStartTimestep();
  virtual PetscErrorCode additionalAtEndTimestep();
  PetscErrorCode computeGeometryErrors(    // all tests except K
        double &gvolexact, double &gareaexact, double &gdomeHexact,
        double &volerr, double &areaerr,
        double &gmaxHerr, double &gavHerr, double &gmaxetaerr,
        double &centerHerr);
  virtual PetscErrorCode summary(bool tempAndAge);

  // related to tests A B C D E H
  PetscErrorCode initTestABCDEH();
  PetscErrorCode fillSolnTestABCDH();  // only used with exactOnly == PETSC_TRUE
  
  // related to test E
  PetscErrorCode fillSolnTestE();  // only used with exactOnly == PETSC_TRUE
  PetscErrorCode computeBasalVelocityErrors(    // test E only
        double &exactmaxspeed,
        double &gmaxvecerr, double &gavvecerr,
        double &gmaxuberr, double &gmaxvberr);

  PetscErrorCode reset_thickness_tests_AE();

  // related to test L
  IceModelVec2S   vHexactL;
  PetscErrorCode initTestL();
  PetscErrorCode fillSolnTestL();  // only used with exactOnly == PETSC_TRUE

  // related to tests F G; see iCMthermo.cc
  virtual PetscErrorCode temperatureStep(double* vertSacrCount, double* bulgeCount);
  PetscErrorCode initTestFG();
  PetscErrorCode getCompSourcesTestFG();
  PetscErrorCode fillSolnTestFG();  // only used with exactOnly == PETSC_TRUE
  PetscErrorCode computeTemperatureErrors(      // tests F and G
                   double &gmaxTerr, double &gavTerr);
  PetscErrorCode computeBasalTemperatureErrors( // tests F and G
                   double &gmaxTerr, double &gavTerr, double &centerTerr);
  PetscErrorCode compute_strain_heating_errors(            // tests F and G
                   double &gmax_strain_heating_err, double &gav_strain_heating_err);
  PetscErrorCode computeSurfaceVelocityErrors(  // tests F and G
                   double &gmaxUerr, double &gavUerr,  // 2D vector errors
                   double &gmaxWerr, double &gavWerr); // scalar errors
  
  IceModelVec3   strain_heating3_comp;

  // related to tests K and O; see iCMthermo.cc
  PetscErrorCode initTestsKO();
  PetscErrorCode fillTemperatureSolnTestsKO();  // used in initialzation
                                                //   and with exactOnly == PETSC_TRUE
  PetscErrorCode fillBasalMeltRateSolnTestO();  // used only with exactOnly == PETSC_TRUE
  PetscErrorCode computeIceBedrockTemperatureErrors( // tests K and O only
                   double &gmaxTerr, double &gavTerr,
                   double &gmaxTberr, double &gavTberr);
  PetscErrorCode computeBasalMeltRateErrors( // test O only
                   double &gmaxbmelterr, double &gminbmelterr);

  // using Van der Veen's exact solution to test CFBC and the part-grid code
  PetscErrorCode test_V_init();

  static const double secpera;

private:
  double        f;       // ratio of ice density to bedrock density
  PetscBool         bedrock_is_ice_forK;

  // see iCMthermo.cc
  static const double Ggeo;    // J/m^2 s; geothermal heat flux, assumed constant
  static const double ST;      // K m^-1;  surface temperature gradient: T_s = ST * r + Tmin
  static const double Tmin;    // K;       minimum temperature (at center)
  static const double LforFG;  // m;  exact radius of tests F&G ice sheet
  static const double ApforG;  // m;  magnitude A_p of annular perturbation for test G;
  // period t_p is set internally to 2000 years
};

#endif /* __iceCompModel_hh */