Ifpack2 Templated Preconditioning Package Version 1.0
Ifpack2_ConfigDefs.hpp
00001 /*@HEADER
00002 // ***********************************************************************
00003 //
00004 //       Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
00005 //                 Copyright (2009) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00041 */
00042
00043 #ifndef _IFPACK2_CONFIGDEFS_HPP_
00044 #define _IFPACK2_CONFIGDEFS_HPP_
00045
00046 #include <Ifpack2_config.h>
00047 #include <Teuchos_ScalarTraits.hpp>
00048 #include <Tpetra_ConfigDefs.hpp>
00049
00050 //The sgn function isn't well defined for complex.
00051 //Is it correct to operate on the real part of x as is done below?
00052 template<class Scalar>
00053 typename Teuchos::ScalarTraits<Scalar>::magnitudeType
00054 IFPACK2_SGN(const Scalar& x)
00055 {
00056   typedef Teuchos::ScalarTraits<Scalar> STS;
00057   typedef typename STS::magnitudeType magnitudeType;
00058   static const magnitudeType one = STS::magnitude(STS::one());
00059   return STS::real(x) > 0.0 ? magnitudeType(-one) : one;
00060 }
00061
00064 namespace Ifpack2 {
00065   typedef Tpetra::global_size_t global_size_t;
00066
00073   namespace Details {
00079     enum RelaxationType {
00080       JACOBI,
00081       GS,
00082       SGS
00083     };
00084   } // namespace Details
00085 } // namespace Ifpack2
00086
00087 #endif /*_IFPACK2_CONFIGDEFS_HPP_*/