Thyra_MLPreconditionerFactory.hpp

Go to the documentation of this file.

/*@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 THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
#define THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP


#include "Thyra_PreconditionerFactoryBase.hpp"
#include "Thyra_EpetraOperatorViewExtractorBase.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"

namespace Thyra {


class MLPreconditionerFactory : public PreconditionerFactoryBase<double> {
public:


  MLPreconditionerFactory();
    
  STANDARD_COMPOSITION_MEMBERS(
    EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor );



  bool isCompatible( const LinearOpSourceBase<double> &fwdOp ) const;
  bool applySupportsConj(EConj conj) const;
  bool applyTransposeSupportsConj(EConj conj) const;
  Teuchos::RCP<PreconditionerBase<double> > createPrec() const;
  void initializePrec(
    const Teuchos::RCP<const LinearOpSourceBase<double> > &fwdOp,
    PreconditionerBase<double> *prec,
    const ESupportSolveUse supportSolveUse
    ) const;
  void uninitializePrec(
    PreconditionerBase<double> *prec
    ,Teuchos::RCP<const LinearOpSourceBase<double> > *fwdOp
    ,ESupportSolveUse *supportSolveUse
    ) const;



  void setParameterList(
    Teuchos::RCP<Teuchos::ParameterList> const& paramList);
  Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
  Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
  Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;


  std::string description() const;

  // ToDo: Add an override of describe(...) to give more detail!


private:

  Teuchos::RCP<Teuchos::ParameterList> paramList_;

};


} // namespace Thyra


#endif // THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP