MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_FactoryBase.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_FACTORYBASE_HPP
47 #define MUELU_FACTORYBASE_HPP
48 
49 #include "MueLu_config.hpp"
50 #include "MueLu_BaseClass.hpp"
51 #include "MueLu_Level_fwd.hpp"
52 
53 namespace MueLu {
54 
60 class FactoryBase : public virtual BaseClass {
61  public:
63 
67 
69  virtual ~FactoryBase() {}
71 
73 
75  virtual void CallBuild(Level& requestedLevel) const = 0;
76 
77  virtual void CallDeclareInput(Level& requestedLevel) const = 0;
79 
81 
84  int GetID() const { return id_; };
85 
87 
88 #ifdef HAVE_MUELU_DEBUG
89  virtual void ResetDebugData() const = 0;
90 #endif
91 
92  private:
93  static int GenerateUniqueId();
94 
95  const int id_;
96 
97 }; // class FactoryBase
98 
99 } // namespace MueLu
100 
101 #define MUELU_FACTORYBASE_SHORT
102 #endif // ifndef MUELU_FACTORYBASE_HPP
virtual void CallDeclareInput(Level &requestedLevel) const =0
virtual ~FactoryBase()
Destructor.
virtual void CallBuild(Level &requestedLevel) const =0
static int GenerateUniqueId()
int GetID() const
return unique factory id
Base class for factories (e.g., R, P, and A_coarse).
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Base class for MueLu classes.
FactoryBase()
Constructor.