Ifpack_Container.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_CONTAINER_H
#define IFPACK_CONTAINER_H

class Epetra_RowMatrix;
class Ifpack_Partitioner;
namespace Teuchos {
  class ParameterList;
}


class Ifpack_Container {

public:

  virtual ~Ifpack_Container() {};

  virtual int NumRows() const = 0;

  virtual int NumVectors() const = 0;

  virtual int SetNumVectors(const int i) = 0;

  virtual double& LHS(const int i, const int Vector = 0) = 0;
  
  virtual double& RHS(const int i, const int Vector = 0) = 0;


  virtual int& ID(const int i) = 0;

  virtual int SetMatrixElement(const int row, const int col,
                   const double value) = 0;

  virtual int Initialize() = 0;

  virtual int Compute(const Epetra_RowMatrix& A) = 0;

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

  virtual bool IsInitialized() const = 0;

  virtual bool IsComputed() const = 0;

  virtual int Apply() = 0;

  virtual int ApplyInverse() = 0;

  virtual const char* Label() const = 0;

  virtual double InitializeFlops() const = 0;

  virtual double ComputeFlops() const = 0;

  virtual double ApplyFlops() const = 0;

  virtual double ApplyInverseFlops() const = 0;

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

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

#endif // IFPACK_CONTAINER_H