src/base/columnSystem.hh

Go to the documentation of this file.

// Copyright (C) 2009-2011 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 __columnSystem_hh
#define __columnSystem_hh

#include <string>
#include <petsc.h>
#include "iceModelVec.hh"


class columnSystemCtx {

public:
  columnSystemCtx(PetscInt my_nmax, string my_prefix);
  ~columnSystemCtx();

  PetscErrorCode setIndicesAndClearThisColumn(PetscInt i, PetscInt j, PetscInt ks);  

  PetscScalar    norm1(const PetscInt n) const;
  PetscScalar    ddratio(const PetscInt n) const;

  PetscErrorCode viewVectorValues(PetscViewer viewer,
                                  PetscScalar *v, PetscInt m, const char* info) const;
  PetscErrorCode viewMatrix(PetscViewer viewer, const char* info) const;
  PetscErrorCode viewSystem(PetscViewer viewer) const;

  PetscErrorCode reportColumnZeroPivotErrorMFile(const PetscErrorCode errindex);
  PetscErrorCode viewColumnInfoMFile(PetscScalar *x, PetscInt n);
  PetscErrorCode viewColumnInfoMFile(char *filename, PetscScalar *x, PetscInt n);

protected:
  PetscInt    nmax;
  PetscScalar *L, *Lp, *D, *U, *rhs, *work; // vectors for tridiagonal system

  PetscInt    i, j, ks;

  // deliberately protected so only derived classes can use
  PetscErrorCode solveTridiagonalSystem(const PetscInt n, PetscScalar **x);
  
private:
  bool        indicesValid;
  string      prefix;
  PetscErrorCode resetColumn();
};

#endif  /* __columnSystem_hh */