precond.h

Go to the documentation of this file.

// This file is part of HermesCommon
//
// Copyright (c) 2009 hp-FEM group at the University of Nevada, Reno (UNR).
// Email: hpfem-group@unr.edu, home page: http://www.hpfem.org/.
//
// Hermes2D 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.
//
// Hermes2D 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 Hermes2D; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#ifndef __HERMES_COMMON_PRECOND_H_
#define __HERMES_COMMON_PRECOND_H_

#include "common.h"  // Also includes preprocessor definitions for the various
// solver libraries via config.h.

#include "algebra/matrix.h"

#ifdef HAVE_EPETRA
#include <Epetra_Operator.h>
#endif

using namespace Hermes::Algebra;

namespace Hermes
{
  namespace Preconditioners
  {
    enum PreconditionerType
    {
      Jacobi = 0,
      MultiColoredSGS = 1,
      ILU = 2,
      MultiColoredILU = 3,
      IC = 4,
      AIChebyshev = 5,
      MultiElimination = 6,
      SaddlePoint = 7
    };

    template <typename Scalar>
    class Precond
    {
    public:
      virtual ~Precond() {};
    };

    template <typename Scalar>
    class EpetraPrecond : public Precond < Scalar >
#ifdef HAVE_EPETRA
      , public Epetra_Operator
#endif
    {
    public:
      virtual void create(Matrix<Scalar> *mat) = 0;
      virtual void destroy() = 0;
      virtual void compute() = 0;
      virtual void recompute() = 0;

#ifdef HAVE_EPETRA
      virtual Epetra_Operator *get_obj() = 0;

      // Epetra_Operator interface
      virtual int SetUseTranspose(bool UseTranspose) { return 0; }
      virtual int Apply(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const { return 0; }
      virtual int ApplyInverse(const Epetra_MultiVector &r, Epetra_MultiVector &z) const { return 0; }
      virtual double NormInf() const { return 0.0; }
      virtual const char *Label() const { return nullptr; }
      virtual bool UseTranspose() const { return false; }
      virtual bool HasNormInf() const { return false; }
      virtual const Epetra_Comm &Comm() const = 0;
      virtual const Epetra_Map &OperatorDomainMap() const = 0;
      virtual const Epetra_Map &OperatorRangeMap() const = 0;
#endif
    };
  }
}
#endif