MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
61 #include "MueLu_RAPFactory_fwd.hpp"
64 #include "MueLu_SaPFactory_fwd.hpp"
71 
72 #ifdef HAVE_MUELU_KOKKOS_REFACTOR
79 #endif
80 
81 namespace MueLu {
82 
102  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
104 #undef MUELU_FACTORYMANAGER_SHORT
105 #include "MueLu_UseShortNames.hpp"
106 
107  public:
108 
110 
111 
114  SetIgnoreUserData(false); // set IgnorUserData flag to false (default behaviour)
115 #if defined(HAVE_MUELU_KOKKOS_REFACTOR) && defined(HAVE_MUELU_KOKKOS_REFACTOR_USE_BY_DEFAULT)
116  useKokkos_ = true;
117 #else
118  useKokkos_ = false;
119 #endif
120  }
121 
123  FactoryManager(const std::map<std::string, RCP<const FactoryBase> >& factoryTable) {
124  factoryTable_ = factoryTable;
125  SetIgnoreUserData(false); // set IgnorUserData flag to false (default behaviour) //TODO: use parent class constructor instead
126 #if defined(HAVE_MUELU_KOKKOS_REFACTOR) && defined(HAVE_MUELU_KOKKOS_REFACTOR_USE_BY_DEFAULT)
127  useKokkos_ = true;
128 #else
129  useKokkos_ = false;
130 #endif
131  }
132 
134  virtual ~FactoryManager() { }
135 
137 
139 
140 
148  void SetFactory(const std::string & varName, const RCP<const FactoryBase>& factory);
149 
155  const RCP<const FactoryBase> GetFactory(const std::string& varName) const;
156 
162  const RCP<FactoryBase> GetFactoryNonConst(const std::string& varName);
163 
165  // Return true if Factory associated with varName is registered
166  bool hasFactory(const std::string& varName) const;
167 
168 
170  const RCP<const FactoryBase> GetDefaultFactory(const std::string& varName) const;
171 
172  void SetKokkosRefactor(const bool useKokkos) {
173  useKokkos_ = useKokkos;
174  }
175 
177 
178  void Clean() const { defaultFactoryTable_.clear(); }
179 
180 #ifdef HAVE_MUELU_DEBUG
181  void ResetDebugData() const;
182 #endif
183 
184  void Print() const;
185 
186  private:
187 
189 
190 
196  const RCP<const FactoryBase> SetAndReturnDefaultFactory(const std::string& varName, const RCP<const FactoryBase>& factory) const;
198 
206  std::map<std::string, RCP<const FactoryBase> > factoryTable_;
207 
214  mutable
215  std::map<std::string, RCP<const FactoryBase> > defaultFactoryTable_;
216 
219 
220  }; // class
221 
222 } // namespace MueLu
223 
224 #define MUELU_FACTORYMANAGER_SHORT
225 #endif // MUELU_FACTORYMANAGER_DECL_HPP
This class specifies the default factory that should generate some data on a Level if the data does n...
virtual ~FactoryManager()
Destructor.
void SetIgnoreUserData(bool bIgnoreUserData=false)
set IgnoreUserData flag
void SetKokkosRefactor(const bool useKokkos)
const RCP< const FactoryBase > GetDefaultFactory(const std::string &varName) const
bool hasFactory(const std::string &varName) const
Check.
const RCP< const FactoryBase > GetFactory(const std::string &varName) const
Get factory associated with a particular data name.
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)
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)
bool useKokkos_
Whether or not to use kokkos factories.