BelosTypes.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_TYPES_HPP
#define BELOS_TYPES_HPP

#include "BelosConfigDefs.hpp"
#include "Teuchos_Assert.hpp"

namespace Belos {



  class BelosError : public std::logic_error {
  public:
    BelosError (const std::string& what_arg) : std::logic_error(what_arg) {}
  };



  enum ETrans     {     NOTRANS = 0,  
                        TRANS = 1,    
                        CONJTRANS = 2 
  };

  enum NormType {   OneNorm,       
                    TwoNorm,       
                    InfNorm,       
                    PreconditionerNorm 
  };

  enum ScaleType {NormOfRHS,     
                  NormOfInitRes, 
                  NormOfPrecInitRes, 
                  None,          
                  UserProvided,  
                  NormOfFullInitRes, 
                  NormOfFullPrecInitRes, 
                  NormOfFullScaledInitRes, 
                  NormOfFullScaledPrecInitRes 
  };

  enum OutputType {General,     
                   Brief,       
                   User         
  };

  enum ReturnType {
    Converged,  
    Unconverged 
  };

  std::string
  convertReturnTypeToString (const ReturnType result);

  enum StatusType {     Passed = 0x1,      
                        Failed = 0x2,      
                        Undefined = 0x4    
  };

  enum ResetType  {     Problem = 0x1,           
                        RecycleSubspace = 0x2    
  };

  BELOS_DEPRECATED const char*
  toString (const StatusType status);

  std::string
  convertStatusTypeToString (const StatusType status);

  StatusType
  convertStringToStatusType (const std::string& status);

  NormType
  convertStringToNormType (const std::string& normType);

  ScaleType
  convertStringToScaleType (const std::string& scaleType);

  std::string
  convertScaleTypeToString (const ScaleType scaleType);

  enum ConjType {
    NO_CONJ,      
    CONJ          
  };

  enum MsgType {
    Errors= 0,                  
    Warnings = 0x1,             
    IterationDetails = 0x2,     
    OrthoDetails = 0x4,         
    FinalSummary = 0x8,         
    TimingDetails = 0x10,       
    StatusTestDetails = 0x20,   
    Debug = 0x40                
  };

  std::string
  convertMsgTypeToString (const MsgType msgType);

  struct DefaultSolverParameters {
    static const double convTol;

    static const double polyTol;

    static const double orthoKappa;

    static const double resScaleFactor;

    static const double impTolScale;
  };


} // end Belos namespace

#endif /* BELOS_TYPES_HPP */