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 
72 #include "MueLu_PgPFactory_fwd.hpp"
73 #include "MueLu_RAPFactory_fwd.hpp"
77 #include "MueLu_SaPFactory_fwd.hpp"
87 
88 #ifdef HAVE_MUELU_KOKKOS_REFACTOR
96 #endif
97 
98 namespace MueLu {
99 
100  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
102  public HierarchyManager<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
103 #undef MUELU_PARAMETERLISTINTERPRETER_SHORT
104 #include "MueLu_UseShortNames.hpp"
105  typedef std::pair<std::string, const FactoryBase*> keep_pair;
106 
107  public:
109 
110 
122  ParameterListInterpreter(Teuchos::ParameterList& paramList, Teuchos::RCP<const Teuchos::Comm<int> > comm = Teuchos::null, Teuchos::RCP<FactoryFactory> factFact = Teuchos::null);
123 
133  ParameterListInterpreter(const std::string& xmlFileName, const Teuchos::Comm<int>& comm, Teuchos::RCP<FactoryFactory> factFact = Teuchos::null);
134 
137 
139 
156  void SetParameterList(const Teuchos::ParameterList& paramList);
157 
159  void SetupHierarchy(Hierarchy& H) const;
160 
161  private:
163  virtual void SetupOperator(Operator& A) const;
164 
167  GlobalOrdinal dofOffset_;
168 
170 
171  // These two variables are only needed to print out proper [default]
174 
175  void SetEasyParameterList(const Teuchos::ParameterList& paramList);
176  void Validate(const Teuchos::ParameterList& paramList) const;
177 
178  void UpdateFactoryManager(Teuchos::ParameterList& paramList, const Teuchos::ParameterList& defaultList, FactoryManager& manager,
179  int levelID, std::vector<keep_pair>& keeps) const;
180 
183 
185  // TODO:
186  // - parameter list validator
187  // - SetParameterList
188  // - Set/Get directly Level manager
189  // - build per level
190  // - comments/docs
191  // - use FactoryManager instead of FactoryMap
193  void SetFactoryParameterList(const Teuchos::ParameterList& paramList);
194 
195  typedef std::map<std::string, RCP<const FactoryBase> > FactoryMap; //TODO: remove this line
196  typedef std::map<std::string, RCP<FactoryManagerBase> > FactoryManagerMap;
197 
198  void BuildFactoryMap(const Teuchos::ParameterList& paramList, const FactoryMap& factoryMapIn, FactoryMap& factoryMapOut, FactoryManagerMap& factoryManagers) const;
199 
201  Teuchos::RCP<FactoryFactory> factFact_;
203  };
204 
205 } // namespace MueLu
206 
207 #define MUELU_PARAMETERLISTINTERPRETER_SHORT
208 #endif /* MUELU_PARAMETERLISTINTERPRETER_DECL_HPP */
This class specifies the default factory that should generate some data on a Level if the data does n...
void SetupHierarchy(Hierarchy &H) const
Call the SetupHierarchy routine from the HiearchyManager object.
void UpdateFactoryManager(Teuchos::ParameterList &paramList, const Teuchos::ParameterList &defaultList, FactoryManager &manager, int levelID, std::vector< keep_pair > &keeps) const
Namespace for MueLu classes and methods.
std::map< std::string, RCP< FactoryManagerBase > > FactoryManagerMap
virtual void SetupOperator(Operator &A) const
Setup Operator object.
int blockSize_
block size of matrix (fixed block size)
Teuchos::RCP< FactoryFactory > factFact_
Internal factory for factories.
std::map< std::string, RCP< const FactoryBase > > FactoryMap
void SetFactoryParameterList(const Teuchos::ParameterList &paramList)
Factory interpreter stuff.
std::pair< std::string, const FactoryBase * > keep_pair
ParameterListInterpreter(Teuchos::ParameterList &paramList, Teuchos::RCP< const Teuchos::Comm< int > > comm=Teuchos::null, Teuchos::RCP< FactoryFactory > factFact=Teuchos::null)
Constructor that accepts a user-provided ParameterList.
GlobalOrdinal dofOffset_
global offset variable describing offset of DOFs in operator
void BuildFactoryMap(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, FactoryMap &factoryMapOut, FactoryManagerMap &factoryManagers) const
void SetParameterList(const Teuchos::ParameterList &paramList)
Set parameter list for Parameter list interpreter.
void Validate(const Teuchos::ParameterList &paramList) 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)