Teko Version of the Day
Teko_LU2x2InverseOp.hpp
Go to the documentation of this file.
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 
00052 #ifndef __Teko_LU2x2InverseOp_hpp__
00053 #define __Teko_LU2x2InverseOp_hpp__
00054 
00055 #include "Teko_Utilities.hpp"
00056 #include "Teko_BlockImplicitLinearOp.hpp"
00057 
00058 namespace Teko {
00059 
00101 class LU2x2InverseOp : public BlockImplicitLinearOp {
00102 public:
00113    LU2x2InverseOp(const BlockedLinearOp & A,
00114                        const LinearOp & invA00,
00115                        const LinearOp & invS);
00116 
00128    LU2x2InverseOp(const BlockedLinearOp & A,
00129                        const LinearOp & hatInvA00,
00130                        const LinearOp & tildeInvA00,
00131                        const LinearOp & invS);
00132 
00134 
00135 
00137    virtual VectorSpace range() const { return productRange_; }
00138 
00140    virtual VectorSpace domain() const { return productDomain_; }
00141 
00154    virtual void implicitApply(const BlockedMultiVector & x, BlockedMultiVector & y,
00155               const double alpha = 1.0, const double beta = 0.0) const;
00157 
00158    virtual void describe(Teuchos::FancyOStream & out_arg,
00159                          const Teuchos::EVerbosityLevel verbLevel) const;
00160 
00161 protected:
00162    // fundamental operators to use
00163    const BlockedLinearOp A_;  
00164    const LinearOp hatInvA00_;  
00165    const LinearOp tildeInvA00_;  
00166    const LinearOp invS_;      
00167 
00168    // some blocks of A
00169    const LinearOp A10_;       
00170    const LinearOp A01_;       
00171 
00172    Teuchos::RCP<const Thyra::ProductVectorSpaceBase<double> > productRange_; 
00173    Teuchos::RCP<const Thyra::ProductVectorSpaceBase<double> > productDomain_; 
00174 
00175 private:
00176    // hide me!
00177    LU2x2InverseOp();
00178    LU2x2InverseOp(const LU2x2InverseOp &);
00179 };
00180 
00194 inline LinearOp createLU2x2InverseOp(BlockedLinearOp & A,LinearOp & invA00,LinearOp & invS)
00195 {
00196    return Teuchos::rcp(new LU2x2InverseOp(A,invA00,invS));
00197 }
00198 
00213 inline LinearOp createLU2x2InverseOp(BlockedLinearOp & A,LinearOp & invA00,LinearOp & invS,const std::string & str)
00214 {
00215    Teuchos::RCP<Thyra::LinearOpBase<double> > result = Teuchos::rcp(new LU2x2InverseOp(A,invA00,invS));
00216    result->setObjectLabel(str);
00217 
00218    return result;
00219 }
00220 
00235 inline LinearOp createLU2x2InverseOp(BlockedLinearOp & A,LinearOp & hatInvA00,LinearOp & tildeInvA00,LinearOp & invS)
00236 {
00237    return Teuchos::rcp(new LU2x2InverseOp(A,hatInvA00,tildeInvA00,invS));
00238 }
00239 
00255 inline LinearOp createLU2x2InverseOp(BlockedLinearOp & A,LinearOp & hatInvA00,LinearOp & tildeInvA00,LinearOp & invS,const std::string & str)
00256 {
00257    Teuchos::RCP<Thyra::LinearOpBase<double> > result = Teuchos::rcp(new LU2x2InverseOp(A,hatInvA00,tildeInvA00,invS));
00258    result->setObjectLabel(str);
00259 
00260    return result;
00261 }
00262 
00263 } // end namespace Teko
00264 
00265 #endif  
 All Classes Files Functions Variables