Thyra_PreconditionerBase.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) 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 THYRA_PRECONDITIONER_BASE_HPP
#define THYRA_PRECONDITIONER_BASE_HPP

#include "Thyra_OperatorSolveTypes.hpp"
#include "Teuchos_Describable.hpp"


namespace Thyra {


template<class Scalar>
class PreconditionerBase : virtual public Teuchos::Describable
{
public:


  virtual bool isLeftPrecOpConst() const = 0;

  virtual Teuchos::RCP<LinearOpBase<Scalar> > getNonconstLeftPrecOp() = 0;

  virtual Teuchos::RCP<const LinearOpBase<Scalar> > getLeftPrecOp()const = 0;

  virtual bool isRightPrecOpConst() const = 0;

  virtual Teuchos::RCP<LinearOpBase<Scalar> > getNonconstRightPrecOp() = 0;

  virtual Teuchos::RCP<const LinearOpBase<Scalar> > getRightPrecOp() const = 0;

  virtual bool isUnspecifiedPrecOpConst() const = 0;

  virtual Teuchos::RCP<LinearOpBase<Scalar> > getNonconstUnspecifiedPrecOp() = 0;

  virtual Teuchos::RCP<const LinearOpBase<Scalar> > getUnspecifiedPrecOp() const = 0;
  

private:
  
  // Not defined and not to be called
  PreconditionerBase<Scalar>&
  operator=(const PreconditionerBase<Scalar>&);

};


} // namespace Thyra


#endif // THYRA_PRECONDITIONER_BASE_HPP