Ifpack2_ConfigDefs.hpp

// @HEADER
// *****************************************************************************
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//
// Copyright 2009 NTESS and the Ifpack2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef _IFPACK2_CONFIGDEFS_HPP_
#define _IFPACK2_CONFIGDEFS_HPP_

#include <Ifpack2_config.h>
#include <Teuchos_ScalarTraits.hpp>
#include <Tpetra_ConfigDefs.hpp>

//The sgn function isn't well defined for complex.
//Is it correct to operate on the real part of x as is done below?
template<class Scalar>
typename Teuchos::ScalarTraits<Scalar>::magnitudeType
IFPACK2_SGN(const Scalar& x)
{
  typedef Teuchos::ScalarTraits<Scalar> STS;
  typedef typename STS::magnitudeType magnitudeType;
  static const magnitudeType one = STS::magnitude(STS::one());
  return STS::real(x) > 0.0 ? magnitudeType(-one) : one;
}

namespace Ifpack2 {
  typedef Tpetra::global_size_t global_size_t;

  namespace Details {
    enum RelaxationType {
      JACOBI,  
      GS,      
      SGS,     
      MTGS,    
      MTSGS,   
      MTSPLITJACOBI, 
      RICHARDSON, 
      GS2,     
      SGS2     
    };
  } // namespace Details

  namespace Experimental {
  }

  namespace DeprecatedAndMayDisappearAtAnyTime {}

} // namespace Ifpack2

#endif /*_IFPACK2_CONFIGDEFS_HPP_*/