MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_ConfigDefs.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // MueLu: A package for multigrid based preconditioning
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 #ifndef MUELU_CONFIGDEFS_HPP
47 #define MUELU_CONFIGDEFS_HPP
48 
49 #include "MueLu_config.hpp"
50 
51 #include <Teuchos_ConfigDefs.hpp>
52 
53 // Kokkos
54 #include <Kokkos_DefaultNode.hpp> // default template parameter of many MueLu classes
55 
56 // Memory management
57 #include <Teuchos_Array.hpp>
58 #include <Teuchos_ArrayView.hpp>
59 #include <Teuchos_ArrayRCP.hpp>
60 #include <Teuchos_RCP.hpp>
61 
62 // Verbose levels
63 #include <Teuchos_Describable.hpp>
64 
65 // Misc
67 
68 // Default S,L,G,N types, for use as default template arguments
69 // Available as MueLu::DefaultScalar, MueLu::DefaultLocalOrdinal, etc.
71 
72 // Special macro for exception testing
73 // MUELU_TEST_FOR_EXCEPTION is only active if MueLu is configured with MueLu_ENABLE_DEBUG:BOOL=ON
74 // If you want an exception test both in the release and debug version of MueLu you still can use directly
75 // TEUCHOS_TEST_FOR_EXCEPTION
76 #ifdef HAVE_MUELU_DEBUG
77 #define MUELU_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg) \
78  TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg);
79 #else
80 #define MUELU_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
81 #endif
82 
84 namespace MueLu {
85 
86  // import Teuchos memory management classes into MueLu
87  using Teuchos::arcp;
88  using Teuchos::arcpFromArrayView;
89  using Teuchos::arcp_reinterpret_cast;
90  using Teuchos::Array;
91  using Teuchos::ArrayRCP;
92  using Teuchos::ArrayView;
93  using Teuchos::as;
94  using Teuchos::null;
96  using Teuchos::rcp;
97  using Teuchos::RCP;
98  using Teuchos::rcp_const_cast;
99  using Teuchos::rcp_dynamic_cast;
100  using Teuchos::rcpFromRef;
101  using Teuchos::rcp_implicit_cast;
102  using Teuchos::rcp_static_cast;
103 
104  // verbose levels
105  using Teuchos::VERB_DEFAULT;
106  using Teuchos::VERB_NONE;
107  using Teuchos::VERB_LOW;
108  using Teuchos::VERB_MEDIUM;
109  using Teuchos::VERB_HIGH;
110  using Teuchos::VERB_EXTREME;
111 
112 }
113 
114 // This include file defines macros to avoid warnings under CUDA. See github issue #1133.
115 #include "Teuchos_CompilerCodeTweakMacros.hpp"
116 
117 #endif /* MUELU_CONFIGDEFS_H */
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
TypeTo as(const TypeFrom &t)