Teko Version of the Day
Teko_LSCSIMPLECStrategy.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_LSCSIMPLECStrategy_hpp__
00048 #define __Teko_LSCSIMPLECStrategy_hpp__
00049 
00050 #include "Teko_LSCStrategy.hpp"
00051 
00052 namespace Teko {
00053 namespace NS {
00054 
00055 class LSCPrecondState; // forward declration
00056 
00066 class LSCSIMPLECStrategy : public LSCStrategy {
00067 public:
00069 
00070    LSCSIMPLECStrategy();
00072 
00073    virtual ~LSCSIMPLECStrategy() {}
00074 
00076 
00077 
00085    virtual void buildState(BlockedLinearOp & A,BlockPreconditionerState & state) const;
00086 
00095    virtual LinearOp getInvBQBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00096 
00105    virtual LinearOp getInvBHBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00106 
00115    virtual LinearOp getInvF(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00116 
00126    virtual LinearOp getOuterStabilization(const BlockedLinearOp & A,BlockPreconditionerState & state) const
00127    { return Teuchos::null; }
00128 
00129    virtual LinearOp getInnerStabilization(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00130 
00139    virtual LinearOp getInvMass(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00140 
00149    virtual LinearOp getHScaling(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00150 
00157    virtual bool useFullLDU() const { return useFullLDU_; }
00158 
00160    virtual void initializeFromParameterList(const Teuchos::ParameterList & pl,
00161                                             const InverseLibrary & invLib); 
00162 
00164    virtual void initializeState(const BlockedLinearOp & A,LSCPrecondState * state) const;
00165 
00171    void computeInverses(const BlockedLinearOp & A,LSCPrecondState * state) const;
00172 
00174    virtual void setUseFullLDU(bool val) { useFullLDU_ = val; }
00175 
00176    virtual void setSymmetric(bool isSymmetric) { }
00177 
00178 protected:
00179    // how to invert the matrices
00180    Teuchos::RCP<InverseFactory> invFactoryF_;
00181    Teuchos::RCP<InverseFactory> invFactoryS_;
00182 
00183    // flags for handling various options
00184    bool useFullLDU_;
00185    DiagonalType scaleType_; 
00186 
00187 private:
00188    LSCSIMPLECStrategy(const LSCSIMPLECStrategy &);
00189 };
00190 
00191 } // end namespace NS
00192 } // end namespace Teko
00193 
00194 #endif
 All Classes Files Functions Variables