MueLu  Version of the Day
MueLu_HierarchyHelpers_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_HIERARCHYHELPERS_DECL_HPP
47 #define MUELU_HIERARCHYHELPERS_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 
54 #include "MueLu_Level_fwd.hpp"
60 #include "MueLu_Hierarchy_fwd.hpp"
62 
63 // Warning: on TopRAPFactory and TopSmootherFactory constructors, Teuchos::null doesn't mean "default factory" but "no build"
64 
65 namespace MueLu {
66 
69 
70  public:
71 
73 
75  SetFactoryManager(const RCP<Level> & level, const RCP<const FactoryManagerBase> & factoryManager)
76  : level_(level), prevFactoryManager_(level->GetFactoryManager())
77  {
78  // set new factory manager
79  level->SetFactoryManager(factoryManager);
80  }
81 
83  virtual ~SetFactoryManager() {
84  // restore previous factory manager
85  level_->SetFactoryManager(prevFactoryManager_);
86  }
87 
89 
90  private:
91  // needed to save & restore previous factoryManager
92  const RCP<Level> level_;
93  const RCP<const FactoryManagerBase> prevFactoryManager_;
94  };
95 
96  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
98 #include "MueLu_UseShortNames.hpp"
99 
100  public:
101 
102  TopRAPFactory(RCP<const FactoryManagerBase> parentFactoryManager);
103  TopRAPFactory(RCP<const FactoryManagerBase> parentFactoryManagerFine, RCP<const FactoryManagerBase> parentFactoryManagerCoarse);
104 
105  virtual ~TopRAPFactory();
106 
107  void DeclareInput(Level & fineLevel, Level & coarseLevel) const;
108 
109  void Build(Level & fineLevel, Level & coarseLevel) const;
110 
111  private:
112  RCP<const FactoryBase> PFact_;
113  RCP<const FactoryBase> RFact_;
114  RCP<const FactoryBase> AcFact_;
115  };
116 
117  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
118  class TopSmootherFactory : public SingleLevelFactoryBase { //TODO: inherit from SmootherFactoryBase ?
119 #include "MueLu_UseShortNames.hpp"
120 
121  public:
122 
123  TopSmootherFactory(RCP<const FactoryManagerBase> parentFactoryManager, const std::string& varName);
124 
125  virtual ~TopSmootherFactory();
126 
127  void DeclareInput(Level & level) const;
128 
129  void Build(Level & level) const;
130 
131  private:
132  RCP<const FactoryBase> preSmootherFact_;
133  RCP<const FactoryBase> postSmootherFact_;
134  };
135 
136 
137  template <class Scalar,
138  class LocalOrdinal = int,
139  class GlobalOrdinal = LocalOrdinal,
140  class Node = KokkosClassic::DefaultNode::DefaultNodeType>
142 #include "MueLu_UseShortNames.hpp"
143  public:
149  static void AddNonSerializableDataToHierarchy(HierarchyManager& HM, Hierarchy& H, const ParameterList& nonSerialList);
150  };
151 
152 
153 
154 
155 } // namespace MueLu
156 
157 #define MUELU_HIERARCHYHELPERS_SHORT
158 #endif // MUELU_HIERARCHYHELPERS_DECL_HPP
virtual ~SetFactoryManager()
Destructor.
Base class for factories that use two levels (fineLevel and coarseLevel).
Namespace for MueLu classes and methods.
RCP< const FactoryBase > PFact_
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
RCP< const FactoryBase > preSmootherFact_
RCP< const FactoryBase > postSmootherFact_
RCP< const FactoryBase > RFact_
RCP< const FactoryBase > AcFact_
An exception safe way to call the method &#39;Level::SetFactoryManager()&#39;.
const RCP< const FactoryManagerBase > prevFactoryManager_
Base class for factories that use one level (currentLevel).
Provides methods to build a multigrid hierarchy and apply multigrid cycles.
SetFactoryManager(const RCP< Level > &level, const RCP< const FactoryManagerBase > &factoryManager)