Teko Version of the Day
Teko_InverseFactory.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_InverseFactory_hpp__
00048 #define __Teko_InverseFactory_hpp__
00049 
00050 // Teuchos includes
00051 #include "Teuchos_RCP.hpp"
00052 
00053 // Thyra includes
00054 #include "Thyra_LinearOpWithSolveFactoryBase.hpp"
00055 #include "Thyra_PreconditionerFactoryBase.hpp"
00056 
00057 #include "Teko_Config.h"
00058 #include "Teko_Utilities.hpp"
00059 #include "Teko_PreconditionerState.hpp"
00060 #include "Teko_RequestHandler.hpp"
00061 #include "Teko_RequestHandlerContainer.hpp"
00062 
00063 namespace Teko {
00064 
00071 class InverseFactory : public RequestHandlerContainer {
00072 public:
00073    virtual ~InverseFactory() {}
00074 
00084    virtual InverseLinearOp buildInverse(const LinearOp & linearOp) const = 0;
00085 
00098    virtual InverseLinearOp buildInverse(const LinearOp & linearOp,const LinearOp & precOp) const
00099    { return buildInverse(linearOp); }
00100 
00101    #if 0
00102 
00114    virtual InverseLinearOp buildInverse(const LinearOp & linearOp, const PreconditionerState & parentState) const
00115    { return buildInverse(linearOp); }
00116 
00132    virtual InverseLinearOp buildInverse(const LinearOp & linearOp, const LinearOp & precOp, const PreconditionerState & parentState) const
00133    { return buildInverse(linearOp,precOp); }
00134    #endif
00135 
00147    virtual void rebuildInverse(const LinearOp & source,InverseLinearOp & dest) const = 0;
00148 
00161    virtual void rebuildInverse(const LinearOp & source,const LinearOp & precOp,InverseLinearOp & dest) const
00162    { rebuildInverse(source,dest); }
00163 
00172    virtual Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const = 0;
00173 
00175    virtual std::string toString() const = 0;
00176 
00191    virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const
00192    { return Teuchos::null; }
00193    
00207    virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl)
00208    { return true; }
00209 
00211    void setRequestHandler(const Teuchos::RCP<RequestHandler> & rh)
00212    { callbackHandler_ = rh; }
00213 
00215    Teuchos::RCP<RequestHandler> getRequestHandler() const 
00216    { return callbackHandler_; }
00217 
00218 protected:
00220    Teuchos::RCP<RequestHandler> callbackHandler_;
00221 };
00222 
00223 class StaticOpInverseFactory : public InverseFactory {
00224 public:
00226 
00227    
00236    StaticOpInverseFactory(const LinearOp inv) 
00237       : inverse_(inv) {}
00238 
00240    StaticOpInverseFactory(const StaticOpInverseFactory & saFactory)
00241       : inverse_(saFactory.inverse_) {}
00243 
00244    virtual ~StaticOpInverseFactory() {}
00245 
00257    virtual InverseLinearOp buildInverse(const LinearOp & linearOp) const
00258    { return Teuchos::rcp_const_cast<Thyra::LinearOpBase<double> >(inverse_); }
00259 
00274    virtual void rebuildInverse(const LinearOp & source,InverseLinearOp & dest) const
00275    { }
00276 
00285    virtual Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const
00286    { return Teuchos::null; }
00287 
00289    virtual std::string toString() const { return inverse_->description(); }
00290 
00291 protected:
00292    Teko::LinearOp inverse_;
00293 
00294 private:
00295    // hide me!
00296    StaticOpInverseFactory();
00297 };
00298 
00300 
00301 
00312 InverseLinearOp buildInverse(const InverseFactory & factory,const LinearOp & A);
00313 
00325 InverseLinearOp buildInverse(const InverseFactory & factory,const LinearOp & A,const LinearOp & precOp);
00326 
00341 void rebuildInverse(const InverseFactory & factory, const LinearOp & A, InverseLinearOp & invA);
00342 
00358 void rebuildInverse(const InverseFactory & factory, const LinearOp & A,const LinearOp & precOp, InverseLinearOp & invA);
00359 
00376 Teuchos::RCP<InverseFactory> invFactoryFromParamList(const Teuchos::ParameterList & list,const std::string & type);
00377 
00391 Teuchos::RCP<const Teuchos::ParameterList> invFactoryValidParameters();
00392 
00394 
00395 } // end namespace Teko
00396 
00397 #endif
 All Classes Files Functions Variables