Ifpack_Preconditioner.h

/*@HEADER
// ***********************************************************************
//
//       Ifpack: Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2002) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/

#ifndef IFPACK_PRECONDITIONER_H
#define IFPACK_PRECONDITIONER_H

#include "Ifpack_ConfigDefs.h"
#include "Ifpack_CondestType.h"
#include "Epetra_Object.h"
#include "Epetra_Operator.h"
#include "Teuchos_ParameterList.hpp"
class Epetra_RowMatrix;


class Ifpack_Preconditioner : public Epetra_Operator {

public:

  virtual int SetParameters(Teuchos::ParameterList& List) = 0;

  virtual int Initialize() = 0;

  virtual bool IsInitialized() const = 0;

  virtual int Compute() = 0;

  virtual bool IsComputed() const = 0;

  virtual double Condest(const Ifpack_CondestType CT = Ifpack_Cheap,
                         const int MaxIters = 1550,
                         const double Tol = 1e-9,
             Epetra_RowMatrix* Matrix = 0) = 0;

  virtual double Condest() const = 0;

  virtual int ApplyInverse(const Epetra_MultiVector& X,
               Epetra_MultiVector& Y) const = 0;

  virtual const Epetra_RowMatrix& Matrix() const = 0;

  virtual int NumInitialize() const = 0;

  virtual int NumCompute() const = 0;

  virtual int NumApplyInverse() const = 0;

  virtual double InitializeTime() const = 0;

  virtual double ComputeTime() const = 0;

  virtual double ApplyInverseTime() const = 0;

  virtual double InitializeFlops() const = 0;

  virtual double ComputeFlops() const = 0;

  virtual double ApplyInverseFlops() const = 0;

  virtual ostream& Print(std::ostream& os) const = 0;

};

inline ostream& operator<<(ostream& os, const Ifpack_Preconditioner& obj)
{
  return(obj.Print(os));
}

#endif // IFPACK_PRECONDITIONER_H