BelosStatusTestResNorm.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                 Belos: Block Linear Solvers Package
//
// Copyright 2004-2016 NTESS and the Belos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef BELOS_STATUS_TEST_RESNORM_H
#define BELOS_STATUS_TEST_RESNORM_H

#include "BelosStatusTest.hpp"
#include "BelosLinearProblem.hpp"
#include "BelosMultiVecTraits.hpp"

namespace Belos {

template <class ScalarType, class MV, class OP>
class StatusTestResNorm: public StatusTest<ScalarType,MV,OP> {

 public:

  // Convenience typedefs
  typedef Teuchos::ScalarTraits<ScalarType> SCT;
  typedef typename SCT::magnitudeType MagnitudeType;
  typedef MultiVecTraits<ScalarType,MV>  MVT;




  virtual int setTolerance(MagnitudeType tolerance) = 0;

  virtual int setQuorum(int quorum) = 0;

  virtual int setShowMaxResNormOnly(bool showMaxResNormOnly) = 0;

  virtual int defineScaleForm( ScaleType TypeOfScaling, NormType TypeOfNorm, MagnitudeType ScaleValue = Teuchos::ScalarTraits<MagnitudeType>::one()) = 0;




  virtual int getQuorum() const = 0;

  virtual bool getShowMaxResNormOnly() = 0;

  virtual std::vector<int> convIndices() = 0;

  virtual MagnitudeType getTolerance() const = 0;
 
  virtual const std::vector<MagnitudeType>* getTestValue() const = 0;
 
  virtual Teuchos::RCP<MV> getSolution() = 0;

  virtual bool getLOADetected() const = 0;


};

} // end namespace Belos

#endif /* BELOS_STATUS_TEST_RESNORM_H */