MueLu Version of the Day
Loading...
Searching...
No Matches
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
77
78
86
87namespace MueLu {
88
108 template<class Scalar = DefaultScalar,
111 class Node = DefaultNode>
113#undef MUELU_FACTORYMANAGER_SHORT
115
116 public:
117
119
120
123 SetIgnoreUserData(false); // set IgnorUserData flag to false (default behaviour)
124# ifdef HAVE_MUELU_SERIAL
125 if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosSerialWrapperNode).name())
126 useKokkos_ = false;
127# endif
128# ifdef HAVE_MUELU_OPENMP
129 if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosOpenMPWrapperNode).name())
130 useKokkos_ = true;
131# endif
132# ifdef HAVE_MUELU_CUDA
133 if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosCudaWrapperNode).name())
134 useKokkos_ = true;
135# endif
136# ifdef HAVE_MUELU_HIP
137 if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosHIPWrapperNode).name())
138 useKokkos_ = true;
139# endif
140 }
141
143 FactoryManager(const std::map<std::string, RCP<const FactoryBase> >& factoryTable) {
144 factoryTable_ = factoryTable;
145 SetIgnoreUserData(false); // set IgnorUserData flag to false (default behaviour) //TODO: use parent class constructor instead
146# ifdef HAVE_MUELU_SERIAL
147 if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosSerialWrapperNode).name())
148 useKokkos_ = false;
149# endif
150# ifdef HAVE_MUELU_OPENMP
151 if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosOpenMPWrapperNode).name())
152 useKokkos_ = true;
153# endif
154# ifdef HAVE_MUELU_CUDA
155 if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosCudaWrapperNode).name())
156 useKokkos_ = true;
157# endif
158# ifdef HAVE_MUELU_HIP
159 if (typeid(Node).name() == typeid(Kokkos::Compat::KokkosHIPWrapperNode).name())
160 useKokkos_ = true;
161# endif
162 }
163
165 virtual ~FactoryManager() { }
166
168
170
171
179 void SetFactory(const std::string & varName, const RCP<const FactoryBase>& factory);
180
186 const RCP<const FactoryBase> GetFactory(const std::string& varName) const;
187
193 const RCP<FactoryBase> GetFactoryNonConst(const std::string& varName);
194
196 // Return true if Factory associated with varName is registered
197 bool hasFactory(const std::string& varName) const;
198
199
201 const RCP<const FactoryBase> GetDefaultFactory(const std::string& varName) const;
202
203 void SetKokkosRefactor(const bool useKokkos) {
204 useKokkos_ = useKokkos;
205 }
206
207 bool GetKokkosRefactor() const { return useKokkos_; }
208
210
211 void Clean() const { defaultFactoryTable_.clear(); }
212
213#ifdef HAVE_MUELU_DEBUG
214 void ResetDebugData() const;
215#endif
216
217 void Print() const;
218
219 private:
220
222
223
229 const RCP<const FactoryBase> SetAndReturnDefaultFactory(const std::string& varName, const RCP<const FactoryBase>& factory) const;
231
239 std::map<std::string, RCP<const FactoryBase> > factoryTable_;
240
247 mutable
248 std::map<std::string, RCP<const FactoryBase> > defaultFactoryTable_;
249
252
253 }; // class
254
255} // namespace MueLu
256
257#define MUELU_FACTORYMANAGER_SHORT
258#endif // MUELU_FACTORYMANAGER_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that provides default factories within Needs class.
void SetIgnoreUserData(bool bIgnoreUserData=false)
set IgnoreUserData flag
This class specifies the default factory that should generate some data on a Level if the data does n...
const RCP< const FactoryBase > GetDefaultFactory(const std::string &varName) const
void SetKokkosRefactor(const bool useKokkos)
const RCP< const FactoryBase > SetAndReturnDefaultFactory(const std::string &varName, const RCP< const FactoryBase > &factory) const
bool useKokkos_
Whether or not to use kokkos factories.
std::map< std::string, RCP< const FactoryBase > > defaultFactoryTable_
Table that holds default factories.
void SetFactory(const std::string &varName, const RCP< const FactoryBase > &factory)
Set Factory.
bool hasFactory(const std::string &varName) const
Check.
std::map< std::string, RCP< const FactoryBase > > factoryTable_
User-defined factories.
const RCP< const FactoryBase > GetFactory(const std::string &varName) const
Get factory associated with a particular data name.
FactoryManager(const std::map< std::string, RCP< const FactoryBase > > &factoryTable)
Constructor used by HierarchyFactory (temporary, will be removed)
const RCP< FactoryBase > GetFactoryNonConst(const std::string &varName)
Get factory associated with a particular data name (NONCONST version)
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar