MueLu Version of the Day
Loading...
Searching...
No Matches
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_GraphBase.hpp"
55#include "MueLu_Level_fwd.hpp"
57
58namespace MueLu {
59
65 template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
67#undef MUELU_LOWPRECISIONFACTORY_SHORT
69
70 public:
71
73
74
76
79
80 RCP<const ParameterList> GetValidParameterList() const;
81
83
85
86
87 void DeclareInput(Level& currentLevel) const;
88
90
92
93
99 void Build(Level& currentLevel) const;
100
102
103 }; //class LowPrecisionFactory
104
105
106#if defined(HAVE_TPETRA_INST_DOUBLE) && defined(HAVE_TPETRA_INST_FLOAT)
107 template <class LocalOrdinal, class GlobalOrdinal, class Node>
108 class LowPrecisionFactory<double,LocalOrdinal,GlobalOrdinal,Node> : public SingleLevelFactoryBase {
109 typedef double Scalar;
110#undef MUELU_LOWPRECISIONFACTORY_SHORT
112
113 public:
114
116
117
119
121 virtual ~LowPrecisionFactory() { }
122
123 RCP<const ParameterList> GetValidParameterList() const;
124
126
128
129
130 void DeclareInput(Level& currentLevel) const;
131
133
135
136
142 void Build(Level& currentLevel) const;
143
145
146 }; //class LowPrecisionFactory
147#endif
148
149
150#if defined(HAVE_TPETRA_INST_COMPLEX_DOUBLE) && defined(HAVE_TPETRA_INST_COMPLEX_FLOAT)
151 template <class LocalOrdinal, class GlobalOrdinal, class Node>
152 class LowPrecisionFactory<std::complex<double>,LocalOrdinal,GlobalOrdinal,Node> : public SingleLevelFactoryBase {
153 typedef std::complex<double> Scalar;
154#undef MUELU_LOWPRECISIONFACTORY_SHORT
156
157 public:
158
160
161
163
165 virtual ~LowPrecisionFactory() { }
166
167 RCP<const ParameterList> GetValidParameterList() const;
168
170
172
173
174 void DeclareInput(Level& currentLevel) const;
175
177
179
180
186 void Build(Level& currentLevel) const;
187
189
190 }; //class LowPrecisionFactory
191#endif
192
193
194} //namespace MueLu
195
196#define MUELU_LOWPRECISIONFACTORY_SHORT
197#endif // MUELU_LOWPRECISIONFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
Factory for converting matrices to half precision operators.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &currentLevel) const
Input.
void Build(Level &currentLevel) const
Build method.
Base class for factories that use one level (currentLevel).
Namespace for MueLu classes and methods.