MueLu  Version of the Day
MueLu_MLParameterListInterpreter_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 
47 #ifndef MUELU_MLPARAMETERLISTINTERPRETER_DECL_HPP
48 #define MUELU_MLPARAMETERLISTINTERPRETER_DECL_HPP
49 
50 #include <Teuchos_ParameterList.hpp>
51 
52 #include <Xpetra_Matrix_fwd.hpp>
53 #include <Xpetra_MultiVector_fwd.hpp>
54 #include <Xpetra_Operator_fwd.hpp>
55 
56 #include "MueLu_ConfigDefs.hpp"
59 
60 #include "MueLu_Hierarchy_fwd.hpp"
62 
64 #include "MueLu_SaPFactory_fwd.hpp"
65 #include "MueLu_PgPFactory_fwd.hpp"
75 #include "MueLu_RAPFactory_fwd.hpp"
81 
82 #if defined(HAVE_MUELU_ISORROPIA) && defined(HAVE_MPI)
88 #endif
89 
90 namespace MueLu {
91 
92  /*
93  Utility that from an existing Teuchos::ParameterList creates a new list, in
94  which level-specific parameters are replaced with sublists.
95 
96  Currently, level-specific parameters that begin with "smoother:"
97  or "aggregation:" are placed in sublists. Coarse options are also placed
98  in a coarse list.
99 
100  Example:
101  Input:
102  smoother: type (level 0) = symmetric Gauss-Seidel
103  smoother: sweeps (level 0) = 1
104  Output:
105  smoother: list (level 0) ->
106  smoother: type = symmetric Gauss-Seidel
107  smoother: sweeps = 1
108  */
109  // This function is a copy of ML_CreateSublists to avoid dependency on ML
110  // Throw exception on error instead of exit()
111  void CreateSublists(const ParameterList &List, ParameterList &newList);
112 
113 
123  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
124  class MLParameterListInterpreter : public HierarchyManager<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
125 #undef MUELU_MLPARAMETERLISTINTERPRETER_SHORT
126 #include "MueLu_UseShortNames.hpp"
127 
128  public:
130 
131 
134 
143  MLParameterListInterpreter(Teuchos::ParameterList & paramList, Teuchos::RCP<const Teuchos::Comm<int> > comm = Teuchos::null, std::vector<RCP<FactoryBase> > factoryList = std::vector<RCP<FactoryBase> >(0));
144 
152  MLParameterListInterpreter(const std::string & xmlFileName,std::vector<RCP<FactoryBase> > factoryList = std::vector<RCP<FactoryBase> >(0));
153 
156 
158 
160 
161  void SetParameterList(const Teuchos::ParameterList & paramList);
162 
164 
166 
168  virtual void SetupHierarchy(Hierarchy & H) const;
169 
171 
173 
176 
177 
179  // @param AFact: Factory used by smoother to find 'A'
180  static RCP<SmootherFactory> GetSmootherFactory(const Teuchos::ParameterList & paramList, const RCP<FactoryBase> & AFact = Teuchos::null);
181 
183 
184 
186 
187 
193  void AddTransferFactory(const RCP<FactoryBase> & factory);
194 
196  size_t NumTransferFactories() const;
198 
199  private:
200 
203  double* nullspace_; //TODO: replace by Teuchos::ArrayRCP<>
204 
206  double* xcoord_;
207  double* ycoord_;
208  double* zcoord_;
209 
214  std::vector<RCP<FactoryBase> > TransferFacts_;
215 
217 
219  virtual void SetupOperator(Operator & Op) const;
220 
222  int blksize_;
223 
225 
226  }; // class MLParameterListInterpreter
227 
228 } // namespace MueLu
229 
230 #define MUELU_MLPARAMETERLISTINTERPRETER_SHORT
231 #endif /* MUELU_MLPARAMETERLISTINTERPRETER_DECL_HPP */
double * xcoord_
coordinates can be embedded in the ML parameter list
Namespace for MueLu classes and methods.
void AddTransferFactory(const RCP< FactoryBase > &factory)
Add transfer factory in the end of list of transfer factories for RAPFactory.
virtual void SetupHierarchy(Hierarchy &H) const
Setup Hierarchy object.
void CreateSublists(const ParameterList &List, ParameterList &newList)
static RCP< SmootherFactory > GetSmootherFactory(const Teuchos::ParameterList &paramList, const RCP< FactoryBase > &AFact=Teuchos::null)
Read smoother options and build the corresponding smoother factory.
virtual void SetupOperator(Operator &Op) const
Setup Operator object.
size_t NumTransferFactories() const
Returns number of transfer factories.
int nullspaceDim_
nullspace can be embedded in the ML parameter list
Class that accepts ML-style parameters and builds a MueLu preconditioner. This interpreter uses the s...
void SetParameterList(const Teuchos::ParameterList &paramList)
Provides methods to build a multigrid hierarchy and apply multigrid cycles.