Thyra Version of the Day
Thyra_DefaultPreconditioner_decl.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_DEFUALT_PRECONDITIONER_DECL_HPP
00043 #define THYRA_DEFUALT_PRECONDITIONER_DECL_HPP
00044 
00045 #include "Thyra_PreconditionerBase.hpp"
00046 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00047 
00048 
00049 namespace Thyra {
00050 
00051 
00079 template <class Scalar>
00080 class DefaultPreconditioner : virtual public PreconditionerBase<Scalar>
00081 {
00082 public:
00083 
00086 
00089   DefaultPreconditioner();
00090 
00094   DefaultPreconditioner(
00095     const Teuchos::RCP<LinearOpBase<Scalar> > &leftPrecOp,
00096     const Teuchos::RCP<LinearOpBase<Scalar> > &rightPrecOp
00097     );
00098 
00102   DefaultPreconditioner(
00103     const Teuchos::RCP<const LinearOpBase<Scalar> > &leftPrecOp,
00104     const Teuchos::RCP<const LinearOpBase<Scalar> > &rightPrecOp
00105     );
00106 
00109   DefaultPreconditioner(
00110     const Teuchos::RCP<LinearOpBase<Scalar> > &unspecifiedPrecOp
00111     );
00112 
00115   DefaultPreconditioner(
00116     const Teuchos::RCP<const LinearOpBase<Scalar> > &unspecifiedPrecOp
00117     );
00118 
00121   void initializeLeft(
00122     const Teuchos::RCP<LinearOpBase<Scalar> > &leftPrecOp
00123     );
00124 
00127   void initializeLeft(
00128     const Teuchos::RCP<const LinearOpBase<Scalar> > &leftPrecOp
00129     );
00130 
00133   void initializeRight(
00134     const Teuchos::RCP<LinearOpBase<Scalar> > &rightPrecOp
00135     );
00136 
00139   void initializeRight(
00140     const Teuchos::RCP<const LinearOpBase<Scalar> > &rightPrecOp
00141     );
00142 
00145   void initializeLeftRight(
00146     const Teuchos::RCP<LinearOpBase<Scalar> > &leftPrecOp
00147     ,const Teuchos::RCP<LinearOpBase<Scalar> > &rightPrecOp
00148     );
00149 
00152   void initializeLeftRight(
00153     const Teuchos::RCP<const LinearOpBase<Scalar> > &leftPrecOp
00154     ,const Teuchos::RCP<const LinearOpBase<Scalar> > &rightPrecOp
00155     );
00156 
00160   void initializeUnspecified(
00161     const Teuchos::RCP<LinearOpBase<Scalar> > &unspecifiedPrecOp
00162     );
00163 
00167   void initializeUnspecified(
00168     const Teuchos::RCP<const LinearOpBase<Scalar> > &unspecifiedPrecOp
00169     );
00170 
00177   void uninitialize();
00178 
00180 
00184   std::string description() const;
00186   void describe(
00187     Teuchos::FancyOStream &out,
00188     const Teuchos::EVerbosityLevel verbLevel
00189     ) const;
00191 
00195   bool isLeftPrecOpConst() const;
00197   Teuchos::RCP<LinearOpBase<Scalar> > getNonconstLeftPrecOp();
00199   Teuchos::RCP<const LinearOpBase<Scalar> > getLeftPrecOp() const;
00201   bool isRightPrecOpConst() const;
00203   Teuchos::RCP<LinearOpBase<Scalar> > getNonconstRightPrecOp();
00205   Teuchos::RCP<const LinearOpBase<Scalar> > getRightPrecOp() const;
00207   bool isUnspecifiedPrecOpConst() const;
00209   Teuchos::RCP<LinearOpBase<Scalar> > getNonconstUnspecifiedPrecOp();
00211   Teuchos::RCP<const LinearOpBase<Scalar> > getUnspecifiedPrecOp() const;
00213   
00214 private:
00215   
00216   Teuchos::ConstNonconstObjectContainer<LinearOpBase<Scalar> > leftPrecOp_;
00217   Teuchos::ConstNonconstObjectContainer<LinearOpBase<Scalar> > rightPrecOp_;
00218   Teuchos::ConstNonconstObjectContainer<LinearOpBase<Scalar> > unspecifiedPrecOp_;
00219   
00220 };
00221 
00222 // ///////////////////////
00223 // Related functions
00224 
00230 template <class Scalar>
00231 Teuchos::RCP<const DefaultPreconditioner<Scalar> >
00232 unspecifiedPrec(
00233   const Teuchos::RCP<const LinearOpBase<Scalar> > &unspecifiedPrecOp
00234   )
00235 {
00236   return Teuchos::rcp(new DefaultPreconditioner<Scalar>(unspecifiedPrecOp));
00237 }
00238 
00244 template <class Scalar>
00245 Teuchos::RCP<const DefaultPreconditioner<Scalar> >
00246 leftPrec(
00247   const Teuchos::RCP<const LinearOpBase<Scalar> > &leftPrecOp
00248   )
00249 {
00250   return Teuchos::rcp(new DefaultPreconditioner<Scalar>(leftPrecOp,Teuchos::null));
00251 }
00252 
00258 template <class Scalar>
00259 Teuchos::RCP<const DefaultPreconditioner<Scalar> >
00260 rightPrec(
00261   const Teuchos::RCP<const LinearOpBase<Scalar> > &rightPrecOp
00262   )
00263 {
00264   return Teuchos::rcp(new DefaultPreconditioner<Scalar>(Teuchos::null,rightPrecOp));
00265 }
00266 
00272 template <class Scalar>
00273 Teuchos::RCP<const DefaultPreconditioner<Scalar> >
00274 splitPrec(
00275   const Teuchos::RCP<const LinearOpBase<Scalar> > &leftPrecOp
00276   ,const Teuchos::RCP<const LinearOpBase<Scalar> > &rightPrecOp
00277   )
00278 {
00279   return Teuchos::rcp(new DefaultPreconditioner<Scalar>(leftPrecOp,rightPrecOp));
00280 }
00281 
00282 
00283 } // namespace Thyra
00284 
00285 
00286 #endif // THYRA_DEFUALT_PRECONDITIONER_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines