Teko Version of the Day
Teko_LU2x2Strategy.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_LU2x2Strategy_hpp__
00048 #define __Teko_LU2x2Strategy_hpp__
00049 
00050 #include "Teuchos_RCP.hpp"
00051 #include "Thyra_LinearOpBase.hpp"
00052 
00053 #include "Teko_Utilities.hpp"
00054 #include "Teko_InverseFactory.hpp"
00055 #include "Teko_BlockPreconditionerFactory.hpp"
00056 
00057 
00058 namespace Teko {
00059 
00103 class LU2x2Strategy {
00104 public:
00105    virtual ~LU2x2Strategy() {}
00106 
00108    virtual const Teko::LinearOp
00109    getHatInvA00(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00110 
00112    virtual const Teko::LinearOp
00113    getTildeInvA00(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00114 
00116    virtual const Teko::LinearOp
00117    getInvS(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00118 
00130    virtual void initializeFromParameterList(const Teuchos::ParameterList & settings,
00131                                             const InverseLibrary & invLib)
00132    { }
00133 
00148    virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const
00149    { return Teuchos::null; }
00150 
00164    virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl)
00165    { return true; }
00166 
00168    void setRequestHandler(const Teuchos::RCP<RequestHandler> & rh)
00169    { requestHandler_ = rh; }
00170 
00172    Teuchos::RCP<RequestHandler> getRequestHandler() const
00173    { return requestHandler_; }
00174 
00175 private:
00176    Teuchos::RCP<RequestHandler> requestHandler_;
00177  
00178 };
00179 
00188 class StaticLU2x2Strategy : public LU2x2Strategy {
00189 public:
00198    StaticLU2x2Strategy(const Teko::LinearOp & hInvA00,
00199                        const Teko::LinearOp & tInvA00,
00200                        const Teko::LinearOp & invS)
00201       : hatInvA00_(hInvA00), tildeInvA00_(tInvA00), invS_(invS)
00202    {}
00203 
00204    virtual ~StaticLU2x2Strategy() {}
00205  
00208 
00210    virtual const Teko::LinearOp
00211    getHatInvA00(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const
00212    { return hatInvA00_; }
00213 
00215    virtual const Teko::LinearOp
00216    getTildeInvA00(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const
00217    { return tildeInvA00_; }
00218 
00220    virtual const Teko::LinearOp
00221    getInvS(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const
00222    { return invS_; }
00223 
00225 
00226 protected:
00227    const Teko::LinearOp hatInvA00_;  
00228    const Teko::LinearOp tildeInvA00_;  
00229    const Teko::LinearOp invS_; 
00231 private:
00232    // hide me!
00233    StaticLU2x2Strategy() {}
00234 };
00235 
00236 } // end namespace Teko
00237 
00238 #endif
 All Classes Files Functions Variables