Teko Version of the Day
Teko_MultPreconditionerFactory.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_MultiPreconditionerFactory_hpp__
00048 #define __Teko_MultiPreconditionerFactory_hpp__
00049 
00050 #include "Teko_BlockPreconditionerFactory.hpp"
00051 #include "Teko_Utilities.hpp"
00052 #include "Teko_BlockImplicitLinearOp.hpp"
00053 
00054 namespace Teko {
00055 
00060 class MultPrecondState : public Teko::BlockPreconditionerState {
00061 public:
00062    MultPrecondState() {}
00063 
00064    Teuchos::RCP<BlockPreconditionerState> StateOne_;
00065    Teuchos::RCP<BlockPreconditionerState> StateTwo_;
00066 };
00067 
00091 class MultPrecsLinearOp : public Teko::BlockImplicitLinearOp {
00092 public:
00093 
00095    MultPrecsLinearOp(const Teko::LinearOp &A, const Teko::LinearOp &M1, 
00096             const Teko::LinearOp &M2): A_(A), M1_(M1), M2_(M2) { }
00097 
00098    virtual Teko::VectorSpace  range() const { return M1_->range(); }
00099    virtual Teko::VectorSpace domain() const { return M1_->domain();}
00100    virtual void implicitApply(const Teko::BlockedMultiVector & r, Teko::BlockedMultiVector & y,
00101              const double alpha = 1.0, const double beta = 0.0) const;
00102 
00103 protected:
00104    Teko::LinearOp A_, M1_, M2_;
00105 
00106 private:
00107    // hide me!
00108    MultPrecsLinearOp();
00109    MultPrecsLinearOp(const MultPrecsLinearOp &);
00110 };
00111 
00116 class MultPreconditionerFactory
00117    : public Teko::BlockPreconditionerFactory {
00118 public:
00120    MultPreconditionerFactory(const Teuchos::RCP<const Teko::BlockPreconditionerFactory> & FirstFactory,
00121                              const Teuchos::RCP<const Teko::BlockPreconditionerFactory> & SecondFactory);
00122 
00123    MultPreconditionerFactory();
00124 
00126    Teko::LinearOp buildPreconditionerOperator(Teko::BlockedLinearOp & blo,
00127                                             Teko::BlockPreconditionerState & state) const;
00128     
00130    virtual Teuchos::RCP<Teko::PreconditionerState> buildPreconditionerState() const;
00131 
00132 protected:
00133    // class members
00134    Teuchos::RCP<const Teko::BlockPreconditionerFactory> FirstFactory_;
00135    Teuchos::RCP<const Teko::BlockPreconditionerFactory> SecondFactory_;
00136    
00138    virtual void initializeFromParameterList(const Teuchos::ParameterList & pl);
00139 };
00140 
00141 } // end namespace Teko
00142 
00143 #endif
 All Classes Files Functions Variables