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 
61 #include "MueLu_RAPFactory_fwd.hpp"
63 #include "MueLu_SaPFactory_fwd.hpp"
70 
71 namespace MueLu {
72 
92  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
94 #undef MUELU_FACTORYMANAGER_SHORT
95 #include "MueLu_UseShortNames.hpp"
96 
97  public:
98 
100 
101 
104  SetIgnoreUserData(false); // set IgnorUserData flag to false (default behaviour)
105  }
106 
108  FactoryManager(const std::map<std::string, RCP<const FactoryBase> >& factoryTable) {
109  factoryTable_ = factoryTable;
110  SetIgnoreUserData(false); // set IgnorUserData flag to false (default behaviour) //TODO: use parent class constructor instead
111  }
112 
114  virtual ~FactoryManager() { }
115 
117 
119 
120 
128  void SetFactory(const std::string & varName, const RCP<const FactoryBase>& factory);
129 
135  const RCP<const FactoryBase> GetFactory(const std::string& varName) const;
136 
138  const RCP<const FactoryBase> GetDefaultFactory(const std::string& varName) const;
139 
141 
142  void Clean() const { defaultFactoryTable_.clear(); }
143 
144 #ifdef HAVE_MUELU_DEBUG
145  void ResetDebugData() const;
146 #endif
147 
148  void Print() const;
149 
150  private:
151 
153 
154 
160  const RCP<const FactoryBase> SetAndReturnDefaultFactory(const std::string& varName, const RCP<const FactoryBase>& factory) const;
162 
170  std::map<std::string, RCP<const FactoryBase> > factoryTable_;
171 
178  mutable
179  std::map<std::string, RCP<const FactoryBase> > defaultFactoryTable_;
180 
181  }; // class
182 
183 } // namespace MueLu
184 
185 #define MUELU_FACTORYMANAGER_SHORT
186 #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
const RCP< const FactoryBase > GetDefaultFactory(const std::string &varName) const
Namespace for MueLu classes and methods.
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.
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)