Teko Version of the Day
Teko_PresLaplaceLSCStrategy.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_PresLaplaceLSCStrategy_hpp__
00048 #define __Teko_PresLaplaceLSCStrategy_hpp__
00049 
00050 #include "Teko_LSCStrategy.hpp"
00051 
00052 namespace Teko {
00053 namespace NS {
00054 
00055 class LSCPrecondState; // forward declration
00056 
00066 class PresLaplaceLSCStrategy : public LSCStrategy {
00067 public:
00069 
00070    PresLaplaceLSCStrategy();
00071    PresLaplaceLSCStrategy(const Teuchos::RCP<InverseFactory> & factory);
00072    PresLaplaceLSCStrategy(const Teuchos::RCP<InverseFactory> & invFactF,
00073                   const Teuchos::RCP<InverseFactory> & invFactS);
00075 
00076    virtual ~PresLaplaceLSCStrategy() {}
00077 
00079 
00080 
00088    virtual void buildState(BlockedLinearOp & A,BlockPreconditionerState & state) const;
00089 
00098    virtual LinearOp getInvBQBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00099 
00108    virtual LinearOp getInvBHBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00109 
00118    virtual LinearOp getInvF(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00119 
00128    // virtual LinearOp getInvAlphaD(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00129    virtual LinearOp getOuterStabilization(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00130 
00131    virtual LinearOp getInnerStabilization(const BlockedLinearOp & A,BlockPreconditionerState & state) const
00132    { return Teuchos::null; }
00133 
00142    virtual LinearOp getInvMass(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00143 
00152    virtual LinearOp getHScaling(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
00153 
00160    virtual bool useFullLDU() const { return useFullLDU_; }
00161 
00167    virtual void setSymmetric(bool isSymmetric) 
00168    { isSymmetric_ = isSymmetric; }
00169 
00171    virtual void initializeFromParameterList(const Teuchos::ParameterList & pl,
00172                                             const InverseLibrary & invLib); 
00173 
00175    virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
00176 
00178    virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
00180 
00182    virtual void initializeState(const BlockedLinearOp & A,LSCPrecondState * state) const;
00183 
00189    void computeInverses(const BlockedLinearOp & A,LSCPrecondState * state) const;
00190 
00192    virtual void setEigSolveParam(int sz) { eigSolveParam_ = sz; }
00193 
00195    virtual int getEigSolveParam() { return eigSolveParam_; }
00196 
00198    virtual void setUseFullLDU(bool val) { useFullLDU_ = val; }
00199 
00200 protected:
00201    // how to invert the matrices
00202    Teuchos::RCP<InverseFactory> invFactoryV_;
00203    Teuchos::RCP<InverseFactory> invFactoryP_;
00204 
00205    // flags for handling various options
00206    bool isSymmetric_;
00207    int eigSolveParam_;
00208    bool useFullLDU_;
00209 
00210    // scaling operator parameters
00211    bool useMass_;
00212    DiagonalType scaleType_; 
00213 
00214 private:
00215    PresLaplaceLSCStrategy(const PresLaplaceLSCStrategy &);
00216 
00217 public:
00218    // some static functions for determining strings
00219 
00220    static std::string getPressureLaplaceString() { return "Pressure Laplace Operator"; }
00221    static std::string getVelocityMassString() { return "Velocity Mass Operator"; }
00222 };
00223 
00224 } // end namespace NS
00225 } // end namespace Teko
00226 
00227 #endif
 All Classes Files Functions Variables