Thyra Version of the Day
Thyra_PreconditionerFactoryHelpers.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 Michael A. Heroux (maherou@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_PRECONDITIONER_FACTORY_HELPERS_DECL_HPP
00043 #define THYRA_PRECONDITIONER_FACTORY_HELPERS_DECL_HPP
00044 
00045 
00046 #include "Thyra_PreconditionerFactoryBase.hpp"
00047 #include "Thyra_DefaultLinearOpSource.hpp"
00048 #include "Thyra_DefaultPreconditioner.hpp"
00049 
00050 
00051 namespace Thyra {
00052 
00053 
00058 template <class Scalar>
00059 void initializePrec(
00060   const PreconditionerFactoryBase<Scalar> &precFactory,
00061   const Teuchos::RCP<const LinearOpBase<Scalar> > &fwdOp,
00062   const Teuchos::Ptr<PreconditionerBase<Scalar> > &prec,
00063   const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
00064   )
00065 {
00066   precFactory.initializePrec(defaultLinearOpSource(fwdOp), prec.get(),
00067     supportSolveUse);
00068 }
00069 
00070 
00076 template <class Scalar>
00077 void uninitializePrec(
00078   const PreconditionerFactoryBase<Scalar> &precFactory,
00079   const Teuchos::Ptr<PreconditionerBase<Scalar> > &prec,
00080   const Teuchos::Ptr<Teuchos::RCP<const LinearOpBase<Scalar> > > &fwdOp = Teuchos::null,
00081   const Teuchos::Ptr<ESupportSolveUse> &supportSolveUse = Teuchos::null
00082   )
00083 {
00084   Teuchos::RCP<const LinearOpSourceBase<Scalar> > fwdOpSrc;
00085   precFactory.uninitializePrec(prec, Teuchos::outArg(fwdOpSrc), supportSolveUse);
00086   if (nonnull(fwdOp)) {*fwdOp = fwdOpSrc->getOp();}
00087 }
00088 
00089 
00094 template <class Scalar>
00095 Teuchos::RCP<PreconditionerBase<Scalar> >
00096 prec(
00097   const PreconditionerFactoryBase<Scalar> &precFactory,
00098   const Teuchos::RCP<const LinearOpBase<Scalar> > &fwdOp,
00099   const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
00100   )
00101 {
00102   Teuchos::RCP<PreconditionerBase<Scalar> > prec =
00103     precFactory.createPrec();
00104   precFactory.initializePrec(defaultLinearOpSource(fwdOp), &*prec, supportSolveUse);
00105   return prec;
00106 }
00107 
00108 
00109 //
00110 // Deprecated
00111 //
00112 
00113 
00118 template <class Scalar>
00119 THYRA_DEPRECATED
00120 void initializePrec(
00121   const PreconditionerFactoryBase<Scalar> &precFactory,
00122   const Teuchos::RCP<const LinearOpBase<Scalar> > &fwdOp,
00123   PreconditionerBase<Scalar> *prec,
00124   const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
00125   )
00126 {
00127   initializePrec<Scalar>(precFactory, fwdOp, Teuchos::ptr(prec),
00128     supportSolveUse);
00129 }
00130 
00131 
00136 template <class Scalar>
00137 THYRA_DEPRECATED
00138 void uninitializePrec(
00139   const PreconditionerFactoryBase<Scalar> &precFactory,
00140   PreconditionerBase<Scalar> *prec,
00141   Teuchos::RCP<const LinearOpBase<Scalar> > *fwdOp = NULL,
00142   ESupportSolveUse *supportSolveUse = NULL
00143   )
00144 {
00145   using Teuchos::ptr;
00146   uninitializePrec<Scalar>(precFactory, ptr(prec), ptr(fwdOp),
00147     ptr(supportSolveUse));
00148 }
00149 
00150 
00151 } // namespace Thyra
00152 
00153 
00154 #endif // THYRA_PRECONDITIONER_FACTORY_HELPERS_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines