Thyra Operator/Vector Support : sillierCgSolve.hpp

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_SILLIER_CG_SOLVE_HPP
#define THYRA_SILLIER_CG_SOLVE_HPP

#include "Thyra_LinearOperatorImpl.hpp"
#include "Thyra_VectorSpaceImpl.hpp"
#include "Thyra_VectorImpl.hpp"
#include "Thyra_AssertOp.hpp"
#include "silliestCgSolve.hpp"

template<class Scalar>
bool sillierCgSolve(
  const Thyra::LinearOpBase<Scalar>                              &A_in
  ,const Thyra::VectorBase<Scalar>                               &b_in
  ,const int                                                     maxNumIters
  ,const typename Teuchos::ScalarTraits<Scalar>::magnitudeType   tolerance
  ,Thyra::VectorBase<Scalar>                                     *x_inout
  ,std::ostream                                                  *out          = NULL
  )
{
  // Validate the input
  TEST_FOR_EXCEPT(x_inout==NULL);
  THYRA_ASSERT_LINEAR_OP_VEC_APPLY_SPACES("sillyCgSolve()",A_in,Thyra::NOTRANS,*x_inout,&b_in);
  // Create handle wrappers to facilitate the use of operator overloading
  const Thyra::ConstLinearOperator<Scalar>  A(Teuchos::rcp(&A_in,false));
  const Thyra::ConstVector<Scalar>          b(Teuchos::rcp(&b_in,false));
  Thyra::Vector<Scalar>                     x(Teuchos::rcp(x_inout,false));
  // Describe the arguments
  Teuchos::EVerbosityLevel vl = Teuchos::VERB_MEDIUM;
  if(out) *out << "\nStarting CG solver ...\n" << std::scientific << "\ndescribe A:\n"<<describe(A,vl)
               << "\ndescribe b:\n"<<describe(b,vl)<<"\ndescribe x:\n"<<describe(x,vl)<<"\n";
  return silliestCgSolve(A,b,maxNumIters,tolerance,x,out);
} // end sillierCgSolve

#endif // THYRA_SILLIER_CG_SOLVE_HPP