Teko Version of the Day
Teko_BlockLowerTriInverseOp.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_BlockLowerTriInverseOp_hpp__
00048 #define __Teko_BlockLowerTriInverseOp_hpp__
00049 
00050 #include "Teko_Utilities.hpp"
00051 #include "Teko_BlockImplicitLinearOp.hpp"
00052 
00053 namespace Teko {
00054 
00063 class BlockLowerTriInverseOp : public BlockImplicitLinearOp {
00064 public:
00074    BlockLowerTriInverseOp(BlockedLinearOp & L,const std::vector<LinearOp> & invDiag);
00075 
00077 
00078 
00080    virtual VectorSpace range() const { return productRange_; }
00081 
00083    virtual VectorSpace domain() const { return productDomain_; }
00084 
00097    virtual void implicitApply(const BlockedMultiVector & x, BlockedMultiVector & y,
00098               const double alpha = 1.0, const double beta = 0.0) const;
00100 
00101    virtual void describe(Teuchos::FancyOStream &out_arg,
00102                          const Teuchos::EVerbosityLevel verbLevel) const;
00103 
00104 protected:
00105    // fundamental operators to use
00106    const BlockedLinearOp L_;  
00107    std::vector<LinearOp> invDiag_; 
00108 
00109    Teuchos::RCP<const Thyra::ProductVectorSpaceBase<double> > productRange_; 
00110    Teuchos::RCP<const Thyra::ProductVectorSpaceBase<double> > productDomain_; 
00111 
00112    // scratch space...so we don't have to reallocate
00113    mutable BlockedMultiVector srcScrap_;
00114    mutable BlockedMultiVector dstScrap_;
00115 
00116 private:
00117    // hide me!
00118    BlockLowerTriInverseOp();
00119    BlockLowerTriInverseOp(const BlockLowerTriInverseOp &);
00120 };
00121 
00122 inline LinearOp createBlockLowerTriInverseOp(BlockedLinearOp & U,const std::vector<LinearOp> & invDiag)
00123 {
00124    return Teuchos::rcp(new BlockLowerTriInverseOp(U,invDiag));
00125 }
00126 
00127 inline LinearOp createBlockLowerTriInverseOp(BlockedLinearOp & L,const std::vector<LinearOp> & invDiag,const std::string & str)
00128 {
00129    Teuchos::RCP<Thyra::LinearOpBase<double> > result = Teuchos::rcp(new BlockLowerTriInverseOp(L,invDiag));
00130    result->setObjectLabel(str);
00131 
00132    return result;
00133 }
00134 
00135 } // end namespace Teko
00136 
00137 #endif  
 All Classes Files Functions Variables