MueLu  Version of the Day
Stratimikos_MueLuHelpers.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 // Tobias Wiesner (tawiesn@sandia.gov)
43 //
44 // ***********************************************************************
45 //
46 // @HEADER
47 #ifndef STRATIMIKOS_MUELU_TPETRA_HELPERS_HPP
48 #define STRATIMIKOS_MUELU_TPETRA_HELPERS_HPP
49 
50 #include "Stratimikos_DefaultLinearSolverBuilder.hpp"
51 
53 
54 #if defined(HAVE_MUELU_EXPERIMENTAL) && defined(HAVE_MUELU_TEKO)
56 #endif
57 
58 #include "Teuchos_RCP.hpp"
59 #include "Teuchos_ParameterList.hpp"
60 #include "Teuchos_TestForException.hpp"
61 #include "Teuchos_AbstractFactoryStd.hpp"
62 
63 #include <string>
64 
65 namespace Stratimikos {
66 
67  // Dynamically register MueLu Tpetra adapters in Stratimikos
68  void enableMueLu(DefaultLinearSolverBuilder& builder, const std::string& stratName = "MueLu");
69 
70  // Dynamically register MueLu Tpetra adapters in Stratimikos
71  // Note: No Scalar template argument is available because Stratimikos
72  // does not support types beyond double
73  template <typename LocalOrdinal, typename GlobalOrdinal, typename Node>
74  void enableMueLu(DefaultLinearSolverBuilder& builder, const std::string& stratName = "MueLu")
75  {
76  const Teuchos::RCP<const Teuchos::ParameterList> precValidParams = Teuchos::sublist(builder.getValidParameters(), "Preconditioner Types");
77 
78  TEUCHOS_TEST_FOR_EXCEPTION(precValidParams->isParameter(stratName), std::logic_error,
79  "Stratimikos::enableMueLu cannot add \"" + stratName +"\" because it is already included in builder!");
80 
81  typedef Thyra::PreconditionerFactoryBase<double> Base;
83 
84  builder.setPreconditioningStrategyFactory(Teuchos::abstractFactoryStd<Base, Impl>(), stratName);
85  }
86 
87 #if defined(HAVE_MUELU_EXPERIMENTAL) && defined(HAVE_MUELU_TEKO)
88 #if 0
89  // Dynamically register MueLu Tpetra adapters in Stratimikos
90  void enableMueLuTpetraQ2Q1(DefaultLinearSolverBuilder &builder, const std::string &stratName = "MueLu");
91 #endif
92 
93  // Dynamically register MueLu Tpetra adapters in Stratimikos
94  // Note: No Scalar template argument is available because Stratimikos
95  // does not support types beyond double
96  template <typename LocalOrdinal, typename GlobalOrdinal, typename Node>
97  void enableMueLuTpetraQ2Q1(DefaultLinearSolverBuilder& builder, const std::string &stratName = "MueLu") {
98  const Teuchos::RCP<const Teuchos::ParameterList> precValidParams = Teuchos::sublist(builder.getValidParameters(), "Preconditioner Types");
99 
100  TEUCHOS_TEST_FOR_EXCEPTION(precValidParams->isParameter(stratName), std::logic_error,
101  "Stratimikos::enableMueLuTpetraQ2Q1 cannot add \"" + stratName +"\" because it is already included in builder!");
102 
103  typedef Thyra::PreconditionerFactoryBase<double> Base;
105 
106  builder.setPreconditioningStrategyFactory(Teuchos::abstractFactoryStd<Base, Impl>(), stratName);
107  }
108 #endif
109 
110 } // namespace Stratimikos
111 
112 #endif
void enableMueLuTpetraQ2Q1(DefaultLinearSolverBuilder &builder, const std::string &stratName="MueLu")
Concrete preconditioner factory subclass based on MueLu.
Concrete preconditioner factory subclass for Thyra based on MueLu.Add support for MueLu preconditione...
void enableMueLu(DefaultLinearSolverBuilder &builder, const std::string &stratName)