Teko Version of the Day
Teko_LSCStrategy.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_LSCStrategy_hpp__
00048 #define __Teko_LSCStrategy_hpp__
00049 
00050 #include "Teuchos_RCP.hpp"
00051 
00052 #include "Thyra_LinearOpBase.hpp"
00053 
00054 #include "Teko_Utilities.hpp"
00055 #include "Teko_InverseFactory.hpp"
00056 #include "Teko_BlockPreconditionerFactory.hpp"
00057 
00058 namespace Teko {
00059 namespace NS {
00060 
00061 class LSCPrecondState; // forward declaration
00062 
00119 class LSCStrategy {
00120 public:
00121    virtual ~LSCStrategy() {}
00122 
00130    virtual void buildState(BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00131 
00140    virtual LinearOp getInvBQBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00141 
00150    virtual LinearOp getInvBHBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00151 
00160    virtual LinearOp getInvF(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00161 
00162    #if 0
00163 
00171    virtual LinearOp getInvAlphaD(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00172    #endif
00173 
00184    virtual LinearOp getOuterStabilization(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00185 
00196    virtual LinearOp getInnerStabilization(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00197 
00206    virtual LinearOp getInvMass(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00207 
00216    virtual LinearOp getHScaling(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
00217 
00224    virtual bool useFullLDU() const = 0;
00225 
00231    virtual void setSymmetric(bool isSymmetric) = 0;
00232 
00234    virtual void initializeFromParameterList(const Teuchos::ParameterList & pl,const InverseLibrary & invLib) {}
00235 
00237    virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const { return Teuchos::null;}
00238 
00240    virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl) { return true; }
00241 
00243    void setRequestHandler(const Teuchos::RCP<RequestHandler> & rh)
00244    { requestHandler_ = rh; }
00245 
00247    Teuchos::RCP<RequestHandler> getRequestHandler() const
00248    { return requestHandler_; }
00249 
00250 private:
00251    Teuchos::RCP<RequestHandler> requestHandler_;
00252 
00253 };
00254 
00255 } // end namespace NS
00256 } // end namespace Teko
00257 
00258 #endif
 All Classes Files Functions Variables