Teko Version of the Day
Teko_PreconditionerLinearOpDecl.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_PreconditionerLinearOpDecl_hpp__
00048 #define __Teko_PreconditionerLinearOpDecl_hpp__
00049 
00050 #include "Thyra_LinearOpBase.hpp"
00051 #include "Thyra_PreconditionerBase.hpp"
00052 #include "Thyra_VectorSpaceBase.hpp"
00053 
00054 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00055 
00056 namespace Teko {
00057 
00065 template <typename ScalarT>
00066 class PreconditionerLinearOp : public Thyra::LinearOpBase<ScalarT> {
00067 public:
00068    PreconditionerLinearOp();
00069    PreconditionerLinearOp(const Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> > & prec);
00070    PreconditionerLinearOp(const Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> > & prec);
00071 
00073    void initialize(const Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> > & prec);
00074 
00076    void initialize(const Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> > & prec);
00077 
00079    void uninitialize();
00080 
00082    virtual Teuchos::RCP<const Thyra::VectorSpaceBase<ScalarT> > range() const;
00083 
00085    virtual Teuchos::RCP<const Thyra::VectorSpaceBase<ScalarT> > domain() const;
00086 
00087    virtual bool opSupportedImpl(const Thyra::EOpTransp M_trans) const;
00088 
00090    virtual void applyImpl(
00091      const Thyra::EOpTransp M_trans,
00092      const Thyra::MultiVectorBase<ScalarT> & x,
00093      const Teuchos::Ptr<Thyra::MultiVectorBase<ScalarT> > & y,
00094      const ScalarT alpha,
00095      const ScalarT beta
00096      ) const;
00097 
00099    virtual Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> > getNonconstPreconditioner();
00100 
00102    virtual Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> > getPreconditioner() const;
00103 
00105    Teko::LinearOp getOperator() const { return getOperator_cnoc().getConstObj(); }
00106 
00107    // Inherited from Teuchos::Describable
00108    void describe(Teuchos::FancyOStream & out_arg,const Teuchos::EVerbosityLevel verbLevel) const;
00109 protected:
00111    Teuchos::ConstNonconstObjectContainer<Thyra::LinearOpBase<ScalarT> > getOperator_cnoc() const;
00112 
00114    Teuchos::ConstNonconstObjectContainer<Thyra::LinearOpBase<ScalarT> > getOperator_cnoc();
00115 
00116    Teuchos::ConstNonconstObjectContainer<Thyra::PreconditionerBase<ScalarT> > preconditioner_;
00117 };
00118 
00131 inline Teko::LinearOp extractOperatorFromPrecOp(const Teko::LinearOp & lo);
00132 
00133 } // end namespace Teko
00134 
00135 #endif
 All Classes Files Functions Variables