MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_LowPrecisionFactory_decl.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_LOWPRECISIONFACTORY_DECL_HPP
47 #define MUELU_LOWPRECISIONFACTORY_DECL_HPP
48 
49 #include <string>
50 
51 #include "MueLu_ConfigDefs.hpp"
53 
54 #include "MueLu_Level_fwd.hpp"
56 
57 namespace MueLu {
58 
64 template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
66 #undef MUELU_LOWPRECISIONFACTORY_SHORT
67 #include "MueLu_UseShortNames.hpp"
68 
69  public:
71 
72 
74 
76  virtual ~LowPrecisionFactory() {}
77 
79 
81 
83 
84 
85  void DeclareInput(Level& currentLevel) const;
86 
88 
90 
91 
97  void Build(Level& currentLevel) const;
98 
100 
101 }; // class LowPrecisionFactory
102 
103 #if defined(HAVE_TPETRA_INST_DOUBLE) && defined(HAVE_TPETRA_INST_FLOAT)
104 template <class LocalOrdinal, class GlobalOrdinal, class Node>
105 class LowPrecisionFactory<double, LocalOrdinal, GlobalOrdinal, Node> : public SingleLevelFactoryBase {
106  typedef double Scalar;
107 #undef MUELU_LOWPRECISIONFACTORY_SHORT
108 #include "MueLu_UseShortNames.hpp"
109 
110  public:
112 
113 
115 
117  virtual ~LowPrecisionFactory() {}
118 
119  RCP<const ParameterList> GetValidParameterList() const;
120 
122 
124 
125 
126  void DeclareInput(Level& currentLevel) const;
127 
129 
131 
132 
138  void Build(Level& currentLevel) const;
139 
141 
142 }; // class LowPrecisionFactory
143 #endif
144 
145 #if defined(HAVE_TPETRA_INST_COMPLEX_DOUBLE) && defined(HAVE_TPETRA_INST_COMPLEX_FLOAT)
146 template <class LocalOrdinal, class GlobalOrdinal, class Node>
147 class LowPrecisionFactory<std::complex<double>, LocalOrdinal, GlobalOrdinal, Node> : public SingleLevelFactoryBase {
148  typedef std::complex<double> Scalar;
149 #undef MUELU_LOWPRECISIONFACTORY_SHORT
150 #include "MueLu_UseShortNames.hpp"
151 
152  public:
154 
155 
157 
159  virtual ~LowPrecisionFactory() {}
160 
161  RCP<const ParameterList> GetValidParameterList() const;
162 
164 
166 
167 
168  void DeclareInput(Level& currentLevel) const;
169 
171 
173 
174 
180  void Build(Level& currentLevel) const;
181 
183 
184 }; // class LowPrecisionFactory
185 #endif
186 
187 } // namespace MueLu
188 
189 #define MUELU_LOWPRECISIONFACTORY_SHORT
190 #endif // MUELU_LOWPRECISIONFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Factory for converting matrices to half precision operators.
MueLu::DefaultNode Node
void Build(Level &currentLevel) const
Build method.
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void DeclareInput(Level &currentLevel) const
Input.
Base class for factories that use one level (currentLevel).