Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_ConfigDefs.hpp
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
5 // Copyright (2009) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 */
42 
43 #ifndef _IFPACK2_CONFIGDEFS_HPP_
44 #define _IFPACK2_CONFIGDEFS_HPP_
45 
46 #include <Ifpack2_config.h>
47 #include <Teuchos_ScalarTraits.hpp>
48 #include <Tpetra_ConfigDefs.hpp>
49 
50 #if defined(HAVE_TPETRA_DEBUG) && ! defined(HAVE_IFPACK2_DEBUG)
51 # define HAVE_IFPACK2_DEBUG 1
52 #endif
53 
54 //The sgn function isn't well defined for complex.
55 //Is it correct to operate on the real part of x as is done below?
56 template<class Scalar>
57 typename Teuchos::ScalarTraits<Scalar>::magnitudeType
58 IFPACK2_SGN(const Scalar& x)
59 {
60  typedef Teuchos::ScalarTraits<Scalar> STS;
61  typedef typename STS::magnitudeType magnitudeType;
62  static const magnitudeType one = STS::magnitude(STS::one());
63  return STS::real(x) > 0.0 ? magnitudeType(-one) : one;
64 }
65 
68 namespace Ifpack2 {
69  typedef Tpetra::global_size_t global_size_t;
70 
77  namespace Details {
83  enum RelaxationType {
84  JACOBI,
85  GS,
86  SGS
87  };
88  } // namespace Details
89 
94  namespace Experimental {
95  }
96 } // namespace Ifpack2
97 
98 #endif /*_IFPACK2_CONFIGDEFS_HPP_*/
Ifpack2 features that are experimental. Use at your own risk.
Ifpack2 implementation details.
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:72