Teko Version of the Day
Teko_BlockInvDiagonalStrategy.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_BlockInvDiagonalStrategy_hpp__
00048 #define __Teko_BlockInvDiagonalStrategy_hpp__
00049 
00050 #include <vector>
00051 
00052 // Teuchos includes
00053 #include "Teuchos_RCP.hpp"
00054 
00055 // Thyra includes
00056 #include "Thyra_LinearOpBase.hpp"
00057 
00058 // Teko includes
00059 #include "Teko_Utilities.hpp"
00060 #include "Teko_InverseFactory.hpp"
00061 #include "Teko_BlockPreconditionerFactory.hpp"
00062 
00063 namespace Teko {
00064 
00079 class BlockInvDiagonalStrategy {
00080 public:
00081    virtual ~BlockInvDiagonalStrategy() {}
00082 
00084    virtual void getInvD(const BlockedLinearOp & A,BlockPreconditionerState & state,
00085                         std::vector<LinearOp> & invDiag) const = 0;
00086 
00087 };
00088 
00095 class StaticInvDiagStrategy : public BlockInvDiagonalStrategy {
00096 public:
00097    StaticInvDiagStrategy(const LinearOp & invD0,
00098                           const LinearOp & invD1)
00099    { invDiag_.push_back(invD0); invDiag_.push_back(invD1); }
00100 
00101    StaticInvDiagStrategy(const std::vector<LinearOp> & invD)
00102       : invDiag_(invD)
00103    { }
00104 
00105    virtual ~StaticInvDiagStrategy() {}
00106 
00110    virtual void getInvD(const BlockedLinearOp & A, BlockPreconditionerState & state,
00111                         std::vector<LinearOp> & invDiag) const
00112    { invDiag.clear(); invDiag = invDiag_; }
00113 
00114 protected:
00115    // stored inverse operators
00116    std::vector<Teuchos::RCP<const Thyra::LinearOpBase<double> > > invDiag_;
00117 };
00118 
00123 class InvFactoryDiagStrategy : public BlockInvDiagonalStrategy {
00124 public:
00130    InvFactoryDiagStrategy(const Teuchos::RCP<InverseFactory> & factory);
00131 
00139    InvFactoryDiagStrategy(const std::vector<Teuchos::RCP<InverseFactory> > & factories,
00140                           const Teuchos::RCP<InverseFactory> & defaultFact=Teuchos::null);
00141 
00142    virtual ~InvFactoryDiagStrategy() {}
00143 
00151    virtual void getInvD(const BlockedLinearOp & A, BlockPreconditionerState & state,
00152                         std::vector<LinearOp> & invDiag) const;
00153 
00155    const std::vector<Teuchos::RCP<InverseFactory> > & getFactories() const
00156    { return invDiagFact_; }
00157 
00158 protected:
00159    // stored inverse operators
00160    std::vector<Teuchos::RCP<InverseFactory> > invDiagFact_;
00161    Teuchos::RCP<InverseFactory> defaultInvFact_;
00162 
00164    LinearOp buildInverse(const InverseFactory & invFact,const LinearOp & matrix,
00165                          BlockPreconditionerState & state,
00166                          const std::string & opPrefix,int i) const;
00167 
00168 private:
00169    InvFactoryDiagStrategy();
00170    InvFactoryDiagStrategy(const InvFactoryDiagStrategy &);
00171 };
00172 
00173 } // end namespace Teko
00174 
00175 #endif
 All Classes Files Functions Variables