Belos Package Browser (Single Doxygen Collection) Development
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 the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
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 BELOS_STATUS_TEST_RESNORM_H
00043 #define BELOS_STATUS_TEST_RESNORM_H
00044 
00050 #include "BelosStatusTest.hpp"
00051 #include "BelosLinearProblem.hpp"
00052 #include "BelosMultiVecTraits.hpp"
00053 
00059 namespace Belos {
00060 
00061 template <class ScalarType, class MV, class OP>
00062 class StatusTestResNorm: public StatusTest<ScalarType,MV,OP> {
00063 
00064  public:
00065 
00066   // Convenience typedefs
00067   typedef Teuchos::ScalarTraits<ScalarType> SCT;
00068   typedef typename SCT::magnitudeType MagnitudeType;
00069   typedef MultiVecTraits<ScalarType,MV>  MVT;
00070 
00072 
00073 
00075 
00078   virtual int setTolerance(MagnitudeType tolerance) = 0;
00079 
00082   virtual int setQuorum(int quorum) = 0;
00083 
00085   virtual int setShowMaxResNormOnly(bool showMaxResNormOnly) = 0;
00086 
00088   virtual int defineScaleForm( ScaleType TypeOfScaling, NormType TypeOfNorm, MagnitudeType ScaleValue = Teuchos::ScalarTraits<MagnitudeType>::one()) = 0;
00089 
00091 
00093 
00094 
00097   virtual int getQuorum() const = 0;
00098 
00100   virtual bool getShowMaxResNormOnly() = 0;
00101 
00103   virtual std::vector<int> convIndices() = 0;
00104 
00106   virtual MagnitudeType getTolerance() const = 0;
00107  
00109   virtual const std::vector<MagnitudeType>* getTestValue() const = 0;
00110  
00113   virtual Teuchos::RCP<MV> getSolution() = 0;
00114 
00116   virtual bool getLOADetected() const = 0;
00117 
00119 
00120 };
00121 
00122 } // end namespace Belos
00123 
00124 #endif /* BELOS_STATUS_TEST_RESNORM_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines