src/base/stressbalance/PISMStressBalance.hh

Go to the documentation of this file.

// Copyright (C) 2010, 2011 Constantine Khroulev and Ed Bueler
//
// 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 _PISMSTRESSBALANCE_H_
#define _PISMSTRESSBALANCE_H_

#include "PISMComponent.hh"
#include "iceModelVec.hh"
#include "ShallowStressBalance.hh"
#include "SSB_Modifier.hh"
#include "PISMDiagnostic.hh"
#include "PISMOcean.hh"

class PISMStressBalance : public PISMComponent_Diag
{
  friend class PSB_taud_mag;
public:
  PISMStressBalance(IceGrid &g, ShallowStressBalance *sb, SSB_Modifier *ssb_mod,
                    PISMOceanModel *ocean, const NCConfigVariable &config);
  virtual ~PISMStressBalance();

  virtual PetscErrorCode init(PISMVars &vars);


  virtual void add_vars_to_output(string keyword, set<string> &result);

  virtual PetscErrorCode write_variables(set<string> vars, string filename);


  virtual PetscErrorCode set_boundary_conditions(IceModelVec2Int &locations,
                                                 IceModelVec2V &velocities);

  virtual PetscErrorCode set_basal_melt_rate(IceModelVec2S *bmr);

  virtual PetscErrorCode update(bool fast);

  virtual PetscErrorCode get_advective_2d_velocity(IceModelVec2V* &result);

  virtual PetscErrorCode get_diffusive_flux(IceModelVec2Stag* &result);

  virtual PetscErrorCode get_max_diffusivity(PetscReal &D);

  virtual PetscErrorCode get_max_2d_velocity(PetscReal &u, PetscReal &v);

  // for the energy/age time step:

  virtual PetscErrorCode get_3d_velocity(IceModelVec3* &u, IceModelVec3* &v, IceModelVec3* &w);
  virtual PetscErrorCode get_max_3d_velocity(PetscReal &u, PetscReal &v, PetscReal &w);
  virtual PetscErrorCode get_basal_frictional_heating(IceModelVec2S* &result);

  virtual PetscErrorCode get_volumetric_strain_heating(IceModelVec3* &result);

  // for the calving, etc.:

  virtual PetscErrorCode get_principal_strain_rates(
                IceModelVec2S &result_e1, IceModelVec2S &result_e2);

  virtual PetscErrorCode stdout_report(string &result);

  virtual PetscErrorCode extend_the_grid(PetscInt old_Mz);

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

  virtual ShallowStressBalance* get_stressbalance()
  { return stress_balance; }

  virtual SSB_Modifier* get_ssb_modifier()
  { return modifier; }
protected:
  virtual PetscErrorCode allocate();
  virtual PetscErrorCode compute_vertical_velocity(
                IceModelVec3 *u, IceModelVec3 *v, IceModelVec2S *bmr,
                IceModelVec3 &result);

  PISMVars *variables;

  IceModelVec3 w;
  PetscReal w_max;
  IceModelVec2S *basal_melt_rate;

  ShallowStressBalance *stress_balance;
  SSB_Modifier *modifier;
  PISMOceanModel *ocean;
};

#endif /* _PISMSTRESSBALANCE_H_ */