Teko Version of the Day
Teko_InverseLibrary.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_InverseLibrary_hpp__
00048 #define __Teko_InverseLibrary_hpp__
00049 
00050 #include "Teko_InverseFactory.hpp"
00051 
00052 // Teuchos includes
00053 #include "Teuchos_ParameterList.hpp"
00054 
00055 // Stratimikos includes
00056 #include "Stratimikos_DefaultLinearSolverBuilder.hpp"
00057 
00058 // Teko includes
00059 #include "Teko_RequestHandler.hpp"
00060 #include "Teko_RequestHandlerContainer.hpp"
00061 
00062 namespace Teko {
00063 
00064 class InverseLibrary : public RequestHandlerContainer {
00065 public:
00066    InverseLibrary();
00067 
00068    InverseLibrary(const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder> & strat);
00069 
00071    void addInverse(const std::string & label,const Teuchos::ParameterList & pl);
00072 
00074    void addStratSolver(const std::string & label,const std::string & type,const Teuchos::ParameterList & pl);
00075 
00077    void addStratPrecond(const std::string & label,const std::string & type,const Teuchos::ParameterList & pl);
00078 
00080    void addBlockPrecond(const std::string & label,const std::string & type,const Teuchos::ParameterList & pl);
00081 
00089    Teuchos::RCP<const Teuchos::ParameterList> getParameterList(const std::string & label) const;
00090 
00092    Teuchos::RCP<InverseFactory> getInverseFactory(const std::string & label) const;
00093 
00095    void PrintAvailableInverses(std::ostream & os) const;
00096 
00098    void setRequestHandler(const Teuchos::RCP<RequestHandler> & rh)
00099    { callbackHandler_ = rh; }
00100 
00102    Teuchos::RCP<RequestHandler> getRequestHandler() const 
00103    { return callbackHandler_; }
00104 
00105 protected:
00106 
00107    // stratimikos type Inverse objects: mapping the label to a parameter list
00108    std::map<std::string,Teuchos::RCP<const Teuchos::ParameterList> > stratSolver_;
00109    std::map<std::string,Teuchos::RCP<const Teuchos::ParameterList> > stratPrecond_;
00110    std::map<std::string,Teuchos::RCP<const Teuchos::ParameterList> > blockPrecond_;
00111 
00112    // vectors showing which string types are in Stratimikos
00113    std::vector<std::string> stratValidSolver_;
00114    std::vector<std::string> stratValidPrecond_;
00115    std::vector<std::string> blockValidPrecond_;
00116 
00118    Teuchos::RCP<RequestHandler> callbackHandler_;
00119 
00121    Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder> defaultBuilder_;
00122     
00123 public:
00124 
00135    static Teuchos::RCP<InverseLibrary> buildFromParameterList(const Teuchos::ParameterList & pl,bool useStratDefaults=true);
00136 
00147    static Teuchos::RCP<InverseLibrary> buildFromParameterList(const Teuchos::ParameterList & pl,
00148                                                               const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder> & strat);
00149 
00159    static Teuchos::RCP<InverseLibrary> buildFromStratimikos(
00160          const Stratimikos::DefaultLinearSolverBuilder & strat=Stratimikos::DefaultLinearSolverBuilder());
00161 
00171    static Teuchos::RCP<InverseLibrary> buildFromStratimikos(
00172          const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder> & strat);
00173 };
00174 
00175 } // end namespace Teko
00176 
00177 #endif
 All Classes Files Functions Variables