Thyra_MultiVectorTester.hpp

Go to the documentation of this file.
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_MULTI_VECTOR_TESTER_HPP
00030 #define THYRA_MULTI_VECTOR_TESTER_HPP
00031 
00032 #include "Thyra_MultiVectorTesterDecl.hpp"
00033 
00034 namespace Thyra {
00035 
00036 template<class Scalar>
00037 MultiVectorTester<Scalar>::MultiVectorTester(
00038   const ScalarMag     warning_tol
00039   ,const ScalarMag    error_tol
00040   ,const int          num_random_vectors
00041   ,const bool         show_all_tests
00042   ,const bool         dump_all
00043   )
00044   :warning_tol_(warning_tol)
00045   ,error_tol_(error_tol)
00046   ,num_random_vectors_(num_random_vectors)
00047   ,show_all_tests_(show_all_tests)
00048   ,dump_all_(dump_all)
00049 {
00050   linearOpTester_.set_all_warning_tol(warning_tol);
00051   linearOpTester_.set_all_error_tol(error_tol);
00052   linearOpTester_.num_random_vectors(num_random_vectors);
00053   linearOpTester_.show_all_tests(show_all_tests);
00054   linearOpTester_.dump_all(dump_all);
00055 }
00056 
00057 template<class Scalar>
00058 bool MultiVectorTester<Scalar>::check(
00059   const MultiVectorBase<Scalar>  &mv
00060   ,Teuchos::FancyOStream         *out_arg
00061   ) const
00062 {
00063 
00064   using std::endl;
00065   using Teuchos::describe;
00066   using Teuchos::FancyOStream;
00067   using Teuchos::OSTab;
00068   typedef Teuchos::ScalarTraits<Scalar> ST;
00069   typedef typename ST::magnitudeType    ScalarMag;
00070 
00071   Teuchos::RefCountPtr<FancyOStream> out = Teuchos::rcp(out_arg,false);
00072   const Teuchos::EVerbosityLevel verbLevel = (dump_all()?Teuchos::VERB_EXTREME:Teuchos::VERB_MEDIUM);
00073 
00074   OSTab tab(out,1,"THYRA");
00075 
00076   bool result, success = true;
00077 
00078   if(out.get()) *out <<endl<< "*** Entering Thyra::MultiVectorTester<"<<ST::name()<<">::check(mv,...) ...\n";
00079 
00080   if(out.get()) *out <<endl<< "Testing a MultiVectorBase object mv described as:\n" << describe(mv,verbLevel);
00081   
00082   // ToDo: Test the specific VectorBase interface
00083   
00084   if(out.get()) *out <<endl<< "Checking the LinearOpBase interface of mv ...\n";
00085   result =linearOpTester_.check(mv,out.get());
00086   if(!result) success = false;
00087 
00088   if(out.get()) {
00089     if(success)
00090       *out << endl <<"Congratulations, this MultiVectorBase object seems to check out!\n";
00091     else
00092       *out << endl <<"Oh no, at least one of the tests performed with this MultiVectorBase object failed (see above failures)!\n";
00093     *out << endl << "*** Leaving MultiVectorTester<"<<ST::name()<<">::check(mv,...)\n";
00094   }
00095   
00096   return success;
00097 
00098 }
00099 
00100 } // namespace Thyra
00101 
00102 #endif // THYRA_MULTI_VECTOR_TESTER_HPP

Generated on Thu Sep 18 12:33:03 2008 for Thyra Package Browser (Single Doxygen Collection) by doxygen 1.3.9.1