src/base/stressbalance/SSAFEM.hh

Go to the documentation of this file.

// Copyright (C) 2009--2011 Jed Brown and Ed Bueler and Constantine Khroulev and David Maxwell
//
// 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 _SSAFEM_H_
#define _SSAFEM_H_

#include "SSA.hh"
#include "FETools.hh"
#include <petscsnes.h>


struct FEStoreNode {
  PetscReal H,tauc,hx,hy,b,B;
  PetscInt mask;
};


class SSAFEM;

/* The callbacks from SNES are mediated via SNESDAFormFunction, which has the
 convention that its context argument is a pointer to a struct 
 having a DA as its first entry.  The SSAFEM_SNESCallbackData fulfills 
 this requirement, and allows for passing the callback on to an honest 
 SSAFEM object. */
struct SSAFEM_SNESCallbackData {
  DA           da;
  SSAFEM      *ssa;
};


PetscErrorCode SSAFEFunction(DALocalInfo *, const PISMVector2 **, 
                                                      PISMVector2 **, SSAFEM_SNESCallbackData *);
PetscErrorCode SSAFEJacobian(DALocalInfo *, const PISMVector2 **, Mat, SSAFEM_SNESCallbackData *);

SSA * SSAFEMFactory(IceGrid &, IceBasalResistancePlasticLaw &, 
                  IceFlowLaw &, EnthalpyConverter &, const NCConfigVariable &);


class SSAFEM : public SSA
{
  friend PetscErrorCode SSAFEFunction(DALocalInfo *, const PISMVector2 **, PISMVector2 **, SSAFEM_SNESCallbackData *);
  friend PetscErrorCode SSAFEJacobian(DALocalInfo *, const PISMVector2 **, Mat, SSAFEM_SNESCallbackData *);
public:
  SSAFEM(IceGrid &g, IceBasalResistancePlasticLaw &b, IceFlowLaw &i, EnthalpyConverter &e,
         const NCConfigVariable &c) :
    SSA(g,b,i,e,c), element_index(g)
  {
    quadrature.init(grid);
    PetscErrorCode ierr = allocate_fem();
    if (ierr != 0) {
      PetscPrintf(grid.com, "FATAL ERROR: SSAFEM allocation failed.\n");
      PISMEnd();
    }
  }

  virtual ~SSAFEM()
  {
    deallocate_fem();
  }

  virtual PetscErrorCode init(PISMVars &vars);

protected:
  PetscErrorCode setup();

  virtual PetscErrorCode PointwiseNuHAndBeta(const FEStoreNode *,
                                             const PISMVector2 *,const PetscReal[],
                                             PetscReal *,PetscReal *,PetscReal *,PetscReal *);

  void FixDirichletValues(PetscReal local_bc_mask[],PISMVector2 **BC_vel,
                          PISMVector2 x[], FEDOFMap &my_dofmap);

  virtual PetscErrorCode allocate_fem();

  virtual PetscErrorCode deallocate_fem();

  virtual PetscErrorCode compute_local_function(DALocalInfo *info, const PISMVector2 **xg, PISMVector2 **yg);

  virtual PetscErrorCode compute_local_jacobian(DALocalInfo *info, const PISMVector2 **xg, Mat J);

  virtual PetscErrorCode solve();
  
  virtual PetscErrorCode setFromOptions();

  // objects used internally
  IceModelVec2S hardav;         // vertically-averaged ice hardness
  SSAFEM_SNESCallbackData callback_data;
  Mat J;
  Vec r;

  SNES         snes;
  FEStoreNode *feStore;
  PetscReal    dirichletScale;
  PetscReal    ocean_rho;
  PetscReal    earth_grav;
  PetscReal    m_beta_ice_free_bedrock;
  PetscReal    m_epsilon_ssa;

  FEElementMap element_index;
  FEQuadrature quadrature;
  FEDOFMap dofmap;
};


#endif /* _SSAFEM_H_ */