sillierCgSolve.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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef THYRA_SILLIER_CG_SOLVE_HPP
00030 #define THYRA_SILLIER_CG_SOLVE_HPP
00031 
00032 #include "Thyra_LinearOperatorImpl.hpp"
00033 #include "Thyra_VectorSpaceImpl.hpp"
00034 #include "Thyra_VectorImpl.hpp"
00035 #include "Thyra_AssertOp.hpp"
00036 #include "silliestCgSolve.hpp"
00037 
00049 template<class Scalar>
00050 bool sillierCgSolve(
00051   const Thyra::LinearOpBase<Scalar>                              &A_in
00052   ,const Thyra::VectorBase<Scalar>                               &b_in
00053   ,const int                                                     maxNumIters
00054   ,const typename Teuchos::ScalarTraits<Scalar>::magnitudeType   tolerance
00055   ,Thyra::VectorBase<Scalar>                                     *x_inout
00056   ,std::ostream                                                  *out          = NULL
00057   )
00058 {
00059   // Validate the input
00060   TEST_FOR_EXCEPT(x_inout==NULL);
00061   THYRA_ASSERT_LINEAR_OP_VEC_APPLY_SPACES("sillyCgSolve()",A_in,Thyra::NOTRANS,*x_inout,&b_in);
00062   // Create handle wrappers to facilitate the use of operator overloading
00063   const Thyra::ConstLinearOperator<Scalar>  A(Teuchos::rcp(&A_in,false));
00064   const Thyra::ConstVector<Scalar>          b(Teuchos::rcp(&b_in,false));
00065   Thyra::Vector<Scalar>                     x(Teuchos::rcp(x_inout,false));
00066   // Describe the arguments
00067   Teuchos::EVerbosityLevel vl = Teuchos::VERB_MEDIUM;
00068   if(out) *out << "\nStarting CG solver ...\n" << std::scientific << "\ndescribe A:\n"<<describe(A,vl)
00069                << "\ndescribe b:\n"<<describe(b,vl)<<"\ndescribe x:\n"<<describe(x,vl)<<"\n";
00070   return silliestCgSolve(A,b,maxNumIters,tolerance,x,out);
00071 } // end sillierCgSolve
00072 
00073 #endif // THYRA_SILLIER_CG_SOLVE_HPP

Generated on Wed May 12 21:42:27 2010 for Thyra Operator/Vector Support by  doxygen 1.4.7