BelosStatusTestLogResNorm.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_LOGRESNORM_HPP
#define BELOS_STATUS_TEST_LOGRESNORM_HPP

 
#include "BelosStatusTest.hpp"
#include "Teuchos_ScalarTraits.hpp"
#include "Teuchos_RCP.hpp"

 
namespace Belos {
 
template <class ScalarType, class MV, class OP, class DM = DefaultDenseMatrix<int,ScalarType>>
class StatusTestLogResNorm: public StatusTest<ScalarType,MV,OP,DM> {
 
public:
  typedef typename Teuchos::ScalarTraits<ScalarType>::magnitudeType MagnitudeType;
 
private:

  typedef MultiVecTraits<ScalarType,MV,DM> MVT;
 
 public:



  StatusTestLogResNorm(int maxIters);

  virtual ~StatusTestLogResNorm() {};




  StatusType checkStatus(Iteration<ScalarType,MV,OP,DM> *iSolver );

  StatusType getStatus() const {return(Undefined);}




  void reset();

  void setMaxIters(int maxIters) { maxIters_ = maxIters; logResNorm_.reserve( maxIters_ ); }




  int getMaxIters() const { return(maxIters_); }

  int getNumIters() const { return(nIters_); }

  const std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType>&
      getLogResNorm() const { return(logResNorm_); }




  void print(std::ostream& os, int indent = 0) const;

  void printStatus(std::ostream& os, StatusType type) const;

 

  std::string description() const 
  {  
    std::ostringstream oss; 
    oss << "Belos::StatusTestLogResNorm<>: [ " << getNumIters() << " / " << getMaxIters() << " ]"; 
    return oss.str();
  }

 
private:



  int maxIters_;

  int nIters_;

  std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> logResNorm_;

 
};
 
  template <class ScalarType, class MV, class OP, class DM> 
  StatusTestLogResNorm<ScalarType,MV,OP,DM>::StatusTestLogResNorm(int maxIters)
  {
    if (maxIters < 1)
      maxIters_ = 1;
    else
      maxIters_ = maxIters;
 
    logResNorm_.reserve( maxIters_ );
    
    nIters_ = 0;
  }
  
  template <class ScalarType, class MV, class OP, class DM>
  StatusType StatusTestLogResNorm<ScalarType,MV,OP,DM>::checkStatus(Iteration<ScalarType,MV,OP,DM> *iSolver )
  {
    // Check that this solve is a single-vector, single-block.
    const LinearProblem<ScalarType,MV,OP,DM>& lp = iSolver->getProblem ();
    int blkSize = lp.getLSIndex().size();
    int numRHS = MVT::GetNumberVecs( *(lp.getRHS()) );
 
    int currIters = iSolver->getNumIters();
 
    if ( (numRHS==1) && (blkSize==1) && (currIters!=nIters_) )
    {
      std::vector<MagnitudeType> tmp_resvector( 1 );
      Teuchos::RCP<const MV> residMV = iSolver->getNativeResiduals (&tmp_resvector);
      if (! residMV.is_null ()) 
      {
        // We got a multivector back.  Compute the norms explicitly.
        MVT::MvNorm (*residMV, tmp_resvector, TwoNorm);
      }
 
      logResNorm_.push_back( tmp_resvector[0] );
      nIters_ = currIters;
    }
 
    return Undefined;
  }
  
  template <class ScalarType, class MV, class OP, class DM>
  void StatusTestLogResNorm<ScalarType,MV,OP,DM>::reset()
  {
    nIters_ = 0;
    logResNorm_.clear();
    logResNorm_.reserve( maxIters_ );
  }    
    
  template <class ScalarType, class MV, class OP, class DM>
  void StatusTestLogResNorm<ScalarType,MV,OP,DM>::print(std::ostream& os, int indent) const
  {
    for (int j = 0; j < indent; j ++)
      os << ' ';
    printStatus(os, Undefined);
    os << "Logging Absolute Residual 2-Norm" << std::endl;
  }
 
  template <class ScalarType, class MV, class OP, class DM>
  void StatusTestLogResNorm<ScalarType,MV,OP,DM>::printStatus(std::ostream& os, StatusType type) const 
  {
    os << std::left << std::setw(13) << std::setfill('.');
    os << "**";
    os << std::left << std::setfill(' ');
    return;
  } 
 
} // end Belos namespace
 
#endif /* BELOS_STATUS_TEST_LOGRESNORM_HPP */