MueLu  Version of the Day
MueLu_FactoryManager_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_FACTORYMANAGER_DECL_HPP
47 #define MUELU_FACTORYMANAGER_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
52 
63 #include "MueLu_RAPFactory_fwd.hpp"
66 #include "MueLu_SaPFactory_fwd.hpp"
77 
78 
79 #ifdef HAVE_MUELU_KOKKOS_REFACTOR
87 #endif
88 
89 namespace MueLu {
90 
110  template<class Scalar = DefaultScalar,
113  class Node = DefaultNode>
115 #undef MUELU_FACTORYMANAGER_SHORT
116 #include "MueLu_UseShortNames.hpp"
117 
118  public:
119 
121 
122 
125  SetIgnoreUserData(false); // set IgnorUserData flag to false (default behaviour)
126 #if !defined(HAVE_MUELU_KOKKOS_REFACTOR)
127  useKokkos_ = false;
128 #else
129 # ifdef HAVE_MUELU_SERIAL
130  if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosSerialWrapperNode).name())
131  useKokkos_ = false;
132 # endif
133 # ifdef HAVE_MUELU_OPENMP
134  if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosOpenMPWrapperNode).name())
135  useKokkos_ = true;
136 # endif
137 # ifdef HAVE_MUELU_CUDA
138  if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosCudaWrapperNode).name())
139  useKokkos_ = true;
140 # endif
141 # ifdef HAVE_MUELU_HIP
142  if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosHIPWrapperNode).name())
143  useKokkos_ = true;
144 # endif
145 #endif
146  }
147 
149  FactoryManager(const std::map<std::string, RCP<const FactoryBase> >& factoryTable) {
150  factoryTable_ = factoryTable;
151  SetIgnoreUserData(false); // set IgnorUserData flag to false (default behaviour) //TODO: use parent class constructor instead
152 #if !defined(HAVE_MUELU_KOKKOS_REFACTOR)
153  useKokkos_ = false;
154 #else
155 # ifdef HAVE_MUELU_SERIAL
156  if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosSerialWrapperNode).name())
157  useKokkos_ = false;
158 # endif
159 # ifdef HAVE_MUELU_OPENMP
160  if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosOpenMPWrapperNode).name())
161  useKokkos_ = true;
162 # endif
163 # ifdef HAVE_MUELU_CUDA
164  if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosCudaWrapperNode).name())
165  useKokkos_ = true;
166 # endif
167 # ifdef HAVE_MUELU_HIP
168  if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosHIPWrapperNode).name())
169  useKokkos_ = true;
170 # endif
171 #endif
172  }
173 
175  virtual ~FactoryManager() { }
176 
178 
180 
181 
189  void SetFactory(const std::string & varName, const RCP<const FactoryBase>& factory);
190 
196  const RCP<const FactoryBase> GetFactory(const std::string& varName) const;
197 
203  const RCP<FactoryBase> GetFactoryNonConst(const std::string& varName);
204 
206  // Return true if Factory associated with varName is registered
207  bool hasFactory(const std::string& varName) const;
208 
209 
211  const RCP<const FactoryBase> GetDefaultFactory(const std::string& varName) const;
212 
213  void SetKokkosRefactor(const bool useKokkos) {
214  useKokkos_ = useKokkos;
215  }
216 
217  bool GetKokkosRefactor() const { return useKokkos_; }
218 
220 
221  void Clean() const { defaultFactoryTable_.clear(); }
222 
223 #ifdef HAVE_MUELU_DEBUG
224  void ResetDebugData() const;
225 #endif
226 
227  void Print() const;
228 
229  private:
230 
232 
233 
239  const RCP<const FactoryBase> SetAndReturnDefaultFactory(const std::string& varName, const RCP<const FactoryBase>& factory) const;
241 
249  std::map<std::string, RCP<const FactoryBase> > factoryTable_;
250 
257  mutable
258  std::map<std::string, RCP<const FactoryBase> > defaultFactoryTable_;
259 
262 
263  }; // class
264 
265 } // namespace MueLu
266 
267 #define MUELU_FACTORYMANAGER_SHORT
268 #endif // MUELU_FACTORYMANAGER_DECL_HPP
This class specifies the default factory that should generate some data on a Level if the data does n...
MueLu::DefaultLocalOrdinal LocalOrdinal
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
bool hasFactory(const std::string &varName) const
Check.
virtual ~FactoryManager()
Destructor.
void SetIgnoreUserData(bool bIgnoreUserData=false)
set IgnoreUserData flag
void SetKokkosRefactor(const bool useKokkos)
Namespace for MueLu classes and methods.
MueLu::DefaultNode Node
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
const RCP< const FactoryBase > SetAndReturnDefaultFactory(const std::string &varName, const RCP< const FactoryBase > &factory) const
Class that provides default factories within Needs class.
void SetFactory(const std::string &varName, const RCP< const FactoryBase > &factory)
Set Factory.
const RCP< FactoryBase > GetFactoryNonConst(const std::string &varName)
Get factory associated with a particular data name (NONCONST version)
const RCP< const FactoryBase > GetFactory(const std::string &varName) const
Get factory associated with a particular data name.
std::map< std::string, RCP< const FactoryBase > > factoryTable_
User-defined factories.
std::map< std::string, RCP< const FactoryBase > > defaultFactoryTable_
Table that holds default factories.
FactoryManager(const std::map< std::string, RCP< const FactoryBase > > &factoryTable)
Constructor used by HierarchyFactory (temporary, will be removed)
const RCP< const FactoryBase > GetDefaultFactory(const std::string &varName) const
bool useKokkos_
Whether or not to use kokkos factories.