Teko Version of the Day
Teko_PreconditionerInverseFactory.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_PreconditionerInverseFactory_hpp__
00048 #define __Teko_PreconditionerInverseFactory_hpp__
00049 
00050 #include "Teko_InverseFactory.hpp"
00051 
00052 namespace Teko {
00053 
00054 class PreconditionerInverseFactory : public InverseFactory {
00055 public:
00057 
00058    
00068    PreconditionerInverseFactory(const Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > & precFactory,
00069                                 const Teuchos::RCP<Teko::RequestHandler> & rh);
00070 
00085    PreconditionerInverseFactory(const Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > & precFactory,
00086                                 const Teuchos::RCP<const Teuchos::ParameterList> & xtraParam,
00087                                 const Teuchos::RCP<Teko::RequestHandler> & rh);
00088 
00090    PreconditionerInverseFactory(const PreconditionerInverseFactory & pFactory);
00092 
00093    virtual ~PreconditionerInverseFactory() {}
00094 
00107    virtual InverseLinearOp buildInverse(const LinearOp & linearOp) const;
00108 
00121    virtual InverseLinearOp buildInverse(const LinearOp & linearOp, const PreconditionerState & parentState) const;
00122 
00137    virtual void rebuildInverse(const LinearOp & source,InverseLinearOp & dest) const;
00138 
00147    virtual Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
00148 
00163    virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
00164    
00178    virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
00179 
00181    virtual std::string toString() const { return precFactory_->description(); }
00182 
00184    Teuchos::RCP<const Thyra::PreconditionerFactoryBase<double> > getPrecFactory() const
00185    { return precFactory_; }
00186 
00188    Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > getPrecFactory()
00189    { return precFactory_; }
00190 
00199    void setupParameterListFromRequestHandler();
00200 protected:
00201 
00202    Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > precFactory_;
00203    Teuchos::RCP<Teuchos::ParameterList> extraParams_;
00204 
00205 private:
00206    // hide me!
00207    PreconditionerInverseFactory();
00208 };
00209 
00210 }
00211 
00212 #endif
 All Classes Files Functions Variables