Thyra_IfpackPreconditionerFactory.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_IFPACK_PRECONDITIONER_FACTORY_DECL_HPP
00031 #define THYRA_IFPACK_PRECONDITIONER_FACTORY_DECL_HPP
00032 
00033 #include "Thyra_PreconditionerFactoryBase.hpp"
00034 #include "Thyra_EpetraOperatorViewExtractorBase.hpp"
00035 #include "Teuchos_StandardCompositionMacros.hpp"
00036 #include "Ifpack.h"
00037 
00038 namespace Thyra {
00039 
00044 class IfpackPreconditionerFactory : public PreconditionerFactoryBase<double> {
00045 public:
00046 
00049 
00051   IfpackPreconditionerFactory();
00052     
00061   STANDARD_COMPOSITION_MEMBERS( EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor );
00062 
00064 
00067 
00069   bool isCompatible( const LinearOpSourceBase<double> &fwdOpSrc ) const;
00071   bool applySupportsConj(EConj conj) const;
00073   bool applyTransposeSupportsConj(EConj conj) const;
00075   Teuchos::RCP<PreconditionerBase<double> > createPrec() const;
00077   void initializePrec(
00078     const Teuchos::RCP<const LinearOpSourceBase<double> >    &fwdOpSrc
00079     ,PreconditionerBase<double>                                      *prec
00080     ,const ESupportSolveUse                                           supportSolveUse
00081     ) const;
00083   void uninitializePrec(
00084     PreconditionerBase<double>                                *prec
00085     ,Teuchos::RCP<const LinearOpSourceBase<double> >  *fwdOpSrc
00086     ,ESupportSolveUse                                         *supportSolveUse
00087     ) const;
00088 
00090 
00093 
00095   void setParameterList(Teuchos::RCP<Teuchos::ParameterList> const& paramList);
00097   Teuchos::RCP<Teuchos::ParameterList> getParameterList();
00099   Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
00101   Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
00103   Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
00104 
00106 
00109 
00111   std::string description() const;
00112 
00114 
00115 private:
00116 
00117   // ////////////////////////////////
00118   // Private data members
00119 
00120   Teuchos::RCP<Teuchos::ParameterList>       paramList_;
00121   ::Ifpack::EPrecType                                precType_;
00122   int                                                overlap_;
00123 
00124   // ////////////////////////////////
00125   // Private member functions
00126 
00127   static void initializeTimers();
00128 
00129 };
00130 
00131 } // namespace Thyra
00132 
00133 #endif // THYRA_IFPACK_PRECONDITIONER_FACTORY_DECL_HPP

Generated on Wed Jul 22 13:20:35 2009 for Stratimikos by doxygen 1.5.8