BelosStatusTestLogResNorm.hpp

Go to the documentation of this file.

//@HEADER
// ************************************************************************
//
//                 Belos: Block Linear Solvers Package
//                  Copyright 2004 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
//@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 StatusTestLogResNorm: public StatusTest<ScalarType,MV,OP> {

public:
  typedef typename Teuchos::ScalarTraits<ScalarType>::magnitudeType MagnitudeType;

private:

  typedef MultiVecTraits<ScalarType,MV> MVT;

 public:



  StatusTestLogResNorm(int maxIters);

  virtual ~StatusTestLogResNorm() {};




  StatusType checkStatus(Iteration<ScalarType,MV,OP> *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> 
  StatusTestLogResNorm<ScalarType,MV,OP>::StatusTestLogResNorm(int maxIters)
  {
    if (maxIters < 1)
      maxIters_ = 1;
    else
      maxIters_ = maxIters;

    logResNorm_.reserve( maxIters_ );
    
    nIters_ = 0;
  }
  
  template <class ScalarType, class MV, class OP>
  StatusType StatusTestLogResNorm<ScalarType,MV,OP>::checkStatus(Iteration<ScalarType,MV,OP> *iSolver )
  {
    // Check that this solve is a single-vector, single-block.
    const LinearProblem<ScalarType,MV,OP>& 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>
  void StatusTestLogResNorm<ScalarType,MV,OP>::reset()
  {
    nIters_ = 0;
    logResNorm_.clear();
    logResNorm_.reserve( maxIters_ );
  }    
    
  template <class ScalarType, class MV, class OP>
  void StatusTestLogResNorm<ScalarType,MV,OP>::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>
  void StatusTestLogResNorm<ScalarType,MV,OP>::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 */