Teko Version of the Day
Teko_NeumannSeriesPreconditionerFactoryDecl.hpp
00001 /*
00002 // @HEADER
00003 // 
00004 // ***********************************************************************
00005 // 
00006 //      Teko: A package for block and physics based preconditioning
00007 //                  Copyright 2010 Sandia Corporation 
00008 //  
00009 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00010 // the U.S. Government retains certain rights in this software.
00011 //  
00012 // Redistribution and use in source and binary forms, with or without
00013 // modification, are permitted provided that the following conditions are
00014 // met:
00015 //  
00016 // 1. Redistributions of source code must retain the above copyright
00017 // notice, this list of conditions and the following disclaimer.
00018 //  
00019 // 2. Redistributions in binary form must reproduce the above copyright
00020 // notice, this list of conditions and the following disclaimer in the
00021 // documentation and/or other materials provided with the distribution.
00022 //  
00023 // 3. Neither the name of the Corporation nor the names of the
00024 // contributors may be used to endorse or promote products derived from
00025 // this software without specific prior written permission. 
00026 //  
00027 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00028 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00029 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00030 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00031 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00032 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00033 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00034 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00035 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
00036 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00037 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 //  
00039 // Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
00040 // 
00041 // ***********************************************************************
00042 // 
00043 // @HEADER
00044 
00045 */
00046 
00047 #ifndef __Teko_NeumannSeriesPreconditionerFactoryDecl_hpp__
00048 #define __Teko_NeumannSeriesPreconditionerFactoryDecl_hpp__
00049 
00050 #include "Teuchos_ParameterListAcceptor.hpp"
00051 
00052 // Thyra includes
00053 #include "Thyra_PreconditionerFactoryBase.hpp"
00054 
00055 // Teko includes
00056 #include "Teko_Utilities.hpp"
00057 
00058 namespace Teko {
00059 
00060 using Teuchos::RCP;
00061 
00062 template <typename ScalarT>
00063 class NeumannSeriesPreconditionerFactory
00064    : public virtual Thyra::PreconditionerFactoryBase<ScalarT> {
00065 public:
00066 
00067    NeumannSeriesPreconditionerFactory();
00068 
00070    bool isCompatible(const Thyra::LinearOpSourceBase<ScalarT> &fwdOpSrc) const;
00071 
00073    RCP<Thyra::PreconditionerBase<ScalarT> > createPrec() const;
00074 
00085    void initializePrec(const RCP<const Thyra::LinearOpSourceBase<ScalarT> > & fwdOpSrc,
00086                        const RCP<const Thyra::MultiVectorBase<ScalarT> > & solnVec,
00087                        Thyra::PreconditionerBase<ScalarT> * precOp,
00088                        const Thyra::ESupportSolveUse supportSolveUse) const;
00089 
00098    void initializePrec(const RCP<const Thyra::LinearOpSourceBase<ScalarT> > & fwdOpSrc,
00099                        Thyra::PreconditionerBase<ScalarT> * precOp,
00100                        const Thyra::ESupportSolveUse supportSolveUse) const;
00101 
00103    void uninitializePrec(Thyra::PreconditionerBase<ScalarT> * prec, 
00104                          RCP<const Thyra::LinearOpSourceBase<ScalarT> > * fwdOpSrc,
00105                          Thyra::ESupportSolveUse *supportSolveUse) const;
00106 
00109  
00111    void setParameterList(Teuchos::RCP<Teuchos::ParameterList> const& paramList);
00112 
00114    Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
00115 
00117    Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
00118 
00120    Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
00121 
00123    Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
00125  
00128  
00130    std::string description() const;
00131  
00133   
00134 protected:
00136    Teuchos::RCP<Teuchos::ParameterList> paramList_;
00137 
00138    int numberOfTerms_;
00139    Teko::DiagonalType scalingType_;
00140 };
00141 
00142 } // end namespace Teko
00143 
00144 #endif
 All Classes Files Functions Variables