MueLu  Version of the Day
MueLu_FactoryManagerBase.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_FACTORYMANAGERBASE_HPP
47 #define MUELU_FACTORYMANAGERBASE_HPP
48 
49 #include <string>
50 
51 #include "MueLu_ConfigDefs.hpp"
52 #include "MueLu_BaseClass.hpp"
53 
55 
56 namespace MueLu {
57 
63  class FactoryManagerBase : public BaseClass {
64 
65  public:
68 
70  virtual ~FactoryManagerBase() { }
71 
73 
75 
77  // Return ref because user also give ref to the Hierarchy.
78  const virtual RCP<const FactoryBase> GetFactory(const std::string& varName) const = 0;
80 
81  // Free temporarily hold data at the end of Hierarchy::Setup()
82  // This method is const because the clean concerns only mutable data.
83  virtual void Clean() const { } // TODO: should be used inside of MueLu::Hierarchy
84 
85 #ifdef HAVE_MUELU_DEBUG
86  virtual void ResetDebugData() const = 0;
87 #endif
88 
90  bool IgnoreUserData() const { return bIgnoreUserData_; }
91 
93  void SetIgnoreUserData(bool bIgnoreUserData = false) { bIgnoreUserData_ = bIgnoreUserData; }
94 
95  private:
101 
102  }; // class FactoryManagerBase
103 
104 } // namespace MueLu
105 
106 #define MUELU_FACTORYMANAGERBASE_SHORT
107 #endif //ifndef MUELU_FACTORYMANAGERBASE_HPP
virtual ~FactoryManagerBase()
Destructor.
void SetIgnoreUserData(bool bIgnoreUserData=false)
set IgnoreUserData flag
Namespace for MueLu classes and methods.
virtual const RCP< const FactoryBase > GetFactory(const std::string &varName) const =0
Get.
Class that provides default factories within Needs class.
Base class for MueLu classes.
bool IgnoreUserData() const
get IgnoreUserData flag