Teko Version of the Day
Teko_LU2x2PreconditionerFactory.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_LU2x2PreconditionerFactory_hpp__
00048 #define __Teko_LU2x2PreconditionerFactory_hpp__
00049 
00050 #include "Teuchos_RCP.hpp"
00051 
00052 #include "Teko_BlockPreconditionerFactory.hpp"
00053 #include "Teko_LU2x2Strategy.hpp"
00054 
00055 namespace Teko {
00056 
00141 class LU2x2PreconditionerFactory : public BlockPreconditionerFactory {
00142 public:
00144 
00145  
00147    LU2x2PreconditionerFactory(LinearOp & invA00,LinearOp & invS);
00148 
00150    LU2x2PreconditionerFactory(LinearOp & hatInvA00,LinearOp & tildeInvA00,LinearOp & invS);
00151 
00160    LU2x2PreconditionerFactory(const Teuchos::RCP<LU2x2Strategy> & strategy);
00161 
00162 
00167    LU2x2PreconditionerFactory();
00168 
00170 
00177    LinearOp buildPreconditionerOperator(BlockedLinearOp & blo,BlockPreconditionerState & state) const;
00178 
00191    virtual void initializeFromParameterList(const Teuchos::ParameterList & settings);
00192 
00207    virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
00208    
00222    virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
00223 
00236    virtual bool useFullLDU() const { return useFullLDU_; }
00237 
00248    virtual void setFullLDU(bool value)
00249    { useFullLDU_ = value; }
00250  
00251 protected: 
00253    Teuchos::RCP<LU2x2Strategy> invOpsStrategy_;
00254 
00259    bool useFullLDU_;
00260 
00261 public:
00274    static RCP<LU2x2Strategy> 
00275    buildStrategy(const std::string & name, 
00276                  const Teuchos::ParameterList & settings,
00277                  const RCP<const InverseLibrary> & invLib,
00278                  const RCP<RequestHandler> & rh);
00279 
00293    static void addStrategy(const std::string & name,const RCP<Cloneable> & clone);
00294 
00295 private:
00297    static CloneFactory<LU2x2Strategy> strategyBuilder_;
00298 
00300    static void initializeStrategyBuilder();
00301 };
00302 
00303 } // end namespace Teko
00304 
00305 #endif
 All Classes Files Functions Variables