Thyra_PreconditionerFactoryBase_decl.hpp

00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
00005 //                 Copyright (2004) 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 #ifndef THYRA_PRECONDITIONER_FACTORY_BASE_DECL_HPP
00030 #define THYRA_PRECONDITIONER_FACTORY_BASE_DECL_HPP
00031 
00032 #include "Thyra_PreconditionerBase.hpp"
00033 #include "Thyra_LinearOpSourceBase.hpp"
00034 #include "Teuchos_Describable.hpp"
00035 #include "Teuchos_ParameterListAcceptor.hpp"
00036 #include "Teuchos_VerboseObject.hpp"
00037 
00038 
00039 namespace Thyra {
00040 
00041 
00049 template<class Scalar>
00050 class PreconditionerFactoryBase
00051   : virtual public Teuchos::Describable,
00052     virtual public Teuchos::ParameterListAcceptor,
00053     virtual public Teuchos::VerboseObject<PreconditionerFactoryBase<Scalar> >
00054 {
00055 public:
00056 
00059 
00063   virtual bool isCompatible(const LinearOpSourceBase<Scalar> &fwdOpSrc) const = 0;
00064 
00074   virtual RCP<PreconditionerBase<Scalar> > createPrec() const = 0;
00075 
00146   virtual void initializePrec(
00147     const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
00148     PreconditionerBase<Scalar> *precOp,
00149     const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
00150     ) const = 0;
00151 
00200   virtual void uninitializePrec(
00201     PreconditionerBase<Scalar> *prec,
00202     RCP<const LinearOpSourceBase<Scalar> > *fwdOpSrc = NULL,
00203     ESupportSolveUse *supportSolveUse = NULL
00204     ) const = 0;
00205   
00207 
00210 
00217   virtual bool applySupportsConj(EConj conj) const;
00218 
00224   virtual bool applyTransposeSupportsConj(EConj conj) const;
00225 
00227 
00228 private:
00229   
00230   // Not defined and not to be called
00231   PreconditionerFactoryBase<Scalar>&
00232   operator=(const PreconditionerFactoryBase<Scalar>&);
00233 
00234 };
00235 
00236 
00237 } // namespace Thyra
00238 
00239 
00240 #endif // THYRA_PRECONDITIONER_FACTORY_BASE_DECL_HPP

Generated on Tue Jul 13 09:26:23 2010 for Thyra by  doxygen 1.4.7