BelosTypes.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                 Belos: Block Linear Solvers Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef BELOS_TYPES_HPP
#define BELOS_TYPES_HPP

namespace Belos {
  
  enum ETrans     { NOTRANS = 0,  
      TRANS = 1,    
      CONJTRANS = 2 
  };
  
  enum NormType {   OneNorm,       
        TwoNorm,       
        InfNorm        
  };
  
  enum ReturnType {   Ok,     
        Undefined,  
        Error   
  };
  
  enum StatusType {   Unchecked = 2,   
      Unconverged = 1, 
      Converged = 0,   
      Failed = -1,     
      NaN = -2         
  };

  inline
  const char* toString(const StatusType status)
  {
    switch(status) {
      case Unchecked:
        return "Unchecked";
      case Unconverged:
        return "Unconverged";
      case Converged:
        return "Converged";
      case Failed:
        return "Failed";
      case NaN:
        return "NaN";
      default:
        TEST_FOR_EXCEPT(true);
    }
    return NULL; // Should never be called!
  }
  
  enum ConjType {
    NO_CONJ,      
    CONJ          
  };
  
  enum MsgType 
    {
      Errors= 0,                  
      Warnings = 0x1,             
      IterationDetails = 0x2,     
      OrthoDetails = 0x4,         
      FinalSummary = 0x8,         
      TimingDetails = 0x10,       
      Debug = 0x20                
    };

} // end Belos namespace

#endif /* BELOS_TYPES_HPP */

---