Thyra_MLPreconditionerFactory.hpp

00001 /*@HEADER
00002 // ***********************************************************************
00003 // 
00004 //       Ifpack: Object-Oriented Algebraic Preconditioner Package
00005 //                 Copyright (2002) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 //@HEADER
00028 */
00029 
00030 #ifndef THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
00031 #define THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
00032 
00033 
00034 #include "Thyra_PreconditionerFactoryBase.hpp"
00035 #include "Thyra_EpetraOperatorViewExtractorBase.hpp"
00036 #include "Teuchos_StandardCompositionMacros.hpp"
00037 
00038 namespace Thyra {
00039 
00040 
00045 class MLPreconditionerFactory : public PreconditionerFactoryBase<double> {
00046 public:
00047 
00050 
00052   MLPreconditionerFactory();
00053     
00062   STANDARD_COMPOSITION_MEMBERS(
00063     EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor );
00064 
00066 
00069 
00071   bool isCompatible( const LinearOpSourceBase<double> &fwdOp ) const;
00073   bool applySupportsConj(EConj conj) const;
00075   bool applyTransposeSupportsConj(EConj conj) const;
00077   Teuchos::RCP<PreconditionerBase<double> > createPrec() const;
00079   void initializePrec(
00080     const Teuchos::RCP<const LinearOpSourceBase<double> > &fwdOp,
00081     PreconditionerBase<double> *prec,
00082     const ESupportSolveUse supportSolveUse
00083     ) const;
00085   void uninitializePrec(
00086     PreconditionerBase<double> *prec
00087     ,Teuchos::RCP<const LinearOpSourceBase<double> > *fwdOp
00088     ,ESupportSolveUse *supportSolveUse
00089     ) const;
00090 
00092 
00095 
00097   void setParameterList(
00098     Teuchos::RCP<Teuchos::ParameterList> const& paramList);
00100   Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
00102   Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
00104   Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
00106   Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
00108 
00111 
00113   std::string description() const;
00114 
00115   // ToDo: Add an override of describe(...) to give more detail!
00116 
00118 
00119 private:
00120 
00121   Teuchos::RCP<Teuchos::ParameterList> paramList_;
00122 
00123 };
00124 
00125 
00126 } // namespace Thyra
00127 
00128 
00129 #endif // THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends
Generated on Wed Apr 13 10:20:45 2011 for Stratimikos by  doxygen 1.6.3