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

 
#include "BelosConfigDefs.hpp"
#include "Teuchos_Assert.hpp"
#ifdef HAVE_BELOS_DENSEMATRIXKOKKOSDEFAULT
#include "Kokkos_DualView.hpp"
#include "KokkosKernels_ArithTraits.hpp"
#else
#include "Teuchos_SerialDenseMatrix.hpp"
#endif
 
#ifdef HAVE_BELOS_TPETRA
#include "Tpetra_MultiVector.hpp"
#endif
 
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 : int {
    Converged = 0,   
    Unconverged = 1, 
    MaxItersReached = 2,        
    MaxRestartsReached = 3,      // GMRES
    OrthonormFailure= 4,         // BlockCG
    NaNDetected = 5,            
    BreakdownDetected = 6,       // BlockCG
    LossOfAccuracyDetected = 7,  // GMRES
    NonspecificException = 8,   
    InconsistentState = 9,      
    Undetermined = 10           
  };
 
  inline constexpr bool compare(int lhs_int, int rhs_int) {
    if (lhs_int == 1) {
      return (rhs_int >= 1);
    }
    else if (rhs_int == 1) {
      return (lhs_int >= 1);
    }
    else {
      return (lhs_int == rhs_int);
    }
  }
 
  constexpr bool operator==(ReturnType lhs, ReturnType rhs) {
    int lhs_int = static_cast<int>(lhs);
    int rhs_int = static_cast<int>(rhs);
    return compare(lhs_int, rhs_int);
  }
 
  constexpr bool operator==(ReturnType lhs, int rhs_int) {
    int lhs_int = static_cast<int>(lhs);
    return compare(lhs_int, rhs_int);
  }
 
  constexpr bool operator==(int lhs_int, ReturnType rhs) {
    int rhs_int = static_cast<int>(rhs);
    return compare(lhs_int, rhs_int);
  }
 
  constexpr bool operator!=(ReturnType lhs, ReturnType rhs) {
    int lhs_int = static_cast<int>(lhs);
    int rhs_int = static_cast<int>(rhs);
    return !compare(lhs_int, rhs_int);
  }
 
  constexpr bool operator!=(ReturnType lhs, int rhs_int) {
    int lhs_int = static_cast<int>(lhs);
    return !compare(lhs_int, rhs_int);
  }
 
  constexpr bool operator!=(int lhs_int, ReturnType rhs) {
    int rhs_int = static_cast<int>(rhs);
    return !compare(lhs_int, rhs_int);
  }

  std::string
  convertReturnTypeToString (const ReturnType result);

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

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

  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;
  };
 
  enum DenseMatrixType {
    TeuchosSerialDenseMatrix,
    KokkosDualView
  };
 
#ifdef HAVE_BELOS_DENSEMATRIXKOKKOSDEFAULT
 
#ifdef HAVE_BELOS_TPETRA
 
  template <class Ordinal, class Scalar>
  using DefaultDenseMatrix = typename ::Tpetra::MultiVector<Scalar>::wrapped_dual_view_type::DVT;
 
#else
 
  template <class Ordinal, class Scalar>
  using DefaultDenseMatrix = Kokkos::DualView<typename KokkosKernels::ArithTraits<Scalar>::val_type **, Kokkos::LayoutLeft>;
 
#endif
 
  constexpr const DenseMatrixType defaultDenseMatrixType = KokkosDualView;
 
#else
 
  template <class Ordinal, class Scalar>
  using DefaultDenseMatrix = Teuchos::SerialDenseMatrix<Ordinal, Scalar>;
 
  constexpr const DenseMatrixType defaultDenseMatrixType = TeuchosSerialDenseMatrix;
 
#endif
 
} // end Belos namespace
 
#endif /* BELOS_TYPES_HPP */