BelosStatusTestResNorm.hpp

Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                 Belos: Block Linear Solvers Package
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 BELOS_STATUS_TEST_RESNORM_H
00030 #define BELOS_STATUS_TEST_RESNORM_H
00031 
00037 #include "BelosStatusTest.hpp"
00038 #include "BelosLinearProblem.hpp"
00039 #include "BelosMultiVecTraits.hpp"
00040 
00046 namespace Belos {
00047 
00048 template <class ScalarType, class MV, class OP>
00049 class StatusTestResNorm: public StatusTest<ScalarType,MV,OP> {
00050 
00051  public:
00052 
00053   // Convenience typedefs
00054   typedef Teuchos::ScalarTraits<ScalarType> SCT;
00055   typedef typename SCT::magnitudeType MagnitudeType;
00056   typedef MultiVecTraits<ScalarType,MV>  MVT;
00057 
00059 
00060 
00062 
00065   virtual int setTolerance(MagnitudeType tolerance) = 0;
00066 
00069   virtual int setQuorum(int quorum) = 0;
00070 
00072   virtual int setShowMaxResNormOnly(bool showMaxResNormOnly) = 0;
00073 
00075   virtual int defineScaleForm( ScaleType TypeOfScaling, NormType TypeOfNorm, MagnitudeType ScaleValue = Teuchos::ScalarTraits<MagnitudeType>::one()) = 0;
00076 
00078 
00080 
00081 
00084   virtual int getQuorum() const = 0;
00085 
00087   virtual std::vector<int> convIndices() = 0;
00088 
00090   virtual MagnitudeType getTolerance() const = 0;
00091   
00094   virtual Teuchos::RCP<MV> getSolution() = 0;
00095 
00097   virtual bool getLOADetected() const = 0;
00098 
00100 
00101 };
00102 
00103 } // end namespace Belos
00104 
00105 #endif /* BELOS_STATUS_TEST_RESNORM_H */

Generated on Tue Oct 20 12:48:34 2009 for Belos by doxygen 1.4.7