MueLu  Version of the Day
MueLu_ParameterListInterpreter_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_PARAMETERLISTINTERPRETER_DECL_HPP
47 #define MUELU_PARAMETERLISTINTERPRETER_DECL_HPP
48 
49 #include <Teuchos_ParameterList.hpp>
50 
51 #include <Xpetra_Matrix_fwd.hpp>
52 #include <Xpetra_Operator_fwd.hpp>
53 
54 #include "MueLu_ConfigDefs.hpp"
56 
68 #include "MueLu_FacadeClassBase.hpp"
69 #include "MueLu_FacadeClassFactory.hpp"
79 #include "MueLu_PgPFactory_fwd.hpp"
80 #include "MueLu_RAPFactory_fwd.hpp"
86 #include "MueLu_SaPFactory_fwd.hpp"
96 #ifdef HAVE_MUELU_MATLAB
100 #endif
101 
102 
103 #ifdef HAVE_MUELU_KOKKOS_REFACTOR
112 #endif
113 
114 #ifdef HAVE_MUELU_INTREPID2
116 #endif
117 
118 namespace MueLu {
119 
120  template <class Scalar = DefaultScalar,
123  class Node = DefaultNode>
125  public HierarchyManager<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
126 #undef MUELU_PARAMETERLISTINTERPRETER_SHORT
127 #include "MueLu_UseShortNames.hpp"
128  typedef std::pair<std::string, const FactoryBase*> keep_pair;
129 
130  public:
132 
133 
134  protected:
140  factFact_ = Teuchos::null;
141  facadeFact_ = Teuchos::rcp(new FacadeClassFactory());
142  }
143 
144  public:
157  ParameterListInterpreter(Teuchos::ParameterList& paramList, Teuchos::RCP<const Teuchos::Comm<int> > comm = Teuchos::null, Teuchos::RCP<FactoryFactory> factFact = Teuchos::null, Teuchos::RCP<FacadeClassFactory> facadeFact = Teuchos::null);
158 
169  ParameterListInterpreter(const std::string& xmlFileName, const Teuchos::Comm<int>& comm, Teuchos::RCP<FactoryFactory> factFact = Teuchos::null, Teuchos::RCP<FacadeClassFactory> facadeFact = Teuchos::null);
170 
173 
175 
192  void SetParameterList(const Teuchos::ParameterList& paramList);
193 
195  void SetupHierarchy(Hierarchy& H) const;
196 
197  private:
199  virtual void SetupOperator(Operator& A) const;
200 
204  double scalingFactor_;
206 
208 
209  // These two variables are only needed to print out proper [default]
212 
213  void SetEasyParameterList(const Teuchos::ParameterList& paramList);
214  void Validate(const Teuchos::ParameterList& paramList) const;
215 
216  void UpdateFactoryManager(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
217  int levelID, std::vector<keep_pair>& keeps) const;
218 
219  // "Generic components" for UpdateFactoryManager
220  void UpdateFactoryManager_Smoothers(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
221  int levelID, std::vector<keep_pair>& keeps) const;
222  void UpdateFactoryManager_CoarseSolvers(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
223  int levelID, std::vector<keep_pair>& keeps) const;
224  void UpdateFactoryManager_Aggregation_TentativeP(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
225  int levelID, std::vector<keep_pair>& keeps) const;
226  void UpdateFactoryManager_Restriction(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
227  int levelID, std::vector<keep_pair>& keeps) const;
228  void UpdateFactoryManager_RAP(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
229  int levelID, std::vector<keep_pair>& keeps) const;
230  void UpdateFactoryManager_Coordinates(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
231  int levelID, std::vector<keep_pair>& keeps) const;
232  void UpdateFactoryManager_Repartition(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
233  int levelID, std::vector<keep_pair>& keeps, RCP<Factory> & nullSpaceFactory) const;
234  void UpdateFactoryManager_Nullspace(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
235  int levelID, std::vector<keep_pair>& keeps, RCP<Factory> & nullSpaceFactory) const;
236  void UpdateFactoryManager_BlockNumber(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList,
237  FactoryManager& manager,int levelID, std::vector<keep_pair>& keeps) const;
238  void UpdateFactoryManager_LocalOrdinalTransfer(const std::string& VarName, const std::string& multigridAlgo, Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList,
239  FactoryManager& manager,int levelID, std::vector<keep_pair>& keeps) const;
240 
241  // Algorithm-specific components for UpdateFactoryManager
242  void UpdateFactoryManager_SemiCoarsen(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
243  int levelID, std::vector<keep_pair>& keeps) const;
244  void UpdateFactoryManager_PCoarsen(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
245  int levelID, std::vector<keep_pair>& keeps) const;
246  void UpdateFactoryManager_SA(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
247  int levelID, std::vector<keep_pair>& keeps) const;
248  void UpdateFactoryManager_Reitzinger(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
249  int levelID, std::vector<keep_pair>& keeps) const;
250  void UpdateFactoryManager_Emin(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
251  int levelID, std::vector<keep_pair>& keeps) const;
252  void UpdateFactoryManager_PG(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
253  int levelID, std::vector<keep_pair>& keeps) const;
254  void UpdateFactoryManager_Matlab(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
255  int levelID, std::vector<keep_pair>& keeps) const;
256 
257 
258 
259 
264 
266  // TODO:
267  // - parameter list validator
268  // - SetParameterList
269  // - Set/Get directly Level manager
270  // - build per level
271  // - comments/docs
272  // - use FactoryManager instead of FactoryMap
274  void SetFactoryParameterList(const Teuchos::ParameterList& paramList);
275 
276  typedef std::map<std::string, RCP<const FactoryBase> > FactoryMap; //TODO: remove this line
277  typedef std::map<std::string, RCP<FactoryManagerBase> > FactoryManagerMap;
278 
279  void BuildFactoryMap(const Teuchos::ParameterList& paramList, const FactoryMap& factoryMapIn, FactoryMap& factoryMapOut, FactoryManagerMap& factoryManagers) const;
280 
282  Teuchos::RCP<FactoryFactory> factFact_;
283 
285  Teuchos::RCP<MueLu::FacadeClassFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node> > facadeFact_;
286 
288  };
289 
290 } // namespace MueLu
291 
292 #define MUELU_PARAMETERLISTINTERPRETER_SHORT
293 #endif /* MUELU_PARAMETERLISTINTERPRETER_DECL_HPP */
This class specifies the default factory that should generate some data on a Level if the data does n...
MueLu::DefaultLocalOrdinal LocalOrdinal
int WCycleStartLevel_
in case of W-cycle, level on which cycle should start
double scalingFactor_
prolongator scaling factor
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
void UpdateFactoryManager_CoarseSolvers(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
void UpdateFactoryManager_Smoothers(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
void BuildFactoryMap(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, FactoryMap &factoryMapOut, FactoryManagerMap &factoryManagers) const
Interpret "Factories" sublist.
void UpdateFactoryManager_SA(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
virtual void SetupOperator(Operator &A) const
Setup Operator object.
Namespace for MueLu classes and methods.
void UpdateFactoryManager_Repartition(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps, RCP< Factory > &nullSpaceFactory) const
void UpdateFactoryManager_Aggregation_TentativeP(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
std::map< std::string, RCP< FactoryManagerBase > > FactoryManagerMap
std::map< std::string, RCP< const FactoryBase > > FactoryMap
MueLu::DefaultNode Node
void UpdateFactoryManager_PG(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
void UpdateFactoryManager_RAP(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
void UpdateFactoryManager_PCoarsen(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
Teuchos::RCP< MueLu::FacadeClassFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > > facadeFact_
FacadeClass factory.
int blockSize_
block size of matrix (fixed block size)
void UpdateFactoryManager_BlockNumber(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
Teuchos::RCP< FactoryFactory > factFact_
Internal factory for factories.
MueLu::DefaultScalar Scalar
void UpdateFactoryManager(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
MueLu::DefaultGlobalOrdinal GlobalOrdinal
void UpdateFactoryManager_Nullspace(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps, RCP< Factory > &nullSpaceFactory) const
std::map< std::string, RCP< const FactoryBase > > FactoryMap
void Validate(const Teuchos::ParameterList &paramList) const
void SetFactoryParameterList(const Teuchos::ParameterList &paramList)
Factory interpreter stuff.
std::pair< std::string, const FactoryBase * > keep_pair
void UpdateFactoryManager_SemiCoarsen(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
void UpdateFactoryManager_Emin(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
void UpdateFactoryManager_Reitzinger(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
GlobalOrdinal dofOffset_
global offset variable describing offset of DOFs in operator
void SetupHierarchy(Hierarchy &H) const
Call the SetupHierarchy routine from the HiearchyManager object.
void UpdateFactoryManager_Coordinates(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
void SetParameterList(const Teuchos::ParameterList &paramList)
Set parameter list for Parameter list interpreter.
void UpdateFactoryManager_LocalOrdinalTransfer(const std::string &VarName, const std::string &multigridAlgo, Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
void UpdateFactoryManager_Matlab(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
void UpdateFactoryManager_Restriction(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
void SetEasyParameterList(const Teuchos::ParameterList &paramList)
Provides methods to build a multigrid hierarchy and apply multigrid cycles.
CycleType Cycle_
multigrid cycle type (V-cycle or W-cycle)