MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_FactoryFactory_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_FACTORYFACTORY_DECL_HPP
47 #define MUELU_FACTORYFACTORY_DECL_HPP
48 
49 #include <string>
50 #include <vector>
51 
52 #include <Teuchos_ParameterEntry.hpp>
53 #include <Teuchos_Array.hpp>
54 
55 #include "MueLu_ConfigDefs.hpp"
56 #include "MueLu_FactoryFactory_fwd.hpp"
57 
58 #include "MueLu_HierarchyFactory.hpp"
59 
60 #include "MueLu_FactoryBase.hpp"
61 #include "MueLu_FactoryManager.hpp"
62 #include "MueLu_FactoryManagerBase_fwd.hpp"
63 #include "MueLu_FactoryManager_fwd.hpp"
64 #include "MueLu_FactoryBase_fwd.hpp"
65 #include "MueLu_Hierarchy_fwd.hpp"
66 
67 #include "MueLu_Monitor.hpp"
68 #include "MueLu_Exceptions.hpp"
69 
70 #include "MueLu_AggregationExportFactory.hpp"
71 #include "MueLu_AmalgamationFactory.hpp"
72 #include "MueLu_BlackBoxPFactory.hpp"
73 #include "MueLu_BlockedCoarseMapFactory.hpp"
74 #include "MueLu_BlockedCoordinatesTransferFactory.hpp"
75 #include "MueLu_BlockedDirectSolver.hpp"
76 #include "MueLu_BlockedGaussSeidelSmoother.hpp"
77 #include "MueLu_BlockedJacobiSmoother.hpp"
78 #include "MueLu_BlockedPFactory.hpp"
79 #include "MueLu_BlockedRAPFactory.hpp"
80 #include "MueLu_BraessSarazinSmoother.hpp"
81 #include "MueLu_BrickAggregationFactory.hpp"
82 #include "MueLu_CloneRepartitionInterface.hpp"
83 #include "MueLu_CoalesceDropFactory.hpp"
84 #include "MueLu_CoarseMapFactory.hpp"
85 #include "MueLu_CoarseningVisualizationFactory.hpp"
86 #include "MueLu_ConstraintFactory.hpp"
87 #include "MueLu_CoupledAggregationFactory.hpp"
88 #include "MueLu_CoordinatesTransferFactory.hpp"
89 #include "MueLu_DirectSolver.hpp"
90 #include "MueLu_DropNegativeEntriesFactory.hpp"
91 #include "MueLu_EminPFactory.hpp"
92 #include "MueLu_FilteredAFactory.hpp"
93 #include "MueLu_FineLevelInputDataFactory.hpp"
94 #include "MueLu_GeneralGeometricPFactory.hpp"
95 #include "MueLu_GenericRFactory.hpp"
96 #include "MueLu_GeometricInterpolationPFactory.hpp"
97 #include "MueLu_IndefBlockedDiagonalSmoother.hpp"
98 #include "MueLu_IsorropiaInterface.hpp"
99 #include "MueLu_LineDetectionFactory.hpp"
100 #include "MueLu_RepartitionInterface.hpp"
101 #include "MueLu_RepartitionBlockDiagonalFactory.hpp"
102 #include "MueLu_MapTransferFactory.hpp"
103 #include "MueLu_MatrixAnalysisFactory.hpp"
104 #include "MueLu_MultiVectorTransferFactory.hpp"
105 #include "MueLu_NullspaceFactory.hpp"
106 #include "MueLu_NullspacePresmoothFactory.hpp"
107 #include "MueLu_PatternFactory.hpp"
108 #include "MueLu_PgPFactory.hpp"
109 #include "MueLu_RebalanceBlockInterpolationFactory.hpp"
110 #include "MueLu_RebalanceBlockRestrictionFactory.hpp"
111 #include "MueLu_RebalanceBlockAcFactory.hpp"
112 #include "MueLu_RebalanceTransferFactory.hpp"
113 #include "MueLu_RepartitionFactory.hpp"
114 #include "MueLu_RepartitionHeuristicFactory.hpp"
115 #include "MueLu_RAPFactory.hpp"
116 #include "MueLu_RAPShiftFactory.hpp"
117 #include "MueLu_RebalanceAcFactory.hpp"
118 #include "MueLu_ReorderBlockAFactory.hpp"
119 #include "MueLu_SaPFactory.hpp"
120 #include "MueLu_SegregatedAFactory.hpp"
121 #include "MueLu_SemiCoarsenPFactory.hpp"
122 #include "MueLu_SchurComplementFactory.hpp"
123 #include "MueLu_SimpleSmoother.hpp"
124 #include "MueLu_SmootherFactory.hpp"
125 #include "MueLu_StructuredAggregationFactory.hpp"
126 #include "MueLu_StructuredLineDetectionFactory.hpp"
127 #include "MueLu_SubBlockAFactory.hpp"
128 #ifdef HAVE_MUELU_TEKO
129 #include "MueLu_TekoSmoother.hpp"
130 #endif
131 #include "MueLu_TentativePFactory.hpp"
132 #include "MueLu_ToggleCoordinatesTransferFactory.hpp"
133 #include "MueLu_TogglePFactory.hpp"
134 #include "MueLu_TrilinosSmoother.hpp"
135 #include "MueLu_TransPFactory.hpp"
136 #include "MueLu_UncoupledAggregationFactory.hpp"
137 #include "MueLu_HybridAggregationFactory.hpp"
138 #include "MueLu_UnsmooshFactory.hpp"
139 #include "MueLu_UserAggregationFactory.hpp"
140 #include "MueLu_UserPFactory.hpp"
141 #include "MueLu_UzawaSmoother.hpp"
142 #include "MueLu_VariableDofLaplacianFactory.hpp"
143 #include "MueLu_ZoltanInterface.hpp"
144 #include "MueLu_Zoltan2Interface.hpp"
145 #include "MueLu_NodePartitionInterface.hpp"
146 
147 
148 #ifdef HAVE_MUELU_KOKKOS_REFACTOR
149 #include "MueLu_CoalesceDropFactory_kokkos.hpp"
150 #include "MueLu_CoarseMapFactory_kokkos.hpp"
151 #include "MueLu_CoordinatesTransferFactory_kokkos.hpp"
152 #include "MueLu_GeometricInterpolationPFactory_kokkos.hpp"
153 #include "MueLu_NullspaceFactory_kokkos.hpp"
154 #include "MueLu_SaPFactory_kokkos.hpp"
155 #include "MueLu_StructuredAggregationFactory_kokkos.hpp"
156 #include "MueLu_TentativePFactory_kokkos.hpp"
157 #include "MueLu_UncoupledAggregationFactory_kokkos.hpp"
158 #endif
159 
160 #ifdef HAVE_MUELU_MATLAB
161 // This is distasteful, but (sadly) neccesary due to peculiarities in MueLu's build system.
162 #include "../matlab/src/MueLu_SingleLevelMatlabFactory_decl.hpp"
163 #include "../matlab/src/MueLu_SingleLevelMatlabFactory_def.hpp"
164 #include "../matlab/src/MueLu_TwoLevelMatlabFactory_decl.hpp"
165 #include "../matlab/src/MueLu_TwoLevelMatlabFactory_def.hpp"
166 #include "../matlab/src/MueLu_MatlabSmoother_decl.hpp"
167 #include "../matlab/src/MueLu_MatlabSmoother_def.hpp"
168 #endif
169 
170 #ifdef HAVE_MUELU_INTREPID2
171 #include "MueLu_IntrepidPCoarsenFactory.hpp"
172 #endif
173 
174 namespace MueLu {
175 
182  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
183  class FactoryFactory : public BaseClass {
184 #undef MUELU_FACTORYFACTORY_SHORT
185 #include "MueLu_UseShortNames.hpp"
186 
187  typedef std::map<std::string, RCP<const FactoryBase> > FactoryMap; // TODO: remove
188  typedef std::map<std::string, RCP<FactoryManagerBase> > FactoryManagerMap;
189 
190  public:
191 
209  virtual RCP<const FactoryBase> BuildFactory(const Teuchos::ParameterEntry& param, const FactoryMap& factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
210  // Find factory
211  std::string factoryName;
212  Teuchos::ParameterList paramList;
213  if (!param.isList()) {
214  factoryName = Teuchos::getValue<std::string>(param);
215  } else {
216  paramList = Teuchos::getValue<Teuchos::ParameterList>(param);
217  factoryName = paramList.get<std::string>("factory");
218  }
219 
220  // TODO: see how Teko handles this (=> register factories).
221  if (factoryName == "AggregationExportFactory") return Build2<AggregationExportFactory> (paramList, factoryMapIn, factoryManagersIn);
222  if (factoryName == "AmalgamationFactory") return Build2<AmalgamationFactory> (paramList, factoryMapIn, factoryManagersIn);
223  if (factoryName == "BlockedCoarseMapFactory") return Build2<BlockedCoarseMapFactory> (paramList, factoryMapIn, factoryManagersIn);
224  if (factoryName == "BlockedCoordinatesTransferFactory") return Build2<BlockedCoordinatesTransferFactory> (paramList, factoryMapIn, factoryManagersIn);
225  if (factoryName == "BlockedRAPFactory") return BuildRAPFactory<BlockedRAPFactory> (paramList, factoryMapIn, factoryManagersIn);
226  if (factoryName == "BrickAggregationFactory") return Build2<BrickAggregationFactory> (paramList, factoryMapIn, factoryManagersIn);
227  if (factoryName == "CloneRepartitionInterface") return Build2<CloneRepartitionInterface> (paramList, factoryMapIn, factoryManagersIn);
228  if (factoryName == "CoarseMapFactory") return Build2<CoarseMapFactory> (paramList, factoryMapIn, factoryManagersIn);
229  if (factoryName == "CoarseningVisualizationFactory") return Build2<CoarseningVisualizationFactory> (paramList, factoryMapIn, factoryManagersIn);
230  if (factoryName == "CoalesceDropFactory") return Build2<CoalesceDropFactory> (paramList, factoryMapIn, factoryManagersIn);
231  if (factoryName == "ConstraintFactory") return Build2<ConstraintFactory> (paramList, factoryMapIn, factoryManagersIn);
232  if (factoryName == "CoupledAggregationFactory") return BuildCoupledAggregationFactory (paramList, factoryMapIn, factoryManagersIn);
233  if (factoryName == "CoordinatesTransferFactory") return Build2<CoordinatesTransferFactory> (paramList, factoryMapIn, factoryManagersIn);
234  if (factoryName == "DirectSolver") return BuildDirectSolver (paramList, factoryMapIn, factoryManagersIn);
235  if (factoryName == "DropNegativeEntriesFactory") return Build2<DropNegativeEntriesFactory> (paramList, factoryMapIn, factoryManagersIn);
236  if (factoryName == "EminPFactory") return Build2<EminPFactory> (paramList, factoryMapIn, factoryManagersIn);
237  if (factoryName == "FilteredAFactory") return Build2<FilteredAFactory> (paramList, factoryMapIn, factoryManagersIn);
238  if (factoryName == "FineLevelInputDataFactory") return Build2<FineLevelInputDataFactory> (paramList, factoryMapIn, factoryManagersIn);
239  if (factoryName == "GeneralGeometricPFactory") return Build2<GeneralGeometricPFactory> (paramList, factoryMapIn, factoryManagersIn);
240  if (factoryName == "GenericRFactory") return Build2<GenericRFactory> (paramList, factoryMapIn, factoryManagersIn);
241  if (factoryName == "GeometricInterpolationPFactory") return Build2<GeometricInterpolationPFactory> (paramList, factoryMapIn, factoryManagersIn);
242  if (factoryName == "LineDetectionFactory") return Build2<LineDetectionFactory> (paramList, factoryMapIn, factoryManagersIn);
243  if (factoryName == "MapTransferFactory") return Build2<MapTransferFactory> (paramList, factoryMapIn, factoryManagersIn);
244  if (factoryName == "MatrixAnalysisFactory") return Build2<MatrixAnalysisFactory> (paramList, factoryMapIn, factoryManagersIn);
245  if (factoryName == "MultiVectorTransferFactory") return Build2<MultiVectorTransferFactory> (paramList, factoryMapIn, factoryManagersIn);
246  if (factoryName == "NoFactory") return MueLu::NoFactory::getRCP();
247  if (factoryName == "NoSmoother") return rcp(new SmootherFactory(Teuchos::null));
248  if (factoryName == "NullspaceFactory") return Build2<NullspaceFactory> (paramList, factoryMapIn, factoryManagersIn);
249  if (factoryName == "NullspacePresmoothFactory") return Build2<NullspacePresmoothFactory> (paramList, factoryMapIn, factoryManagersIn);
250  if (factoryName == "PatternFactory") return Build2<PatternFactory> (paramList, factoryMapIn, factoryManagersIn);
251  if (factoryName == "PgPFactory") return Build2<PgPFactory> (paramList, factoryMapIn, factoryManagersIn);
252  if (factoryName == "SaPFactory") return Build2<SaPFactory> (paramList, factoryMapIn, factoryManagersIn);
253  if (factoryName == "RAPFactory") return BuildRAPFactory<RAPFactory> (paramList, factoryMapIn, factoryManagersIn);
254  if (factoryName == "RAPShiftFactory") return BuildRAPFactory<RAPShiftFactory> (paramList, factoryMapIn, factoryManagersIn);
255  if (factoryName == "RebalanceAcFactory") return Build2<RebalanceAcFactory> (paramList, factoryMapIn, factoryManagersIn);
256  if (factoryName == "RebalanceTransferFactory") return Build2<RebalanceTransferFactory> (paramList, factoryMapIn, factoryManagersIn);
257  if (factoryName == "ReorderBlockAFactory") return Build2<ReorderBlockAFactory> (paramList, factoryMapIn, factoryManagersIn);
258  if (factoryName == "RepartitionInterface") return Build2<RepartitionInterface> (paramList, factoryMapIn, factoryManagersIn);
259  if (factoryName == "SegregatedAFactory") return Build2<SegregatedAFactory> (paramList, factoryMapIn, factoryManagersIn);
260  if (factoryName == "SemiCoarsenPFactory") return Build2<SemiCoarsenPFactory> (paramList, factoryMapIn, factoryManagersIn);
261  if (factoryName == "StructuredAggregationFactory") return Build2<StructuredAggregationFactory> (paramList, factoryMapIn, factoryManagersIn);
262  if (factoryName == "StructuredLineDetectionFactory") return Build2<StructuredLineDetectionFactory> (paramList, factoryMapIn, factoryManagersIn);
263  if (factoryName == "SubBlockAFactory") return Build2<SubBlockAFactory> (paramList, factoryMapIn, factoryManagersIn);
264  if (factoryName == "TentativePFactory") return Build2<TentativePFactory> (paramList, factoryMapIn, factoryManagersIn);
265  if (factoryName == "ToggleCoordinatesTransferFactory") return BuildToggleCoordinatesTransferFactory (paramList, factoryMapIn, factoryManagersIn);
266  if (factoryName == "TogglePFactory") return BuildTogglePFactory<TogglePFactory> (paramList, factoryMapIn, factoryManagersIn);
267  if (factoryName == "TransPFactory") return Build2<TransPFactory> (paramList, factoryMapIn, factoryManagersIn);
268  if (factoryName == "TrilinosSmoother") return BuildTrilinosSmoother (paramList, factoryMapIn, factoryManagersIn);
269  if (factoryName == "UncoupledAggregationFactory") return Build2<UncoupledAggregationFactory> (paramList, factoryMapIn, factoryManagersIn);
270  if (factoryName == "HybridAggregationFactory") return Build2<HybridAggregationFactory> (paramList, factoryMapIn, factoryManagersIn);
271  if (factoryName == "UnsmooshFactory") return Build2<UnsmooshFactory> (paramList, factoryMapIn, factoryManagersIn);
272  if (factoryName == "UserAggregationFactory") return Build2<UserAggregationFactory> (paramList, factoryMapIn, factoryManagersIn);
273  if (factoryName == "UserPFactory") return Build2<UserPFactory> (paramList, factoryMapIn, factoryManagersIn);
274  if (factoryName == "VariableDofLaplacianFactory") return Build2<VariableDofLaplacianFactory> (paramList, factoryMapIn, factoryManagersIn);
275 #ifdef HAVE_MUELU_KOKKOS_REFACTOR
276  if (factoryName == "CoalesceDropFactory_kokkos") return Build2<CoalesceDropFactory_kokkos> (paramList, factoryMapIn, factoryManagersIn);
277  if (factoryName == "CoarseMapFactory_kokkos") return Build2<CoarseMapFactory_kokkos> (paramList, factoryMapIn, factoryManagersIn);
278  if (factoryName == "CoordinatesTransferFactory_kokkos") return Build2<CoordinatesTransferFactory_kokkos> (paramList, factoryMapIn, factoryManagersIn);
279  if (factoryName == "GeometricInterpolationPFactory_kokkos") return Build2<GeometricInterpolationPFactory_kokkos> (paramList, factoryMapIn, factoryManagersIn);
280  if (factoryName == "NullspaceFactory_kokkos") return Build2<NullspaceFactory_kokkos> (paramList, factoryMapIn, factoryManagersIn);
281  if (factoryName == "SaPFactory_kokkos") return Build2<SaPFactory_kokkos> (paramList, factoryMapIn, factoryManagersIn);
282  if (factoryName == "StructuredAggregationFactory_kokkos") return Build2<StructuredAggregationFactory_kokkos> (paramList, factoryMapIn, factoryManagersIn);
283  if (factoryName == "TentativePFactory_kokkos") return Build2<TentativePFactory_kokkos> (paramList, factoryMapIn, factoryManagersIn);
284  if (factoryName == "UncoupledAggregationFactory_kokkos") return Build2<UncoupledAggregationFactory_kokkos> (paramList, factoryMapIn, factoryManagersIn);
285 #endif
286 
287  if (factoryName == "ZoltanInterface") {
288 #if defined(HAVE_MUELU_ZOLTAN) && defined(HAVE_MPI)
289  return Build2<ZoltanInterface>(paramList, factoryMapIn, factoryManagersIn);
290 #else
291  TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError, "MueLu::FactoryFactory:BuildFactory(): Cannot create a ZoltanInterface object: Zoltan is disabled: HAVE_MUELU_ZOLTAN && HAVE_MPI == false.");
292 #endif // HAVE_MUELU_ZOLTAN && HAVE_MPI
293  }
294  if (factoryName == "Zoltan2Interface") {
295 #if defined(HAVE_MUELU_ZOLTAN2) && defined(HAVE_MPI)
296  return Build2<Zoltan2Interface>(paramList, factoryMapIn, factoryManagersIn);
297 #else
298  TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError, "MueLu::FactoryFactory:BuildFactory(): Cannot create a Zoltan2Interface object: Zoltan2 is disabled: HAVE_MUELU_ZOLTAN2 && HAVE_MPI == false.");
299 #endif // HAVE_MUELU_ZOLTAN2 && HAVE_MPI
300  }
301  if (factoryName == "IsorropiaInterface") {
302 #if defined(HAVE_MUELU_ISORROPIA) && defined(HAVE_MPI)
303  return Build2<IsorropiaInterface>(paramList, factoryMapIn, factoryManagersIn);
304 #else
305  TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError, "MueLu::FactoryFactory:BuildFactory(): Cannot create a IsorropiaInterface object: Isorropia is disabled: HAVE_MUELU_ISORROPIA && HAVE_MPI == false.");
306 #endif // HAVE_MUELU_ZOLTAN2 && HAVE_MPI
307  }
308 
309  if (factoryName == "NodePartitionInterface") {
310 #if defined(HAVE_MPI)
311  return Build2<NodePartitionInterface>(paramList, factoryMapIn, factoryManagersIn);
312 #else
313  TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError, "MueLu::FactoryFactory:BuildFactory(): Cannot create a NodePartitionInterface object: HAVE_MPI == false.");
314 #endif // HAVE_MPI
315  }
316 
317  if (factoryName == "RepartitionFactory") {
318 #ifdef HAVE_MPI
319  return Build2<RepartitionFactory>(paramList, factoryMapIn, factoryManagersIn);
320 #else
321  TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError, "MueLu::FactoryFactory:BuildFactory(): Cannot create a RepartitionFactory object: HAVE_MPI == false.");
322 #endif // HAVE_MPI
323  }
324  if (factoryName == "RepartitionHeuristicFactory") {
325 #ifdef HAVE_MPI
326  return Build2<RepartitionHeuristicFactory>(paramList, factoryMapIn, factoryManagersIn);
327 #else
328  TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError, "MueLu::FactoryFactory:BuildFactory(): Cannot create a RepartitionHeuristicFactory object: HAVE_MPI == false.");
329 #endif // HAVE_MPI
330  }
331  // Blocked factories
332  if (factoryName == "BlockedDirectSolver") return BuildBlockedDirectSolver(paramList, factoryMapIn, factoryManagersIn);
333  if (factoryName == "BlockedGaussSeidelSmoother") return BuildBlockedSmoother<BlockedGaussSeidelSmoother>(paramList, factoryMapIn, factoryManagersIn);
334  if (factoryName == "BlockedJacobiSmoother") return BuildBlockedSmoother<BlockedJacobiSmoother>(paramList, factoryMapIn, factoryManagersIn);
335  if (factoryName == "BlockedPFactory") return BuildBlockedFactory<BlockedPFactory>(paramList, factoryMapIn, factoryManagersIn);
336  if (factoryName == "BraessSarazinSmoother") return BuildBlockedSmoother<BraessSarazinSmoother>(paramList, factoryMapIn, factoryManagersIn);
337  if (factoryName == "IndefiniteBlockDiagonalSmoother") return BuildBlockedSmoother<IndefBlockedDiagonalSmoother>(paramList, factoryMapIn, factoryManagersIn);
338  if (factoryName == "SimpleSmoother") return BuildBlockedSmoother<SimpleSmoother>(paramList, factoryMapIn, factoryManagersIn);
339  if (factoryName == "SchurComplementFactory") return Build2<SchurComplementFactory> (paramList, factoryMapIn, factoryManagersIn);
340  if (factoryName == "RebalanceBlockRestrictionFactory")return BuildBlockedFactory<RebalanceBlockRestrictionFactory>(paramList, factoryMapIn, factoryManagersIn);
341  if (factoryName == "RebalanceBlockAcFactory") return BuildBlockedFactory<RebalanceBlockAcFactory>(paramList, factoryMapIn, factoryManagersIn);
342  if (factoryName == "RebalanceBlockInterpolationFactory") return BuildBlockedFactory<RebalanceBlockInterpolationFactory>(paramList, factoryMapIn, factoryManagersIn);
343 #ifdef HAVE_MPI
344  if (factoryName == "RepartitionBlockDiagonalFactory") return Build2<RepartitionBlockDiagonalFactory> (paramList, factoryMapIn, factoryManagersIn);
345 #endif
346 #ifdef HAVE_MUELU_TEKO
347  if (factoryName == "TekoSmoother") return BuildTekoSmoother(paramList, factoryMapIn, factoryManagersIn);
348 #endif
349  if (factoryName == "UzawaSmoother") return BuildBlockedSmoother<UzawaSmoother>(paramList, factoryMapIn, factoryManagersIn);
350 
351  // Matlab factories
352 #ifdef HAVE_MUELU_MATLAB
353  if (factoryName == "TwoLevelMatlabFactory") return Build2<TwoLevelMatlabFactory> (paramList, factoryMapIn, factoryManagersIn);
354  if (factoryName == "SingleLevelMatlabFactory") return Build2<SingleLevelMatlabFactory> (paramList, factoryMapIn, factoryManagersIn);
355  if (factoryName == "MatlabSmoother") return BuildMatlabSmoother (paramList, factoryMapIn, factoryManagersIn);
356 #endif
357 
358 #ifdef HAVE_MUELU_INTREPID2
359  if (factoryName == "IntrepidPCoarsenFactory") return Build2<IntrepidPCoarsenFactory> (paramList, factoryMapIn, factoryManagersIn);
360 #endif
361 
362  // Use a user defined factories (in <Factories> node)
363  if (factoryMapIn.find(factoryName) != factoryMapIn.end()) {
364  TEUCHOS_TEST_FOR_EXCEPTION((param.isList() && (++paramList.begin() != paramList.end())), Exceptions::RuntimeError,
365  "MueLu::FactoryFactory: Error during the parsing of: " << std::endl << paramList << std::endl
366  << "'" << factoryName << "' is not a factory name but an existing instance of a factory." << std::endl
367  << "Extra parameters cannot be specified after the creation of the object." << std::endl << std::endl
368  << "Correct syntaxes includes:" << std::endl
369  << " <Parameter name=\"...\" type=\"string\" value=\"" << factoryName << "\"/>" << std::endl
370  << "or" << std::endl
371  << " <ParameterList name=\"...\"><Parameter name=\"factory\" type=\"string\" value=\"" << factoryName << "\"/></ParameterList>" << std::endl
372  );
373 
374  return factoryMapIn.find(factoryName)->second;
375  }
376 
377  TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError, "MueLu::FactoryFactory: unknown factory name : " << factoryName);
378 
379  TEUCHOS_UNREACHABLE_RETURN(Teuchos::null);
380  }
381 
382  //
383  //
384  //
385 
386  // FOLLOWING FUNCTIONS SHOULD LIVE WITH THE CORRESPONDING CLASS
387 
388  //
389  //
390  //
391 
392 #define arraysize(ar) (sizeof(ar) / sizeof(ar[0]))
393 
394  template <class T> // T must implement the Factory interface
395  RCP<T> Build(const Teuchos::ParameterList& paramList, const FactoryMap& factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
396  RCP<T> factory = rcp(new T());
397 
398  const char* strarray[] = {"A", "P", "R", "Graph", "UnAmalgamationInfo", "Aggregates", "Nullspace", "TransferFactory", "DofsPerNode"};
399  std::vector<std::string> v(strarray, strarray + arraysize(strarray));
400  for (size_t i = 0; i < v.size(); ++i)
401  if (paramList.isParameter(v[i]))
402  factory->SetFactory(v[i], BuildFactory(paramList.getEntry(v[i]), factoryMapIn, factoryManagersIn));
403 
404  return factory;
405  }
406 
407  template <class T> // T must implement the Factory interface
408  RCP<T> Build2(const Teuchos::ParameterList& paramList, const FactoryMap& factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
409  RCP<T> factory = rcp(new T());
410 
411  ParameterList paramListWithFactories;
412 
413  // Read the RCP<Factory> parameters of the class T
414  RCP<const ParameterList> validParamList = factory->GetValidParameterList(); // TODO check for Teuchos::null (no parameter list validation)
415  TEUCHOS_TEST_FOR_EXCEPTION(validParamList == Teuchos::null, Exceptions::RuntimeError, "FactoryFactory::Build2: default parameter list is null. Please fix this.");
416  for (ParameterList::ConstIterator param = validParamList->begin(); param != validParamList->end(); ++param) {
417  const std::string& pName = validParamList->name(param);
418 
419  if (!paramList.isParameter(pName)) {
420  // Ignore unknown parameters
421  continue;
422  }
423 
424  if (validParamList->isType< RCP<const FactoryBase> >(pName)) {
425  // Generate or get factory described by param
426  RCP<const FactoryBase> generatingFact = BuildFactory(paramList.getEntry(pName), factoryMapIn, factoryManagersIn);
427  paramListWithFactories.set(pName, generatingFact);
428  } else if (validParamList->isType<RCP<const ParameterList> >(pName)) {
429  if (pName == "ParameterList") {
430  // NOTE: we cannot use
431  // subList = sublist(rcpFromRef(paramList), pName)
432  // here as that would result in sublist also being a reference to a temporary object.
433  // The resulting dereferencing in the corresponding factory would then segfault
434  RCP<const ParameterList> subList = Teuchos::sublist(rcp(new ParameterList(paramList)), pName);
435  paramListWithFactories.set(pName, subList);
436  }
437  } else {
438  paramListWithFactories.setEntry(pName, paramList.getEntry(pName));
439  }
440  }
441 
442  // Configure the factory
443  factory->SetParameterList(paramListWithFactories);
444 
445  return factory;
446  }
447 
448  template <class T> // T must implement the Factory interface
449  RCP<T> BuildRAPFactory(const Teuchos::ParameterList & paramList, const FactoryMap& factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
450  RCP<T> factory;
451  if (paramList.isSublist("TransferFactories") == false) {
452  factory = Build2<T>(paramList, factoryMapIn, factoryManagersIn);
453 
454  } else {
455  RCP<Teuchos::ParameterList> paramListNonConst = rcp(new Teuchos::ParameterList(paramList));
456  RCP<const Teuchos::ParameterList> transferFactories = rcp(new Teuchos::ParameterList(*sublist(paramListNonConst, "TransferFactories")));
457 
458  paramListNonConst->remove("TransferFactories");
459 
460  factory = Build2<T>(*paramListNonConst, factoryMapIn, factoryManagersIn);
461 
462  for (Teuchos::ParameterList::ConstIterator param = transferFactories->begin(); param != transferFactories->end(); ++param) {
463  RCP<const FactoryBase> p = BuildFactory(transferFactories->entry(param), factoryMapIn, factoryManagersIn);
464  factory->AddTransferFactory(p);
465  }
466  }
467 
468  return factory;
469  }
470 
471  template <class T> // T must implement the Factory interface
472  RCP<T> BuildTogglePFactory(const Teuchos::ParameterList & paramList, const FactoryMap& factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
473  RCP<T> factory;
474  if (paramList.isSublist("TransferFactories") == false) {
475  //TODO put in an error message: the TogglePFactory needs a TransferFactories sublist!
476  factory = Build2<T>(paramList, factoryMapIn, factoryManagersIn);
477 
478  } else {
479  RCP<Teuchos::ParameterList> paramListNonConst = rcp(new Teuchos::ParameterList(paramList));
480  RCP<const Teuchos::ParameterList> transferFactories = rcp(new Teuchos::ParameterList(*sublist(paramListNonConst, "TransferFactories")));
481 
482  paramListNonConst->remove("TransferFactories");
483 
484  // build TogglePFactory
485  factory = Build2<T>(*paramListNonConst, factoryMapIn, factoryManagersIn);
486 
487  // count how many prolongation factories and how many coarse null space factories have been declared.
488  // the numbers must match!
489  int numProlongatorFactories = 0;
490  int numPtentFactories = 0;
491  int numCoarseNspFactories = 0;
492  for (Teuchos::ParameterList::ConstIterator param = transferFactories->begin(); param != transferFactories->end(); ++param) {
493  size_t foundNsp = transferFactories->name(param).find("Nullspace");
494  if (foundNsp != std::string::npos && foundNsp == 0 && transferFactories->name(param).length()==10) {
495  numCoarseNspFactories++;
496  continue;
497  }
498  size_t foundPtent = transferFactories->name(param).find("Ptent");
499  if (foundPtent != std::string::npos && foundPtent == 0 && transferFactories->name(param).length()==6) {
500  numPtentFactories++;
501  continue;
502  }
503  size_t foundP = transferFactories->name(param).find("P");
504  if (foundP != std::string::npos && foundP == 0 && transferFactories->name(param).length()==2) {
505  numProlongatorFactories++;
506  continue;
507  }
508  }
509  TEUCHOS_TEST_FOR_EXCEPTION(numProlongatorFactories!=numCoarseNspFactories, Exceptions::RuntimeError, "FactoryFactory::BuildToggleP: The user has to provide the same number of prolongator and coarse nullspace factories!");
510  TEUCHOS_TEST_FOR_EXCEPTION(numPtentFactories!=numCoarseNspFactories, Exceptions::RuntimeError, "FactoryFactory::BuildToggleP: The user has to provide the same number of ptent and coarse nullspace factories!");
511  TEUCHOS_TEST_FOR_EXCEPTION(numProlongatorFactories < 2, Exceptions::RuntimeError, "FactoryFactory::BuildToggleP: The TogglePFactory needs at least two different prolongation operators. The factories have to be provided using the names P%i and Nullspace %i, where %i denotes a number between 1 and 9.");
512 
513  // create empty vectors with data
514  std::vector<Teuchos::ParameterEntry> prolongatorFactoryNames(numProlongatorFactories);
515  std::vector<Teuchos::ParameterEntry> coarseNspFactoryNames(numProlongatorFactories);
516  std::vector<Teuchos::ParameterEntry> ptentFactoryNames(numProlongatorFactories);
517 
518  for (Teuchos::ParameterList::ConstIterator param = transferFactories->begin(); param != transferFactories->end(); ++param) {
519  size_t foundNsp = transferFactories->name(param).find("Nullspace");
520  if (foundNsp != std::string::npos && foundNsp == 0 && transferFactories->name(param).length()==10) {
521  int number = atoi(&(transferFactories->name(param).at(9)));
522  TEUCHOS_TEST_FOR_EXCEPTION(number < 1 || number > numProlongatorFactories, Exceptions::RuntimeError, "FactoryFactory::BuildToggleP: Please use the format Nullspace%i with %i an integer between 1 and the maximum number of prolongation operators in TogglePFactory!");
523  coarseNspFactoryNames[number-1] = transferFactories->entry(param);
524  continue;
525  }
526  size_t foundPtent = transferFactories->name(param).find("Ptent");
527  if (foundPtent != std::string::npos && foundPtent == 0 && transferFactories->name(param).length()==6) {
528  int number = atoi(&(transferFactories->name(param).at(5)));
529  TEUCHOS_TEST_FOR_EXCEPTION(number < 1 || number > numPtentFactories, Exceptions::RuntimeError, "FactoryFactory::BuildToggleP: Please use the format Ptent%i with %i an integer between 1 and the maximum number of prolongation operators in TogglePFactory!");
530  ptentFactoryNames[number-1] = transferFactories->entry(param);
531  continue;
532  }
533  size_t foundP = transferFactories->name(param).find("P");
534  if (foundP != std::string::npos && foundP == 0 && transferFactories->name(param).length()==2) {
535  int number = atoi(&(transferFactories->name(param).at(1)));
536  TEUCHOS_TEST_FOR_EXCEPTION(number < 1 || number > numProlongatorFactories, Exceptions::RuntimeError, "FactoryFactory::BuildToggleP: Please use the format P%i with %i an integer between 1 and the maximum number of prolongation operators in TogglePFactory!");
537  prolongatorFactoryNames[number-1] = transferFactories->entry(param);
538  continue;
539  }
540  }
541 
542  // register all prolongation factories in TogglePFactory
543  for (std::vector<Teuchos::ParameterEntry>::const_iterator it = prolongatorFactoryNames.begin(); it != prolongatorFactoryNames.end(); ++it) {
544  RCP<const FactoryBase> p = BuildFactory(*it, factoryMapIn, factoryManagersIn);
545  factory->AddProlongatorFactory(p);
546  }
547 
548  // register all tentative prolongation factories in TogglePFactory
549  for (std::vector<Teuchos::ParameterEntry>::const_iterator it = ptentFactoryNames.begin(); it != ptentFactoryNames.end(); ++it) {
550  RCP<const FactoryBase> p = BuildFactory(*it, factoryMapIn, factoryManagersIn);
551  factory->AddPtentFactory(p);
552  }
553 
554  // register all coarse nullspace factories in TogglePFactory
555  for (std::vector<Teuchos::ParameterEntry>::const_iterator it = coarseNspFactoryNames.begin(); it != coarseNspFactoryNames.end(); ++it) {
556  RCP<const FactoryBase> p = BuildFactory(*it, factoryMapIn, factoryManagersIn);
557  factory->AddCoarseNullspaceFactory(p);
558  }
559  }
560  return factory;
561  }
562 
563  RCP<ToggleCoordinatesTransferFactory> BuildToggleCoordinatesTransferFactory(const Teuchos::ParameterList & paramList, const FactoryMap& factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
564  RCP<ToggleCoordinatesTransferFactory> factory;
565  TEUCHOS_TEST_FOR_EXCEPTION(paramList.isSublist("TransferFactories") == false, Exceptions::RuntimeError, "FactoryFactory::BuildToggleCoordinatesTransferFactory: the ToggleCoordinatesTransferFactory needs a sublist 'TransferFactories' containing information about the subfactories for coordinate transfer!");
566 
567  RCP<Teuchos::ParameterList> paramListNonConst = rcp(new Teuchos::ParameterList(paramList));
568  RCP<const Teuchos::ParameterList> transferFactories = rcp(new Teuchos::ParameterList(*sublist(paramListNonConst, "TransferFactories")));
569  paramListNonConst->remove("TransferFactories");
570 
571  // build CoordinatesTransferFactory
572  factory = Build2<ToggleCoordinatesTransferFactory>(*paramListNonConst, factoryMapIn, factoryManagersIn);
573 
574  // count how many coordinate transfer factories have been declared.
575  // the numbers must match!
576  int numCoordTransferFactories = 0;
577  for (Teuchos::ParameterList::ConstIterator param = transferFactories->begin(); param != transferFactories->end(); ++param) {
578  size_t foundCoordinates = transferFactories->name(param).find("Coordinates");
579  if (foundCoordinates != std::string::npos && foundCoordinates == 0 && transferFactories->name(param).length()==12) {
580  numCoordTransferFactories++;
581  continue;
582  }
583  }
584  TEUCHOS_TEST_FOR_EXCEPTION(numCoordTransferFactories != 2, Exceptions::RuntimeError, "FactoryFactory::BuildToggleCoordinatesTransfer: The ToggleCoordinatesTransferFactory needs two (different) coordinate transfer factories. The factories have to be provided using the names Coordinates%i, where %i denotes a number between 1 and 9.");
585 
586  // create empty vectors with data
587  std::vector<Teuchos::ParameterEntry> coarseCoordsFactoryNames(numCoordTransferFactories);
588 
589  for (Teuchos::ParameterList::ConstIterator param = transferFactories->begin(); param != transferFactories->end(); ++param) {
590  size_t foundCoords = transferFactories->name(param).find("Coordinates");
591  if (foundCoords != std::string::npos && foundCoords == 0 && transferFactories->name(param).length()==12) {
592  int number = atoi(&(transferFactories->name(param).at(11)));
593  TEUCHOS_TEST_FOR_EXCEPTION(number < 1 || number > numCoordTransferFactories, Exceptions::RuntimeError, "FactoryFactory::BuildToggleCoordinatesTransfer: Please use the format Coordinates%i with %i an integer between 1 and the maximum number of coordinate transfer factories in ToggleCoordinatesTransferFactory!");
594  coarseCoordsFactoryNames[number-1] = transferFactories->entry(param);
595  continue;
596  }
597  }
598 
599  // register all coarse nullspace factories in TogglePFactory
600  for (std::vector<Teuchos::ParameterEntry>::const_iterator it = coarseCoordsFactoryNames.begin(); it != coarseCoordsFactoryNames.end(); ++it) {
601  RCP<const FactoryBase> p = BuildFactory(*it, factoryMapIn, factoryManagersIn);
602  factory->AddCoordTransferFactory(p);
603  }
604 
605  return factory;
606  }
607 
609  RCP<FactoryBase> BuildCoupledAggregationFactory(const Teuchos::ParameterList& paramList, const FactoryMap& factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
610  RCP<CoupledAggregationFactory> factory = Build<CoupledAggregationFactory>(paramList, factoryMapIn, factoryManagersIn);
611 
612  if (paramList.isParameter("aggregation: ordering"))
613  factory->SetOrdering(paramList.get<std::string>("aggregation: ordering"));
614 
615  if (paramList.isParameter("aggregation: max selected neighbors"))
616  factory->SetMaxNeighAlreadySelected(paramList.get<int>("aggregation: max selected neighbors"));
617 
618  if (paramList.isParameter("Phase3AggCreation"))
619  factory->SetPhase3AggCreation(paramList.get<double>("Phase3AggCreation"));
620 
621  if(paramList.isParameter("aggregation: min agg size"))
622  factory->SetMinNodesPerAggregate(paramList.get<int>("aggregation: min agg size"));
623 
624  return factory;
625  }
626 
628  // Parameter List Parsing:
629  // <ParameterList name="smootherFact1">
630  // <Parameter name="factory" type="string" value="TrilinosSmoother"/>
631  // <Parameter name="verbose" type="string" value="Warnings"/>
632  // <Parameter name="type" type="string" value="RELAXATION"/>
633  // <ParameterList name="ParameterList">
634  // ...
635  // </ParameterList>
636  // </ParameterList>
637  RCP<FactoryBase> BuildTrilinosSmoother(const Teuchos::ParameterList & paramList, const FactoryMap & factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
638  if (paramList.begin() == paramList.end())
639  return rcp(new SmootherFactory(rcp(new TrilinosSmoother())));
640 
641  TEUCHOS_TEST_FOR_EXCEPTION(paramList.get<std::string>("factory") != "TrilinosSmoother", Exceptions::RuntimeError, "");
642 
643  // Is it true? TEUCHOS_TEST_FOR_EXCEPTION(!paramList.isParameter("type"), Exceptions::RuntimeError, "TrilinosSmoother: parameter 'type' is mandatory");
644  // type="" is default in TrilinosSmoother, but what happen then?
645 
646  std::string type=""; if(paramList.isParameter("type")) type = paramList.get<std::string>("type");
647  int overlap=0; if(paramList.isParameter("overlap")) overlap = paramList.get<int> ("overlap");
648  // std::string verbose; if(paramList.isParameter("verbose")) verbose = paramList.get<std::string>("verbose");
649  Teuchos::ParameterList params; if(paramList.isParameter("ParameterList")) params = paramList.get<Teuchos::ParameterList>("ParameterList");
650 
651  // parameters from SmootherFactory
652  //bool bKeepSmootherData = false; if(paramList.isParameter("keep smoother data")) bKeepSmootherData = paramList.get<bool>("keep smoother data");
653 
654  // Read in factory information for smoothers (if available...)
655  // NOTE: only a selected number of factories can be used with the Trilinos smoother
656  // smoothers usually work with the global data available (which is A and the transfers P and R)
657 
658  Teuchos::RCP<TrilinosSmoother> trilSmoo = Teuchos::rcp(new TrilinosSmoother(type, params, overlap));
659 
660  if (paramList.isParameter("LineDetection_Layers")) {
661  RCP<const FactoryBase> generatingFact = BuildFactory(paramList.getEntry("LineDetection_Layers"), factoryMapIn, factoryManagersIn);
662  trilSmoo->SetFactory("LineDetection_Layers", generatingFact);
663  }
664  if (paramList.isParameter("LineDetection_VertLineIds")) {
665  RCP<const FactoryBase> generatingFact = BuildFactory(paramList.getEntry("LineDetection_Layers"), factoryMapIn, factoryManagersIn);
666  trilSmoo->SetFactory("LineDetection_Layers", generatingFact);
667  }
668  if (paramList.isParameter("CoarseNumZLayers")) {
669  RCP<const FactoryBase> generatingFact = BuildFactory(paramList.getEntry("CoarseNumZLayers"), factoryMapIn, factoryManagersIn);
670  trilSmoo->SetFactory("CoarseNumZLayers", generatingFact);
671  }
672 
673  RCP<SmootherFactory> smooFact = rcp(new SmootherFactory(Teuchos::null));
674  Teuchos::ParameterList smooFactParams;
675  //smooFactParams.setEntry("keep smoother data", paramList.getEntry("keep smoother data"));
676  smooFact->SetParameterList(smooFactParams);
677  smooFact->SetSmootherPrototypes(trilSmoo);
678  return smooFact;
679  }
680 
681 #ifdef HAVE_MUELU_MATLAB
682  // Parameter List Parsing:
684  // <ParameterList name="smootherFact1">
685  // <Parameter name="factory" type="string" value="MatlabSmoother"/>
686  // <Parameter name="Setup Function" type="string" value="mySmootherSetup.m"/>
687  // <Parameter name="Solve Function" type="string" value="mySmootherSolve.m"/>
688  // <!--A is implicitly included in this list and nothing else is needed to get diagonal-->
689  // <Parameter name="Needs" type="string" value=""/>
690  // <!--A,x,b are also assumed inputs to the solver: only one additional arg then (diag)-->
691  // <Parameter name="Number of Solver Args" type="int" value="1"/>
692  // </ParameterList>
693  RCP<FactoryBase> BuildMatlabSmoother(const Teuchos::ParameterList & paramList, const FactoryMap & factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
694  if (paramList.begin() == paramList.end())
695  return rcp(new SmootherFactory(rcp(new MatlabSmoother())));
696 
697  TEUCHOS_TEST_FOR_EXCEPTION(paramList.get<std::string>("factory") != "MatlabSmoother", Exceptions::RuntimeError, "");
698 
699  // Read in factory information for smoothers (if available...)
700  // NOTE: only a selected number of factories can be used with the Trilinos smoother
701  // smoothers usually work with the global data available (which is A and the transfers P and R)
702 
703  Teuchos::RCP<MatlabSmoother> matSmoo = Teuchos::rcp(new MatlabSmoother(paramList));
704 
705  return rcp(new SmootherFactory(matSmoo));
706  }
707 #endif
708 
709  RCP<FactoryBase> BuildDirectSolver(const Teuchos::ParameterList& paramList, const FactoryMap& /* factoryMapIn */, const FactoryManagerMap& /* factoryManagersIn */) const {
710  if (paramList.begin() == paramList.end())
711  return rcp(new SmootherFactory(rcp(new DirectSolver()), Teuchos::null));
712 
713  TEUCHOS_TEST_FOR_EXCEPTION(paramList.get<std::string>("factory") != "DirectSolver", Exceptions::RuntimeError, "");
714 
715  std::string type; if(paramList.isParameter("type")) type = paramList.get<std::string>("type");
716  // std::string verbose; if(paramList.isParameter("verbose")) verbose = paramList.get<std::string>("verbose");
717  Teuchos::ParameterList params; if(paramList.isParameter("ParameterList")) params = paramList.get<Teuchos::ParameterList>("ParameterList");
718 
719  return rcp(new SmootherFactory(rcp(new DirectSolver(type, params)), Teuchos::null));
720  }
721 
722  template <class T> // T must implement the Factory interface
723  RCP<FactoryBase> BuildBlockedSmoother(const Teuchos::ParameterList& paramList, const FactoryMap& factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
724  // read in sub lists
725  RCP<ParameterList> paramListNonConst = rcp(new ParameterList(paramList));
726 
727  // internal vector of factory managers
728  std::vector<RCP<FactoryManager> > facManagers;
729 
730  // loop over all "block%i" sublists in parameter list
731  int blockid = 1;
732  bool blockExists = true;
733  while (blockExists == true) {
734  std::stringstream ss;
735  ss << "block" << blockid;
736 
737  if(paramList.isSublist(ss.str()) == true) {
738  // we either have a parameter group or we have a list of factories in here
739  RCP<const ParameterList> b = rcp(new ParameterList(*sublist(paramListNonConst, ss.str())));
740 
741  RCP<FactoryManager> M = Teuchos::null;
742 
743  if (b->isParameter("group")) {
744  // use a factory manager
745  std::string facManagerName = b->get< std::string >("group");
746  TEUCHOS_TEST_FOR_EXCEPTION(factoryManagersIn.count(facManagerName) != 1, Exceptions::RuntimeError, "Factory manager has not been found. Please check the spelling of the factory managers in your xml file.");
747  RCP<FactoryManagerBase> Mb = factoryManagersIn.find(facManagerName)->second;
748  M = Teuchos::rcp_dynamic_cast<FactoryManager>(Mb);
749  TEUCHOS_TEST_FOR_EXCEPTION(M==Teuchos::null, Exceptions::RuntimeError, "Failed to cast FactoryManagerBase object to FactoryManager.");
750  } else {
751  // read in the list of factories
752  M = rcp(new FactoryManager());
753  for (ParameterList::ConstIterator param = b->begin(); param != b->end(); ++param) {
754  RCP<const FactoryBase> p = BuildFactory(b->entry(param), factoryMapIn, factoryManagersIn);
755  M->SetFactory(b->name(param),p);
756  }
757  }
758 
759  // add factory manager to internal vector of factory managers
760  M->SetIgnoreUserData(true);
761  facManagers.push_back(M);
762  paramListNonConst->remove(ss.str());
763  blockid++;
764  } else {
765  blockExists = false;
766  break;
767  }
768 
769  }
770 
771  // create a new blocked smoother
772  RCP<T> bs = Build2<T>(*paramListNonConst, factoryMapIn, factoryManagersIn);
773 
774  // important: set block factory for A here!
775  // TAW: 7/6/2016: We should not need to set/hardcode the blocked operator here.
776  // The user might want to overwrite this in the xml file, so just
777  // use what is declared as "A"
778  //bs->SetFactory("A", MueLu::NoFactory::getRCP());
779 
780  for (int i = 0; i<Teuchos::as<int>(facManagers.size()); i++) {
781  bs->AddFactoryManager(facManagers[i],i);
782  }
783 
784  return rcp(new SmootherFactory(bs));
785  }
786 
787 #ifdef HAVE_MUELU_TEKO
788  RCP<FactoryBase> BuildTekoSmoother(const Teuchos::ParameterList& paramList, const FactoryMap& factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
789  // read in sub lists
790  RCP<ParameterList> paramListNonConst = rcp(new ParameterList(paramList));
791  RCP<ParameterList> tekoParams = rcp(new ParameterList(paramListNonConst->sublist("Inverse Factory Library")));
792  paramListNonConst->remove("Inverse Factory Library");
793 
794  // create a new blocked smoother
795  RCP<TekoSmoother> bs = Build2<TekoSmoother>(*paramListNonConst, factoryMapIn, factoryManagersIn);
796 
797  // important: set block factory for A here!
798  // TAW: 7/6/2016: We should not need to set/hardcode the blocked operator here.
799  // The user might want to overwrite this in the xml file, so just
800  // use what is declared as "A"
801  //bs->SetFactory("A", MueLu::NoFactory::getRCP());
802 
803  // Set Teko parameters ("Inverse Factory Library")
804  bs->SetTekoParameters(tekoParams);
805 
806  return rcp(new SmootherFactory(bs));
807  }
808 #endif
809 
810  RCP<FactoryBase> BuildBlockedDirectSolver(const Teuchos::ParameterList& /* paramList */, const FactoryMap& /* factoryMapIn */, const FactoryManagerMap& /* factoryManagersIn */) const {
811  //if (paramList.begin() == paramList.end())
812  return rcp(new SmootherFactory(rcp(new BlockedDirectSolver())));
813 
814  /*TEUCHOS_TEST_FOR_EXCEPTION(paramList.get<std::string>("factory") != "DirectSolver", Exceptions::RuntimeError, "");
815 
816  std::string type; if(paramList.isParameter("type")) type = paramList.get<std::string>("type");
817  // std::string verbose; if(paramList.isParameter("verbose")) verbose = paramList.get<std::string>("verbose");
818  Teuchos::ParameterList params; if(paramList.isParameter("ParameterList")) params = paramList.get<Teuchos::ParameterList>("ParameterList");
819 
820  return rcp(new SmootherFactory(rcp(new DirectSolver(type, params))));*/
821  }
822 
823  //RCP<FactoryBase> BuildBlockedPFactory(const Teuchos::ParameterList& paramList, const FactoryMap& factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
824  // RCP<BlockedPFactory> pfac = rcp(new BlockedPFactory());
825 
826  template <class T> // T must implement the Factory interface
827  RCP<T> BuildBlockedFactory(const Teuchos::ParameterList & paramList, const FactoryMap& factoryMapIn, const FactoryManagerMap& factoryManagersIn) const {
828  RCP<T> pfac = Teuchos::null;
829 
830  // read in sub lists
831  RCP<ParameterList> paramListNonConst = rcp(new ParameterList(paramList));
832 
833  // internal vector of factory managers
834  std::vector<RCP<FactoryManager> > facManagers;
835 
836  // loop over all "block%i" sublists in parameter list
837  int blockid = 1;
838  bool blockExists = true;
839  while (blockExists == true) {
840  std::stringstream ss;
841  ss << "block" << blockid;
842 
843  if(paramList.isSublist(ss.str()) == true) {
844  // we either have a parameter group or we have a list of factories in here
845  RCP<const ParameterList> b = rcp(new ParameterList(*sublist(paramListNonConst, ss.str())));
846 
847  RCP<FactoryManager> M = Teuchos::null;
848 
849  if (b->isParameter("group")) {
850  // use a factory manager
851  std::string facManagerName = b->get< std::string >("group");
852  TEUCHOS_TEST_FOR_EXCEPTION(factoryManagersIn.count(facManagerName) != 1, Exceptions::RuntimeError, "Factory manager has not been found. Please check the spelling of the factory managers in your xml file.");
853  RCP<FactoryManagerBase> Mb = factoryManagersIn.find(facManagerName)->second;
854  M = Teuchos::rcp_dynamic_cast<FactoryManager>(Mb);
855  TEUCHOS_TEST_FOR_EXCEPTION(M==Teuchos::null, Exceptions::RuntimeError, "Failed to cast FactoryManagerBase object to FactoryManager.");
856  } else {
857  // read in the list of factories
858  M = rcp(new FactoryManager());
859  for (ParameterList::ConstIterator param = b->begin(); param != b->end(); ++param) {
860  RCP<const FactoryBase> p = BuildFactory(b->entry(param), factoryMapIn, factoryManagersIn);
861  M->SetFactory(b->name(param),p);
862  }
863  }
864 
865  // add factory manager to internal vector of factory managers
866  M->SetIgnoreUserData(true);
867  facManagers.push_back(M);
868  paramListNonConst->remove(ss.str());
869  blockid++;
870  } else {
871  blockExists = false;
872  break;
873  }
874 
875  }
876 
877  // build BlockedPFactory (without sub block information)
878  pfac = Build2<T>(*paramListNonConst, factoryMapIn, factoryManagersIn);
879 
880  // add FactoryManager objects
881  for(size_t i = 0; i<facManagers.size(); i++) {
882  pfac->AddFactoryManager(facManagers[i]); // add factory manager
883  }
884 
885  return pfac;
886  }
887  }; // class
888 } // namespace MueLu
889 
890 #define MUELU_FACTORYFACTORY_SHORT
891 #endif // MUELU_FACTORYFACTORY_DECL_HPP
892 
893  // TODO: handle factory parameters
894  // TODO: parameter validator
895  // TODO: static
896  // TODO: default parameters should not be duplicated here and on the Factory (ex: default for overlap (=0) is defined both here and on TrilinosSmoother constructors)
MueLu::SmootherFactory
Generic Smoother Factory for generating the smoothers of the MG hierarchy.
Definition: MueLu_SmootherFactory_decl.hpp:91
MueLu::FactoryFactory::BuildDirectSolver
RCP< FactoryBase > BuildDirectSolver(const Teuchos::ParameterList &paramList, const FactoryMap &, const FactoryManagerMap &) const
Definition: MueLu_FactoryFactory_decl.hpp:709
Teuchos_ParameterEntry.hpp
Teuchos::ParameterList::name
const std::string & name() const
MueLu::FactoryManager
This class specifies the default factory that should generate some data on a Level if the data does n...
Definition: MueLu_FactoryManager_decl.hpp:103
MueLu::FactoryFactory::Build
RCP< T > Build(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
Definition: MueLu_FactoryFactory_decl.hpp:395
MueLu_FactoryManagerBase_fwd.hpp
Teuchos::ParameterList::end
ConstIterator end() const
MueLu::FactoryFactory::BuildTekoSmoother
RCP< FactoryBase > BuildTekoSmoother(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
Definition: MueLu_FactoryFactory_decl.hpp:788
MueLu::FactoryFactory
Factory that can generate other factories from.
Definition: MueLu_FactoryFactory_decl.hpp:183
MueLu_FactoryBase.hpp
Teuchos::ParameterList::get
T & get(const std::string &name, T def_value)
MueLu::FactoryFactory::Build2
RCP< T > Build2(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
Definition: MueLu_FactoryFactory_decl.hpp:408
MueLu::TrilinosSmoother
Class that encapsulates external library smoothers.
Definition: MueLu_TrilinosSmoother_decl.hpp:83
MueLu_Exceptions.hpp
Teuchos::ParameterList::set
ParameterList & set(std::string const &name, T const &value, std::string const &docString="", RCP< const ParameterEntryValidator > const &validator=null)
TEUCHOS_TEST_FOR_EXCEPTION
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
MueLu::FactoryFactory::BuildToggleCoordinatesTransferFactory
RCP< ToggleCoordinatesTransferFactory > BuildToggleCoordinatesTransferFactory(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
Definition: MueLu_FactoryFactory_decl.hpp:563
MueLu_UseShortNames.hpp
MueLu::FactoryFactory::BuildBlockedSmoother
RCP< FactoryBase > BuildBlockedSmoother(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
Definition: MueLu_FactoryFactory_decl.hpp:723
Teuchos::RCP::get
T * get() const
MueLu::FactoryFactory::BuildMatlabSmoother
RCP< FactoryBase > BuildMatlabSmoother(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
MatlabSmoother.
Definition: MueLu_FactoryFactory_decl.hpp:693
MueLu_FactoryFactory_fwd.hpp
MueLu::FactoryFactory::BuildFactory
virtual RCP< const FactoryBase > BuildFactory(const Teuchos::ParameterEntry &param, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
: Interpret Factory parameter list and build new factory
Definition: MueLu_FactoryFactory_decl.hpp:209
MueLu_ConfigDefs.hpp
MueLu::DirectSolver
Class that encapsulates direct solvers. Autoselection of AmesosSmoother or Amesos2Smoother according ...
Definition: MueLu_DirectSolver_decl.hpp:78
arraysize
#define arraysize(ar)
Definition: MueLu_FactoryFactory_decl.hpp:392
MueLu::FactoryFactory::BuildTogglePFactory
RCP< T > BuildTogglePFactory(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
Definition: MueLu_FactoryFactory_decl.hpp:472
Teuchos::ParameterList::setEntry
ParameterList & setEntry(const std::string &name, const ParameterEntry &entry)
Teuchos::ParameterList::isParameter
bool isParameter(const std::string &name) const
MueLu::FactoryFactory::FactoryManagerMap
std::map< std::string, RCP< FactoryManagerBase > > FactoryManagerMap
Definition: MueLu_FactoryFactory_decl.hpp:188
Teuchos::ParameterList::remove
bool remove(std::string const &name, bool throwIfNotExists=true)
rcp
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
MueLu::FactoryFactory::FactoryMap
std::map< std::string, RCP< const FactoryBase > > FactoryMap
Definition: MueLu_FactoryFactory_decl.hpp:187
Teuchos::ParameterList::isSublist
bool isSublist(const std::string &name) const
MueLu::FactoryFactory::BuildBlockedFactory
RCP< T > BuildBlockedFactory(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
Definition: MueLu_FactoryFactory_decl.hpp:827
Teuchos::ParameterList::ConstIterator
params_t::ConstIterator ConstIterator
MueLu::FactoryFactory::BuildBlockedDirectSolver
RCP< FactoryBase > BuildBlockedDirectSolver(const Teuchos::ParameterList &, const FactoryMap &, const FactoryManagerMap &) const
Definition: MueLu_FactoryFactory_decl.hpp:810
MueLu_FactoryBase_fwd.hpp
Teuchos::ParameterList::begin
ConstIterator begin() const
MueLu::FactoryFactory::BuildTrilinosSmoother
RCP< FactoryBase > BuildTrilinosSmoother(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
TrilinosSmoother.
Definition: MueLu_FactoryFactory_decl.hpp:637
MueLu::FactoryFactory::BuildRAPFactory
RCP< T > BuildRAPFactory(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
Definition: MueLu_FactoryFactory_decl.hpp:449
MueLu::BlockedDirectSolver
direct solver for nxn blocked matrices
Definition: MueLu_BlockedDirectSolver_decl.hpp:85
Teuchos::ParameterList::entry
const ParameterEntry & entry(ConstIterator i) const
MueLu_Hierarchy_fwd.hpp
Teuchos_Array.hpp
MueLu::BaseClass
Base class for MueLu classes.
Definition: MueLu_BaseClass.hpp:61
MueLu_HierarchyFactory.hpp
MueLu::MatlabSmoother
Class that encapsulates Matlab smoothers.
Definition: MueLu_MatlabSmoother_fwd.hpp:51
TEUCHOS_UNREACHABLE_RETURN
#define TEUCHOS_UNREACHABLE_RETURN(dummyReturnVal)
MueLu_Monitor.hpp
MueLu::Exceptions::RuntimeError
Exception throws to report errors in the internal logical of the program.
Definition: MueLu_Exceptions.hpp:70
Teuchos::ParameterList::getEntry
ParameterEntry & getEntry(const std::string &name)
MueLu::FactoryFactory::BuildCoupledAggregationFactory
RCP< FactoryBase > BuildCoupledAggregationFactory(const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
CoupledAggregationFactory.
Definition: MueLu_FactoryFactory_decl.hpp:609
MueLu_FactoryManager_fwd.hpp
MueLu::NoFactory::getRCP
static const RCP< const NoFactory > getRCP()
Static Get() functions.
Definition: MueLu_NoFactory.hpp:90