MueLu  Version of the Day
MueLu_IfpackSmoother.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_IFPACKSMOOTHER_HPP
47 #define MUELU_IFPACKSMOOTHER_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 #if defined(HAVE_MUELU_EPETRA) && defined(HAVE_MUELU_IFPACK)
51 
52 #include <Teuchos_ParameterList.hpp>
53 #include <Xpetra_Matrix.hpp>
54 #include <Xpetra_MultiVectorFactory_fwd.hpp>
55 
57 
58 #include "MueLu_SmootherPrototype.hpp"
59 #include "MueLu_Exceptions.hpp"
60 
61 #include "MueLu_Level_fwd.hpp"
63 #include "MueLu_Utilities_fwd.hpp"
64 #include "MueLu_Aggregates_fwd.hpp"
65 
66 namespace MueLu {
67 
76  template <class Node = typename SmootherPrototype<double,int,int>::node_type>
77  class IfpackSmoother : public MueLu::SmootherPrototype<double,int,int,Node> {
78  typedef double Scalar;
79  typedef int LocalOrdinal;
80  typedef int GlobalOrdinal;
81 #undef MUELU_IFPACKSMOOTHER_SHORT
82 #include "MueLu_UseShortNames.hpp"
83 
84  public:
85 
87 
88 
123  IfpackSmoother(std::string const & type, Teuchos::ParameterList const & paramList = Teuchos::ParameterList(), LO const &overlap=0); //TODO: empty paramList valid for Ifpack??
124 
126  virtual ~IfpackSmoother() { }
127 
129 
130  void SetParameterList(const Teuchos::ParameterList& paramList);
131 
133 
134 
135  void DeclareInput(Level &currentLevel) const;
136 
138 
140 
141 
147  void Setup(Level &currentLevel);
148 
157  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
158 
160 
162 
163 
164  RCP<SmootherPrototype> Copy() const;
165 
167 
169 
170 
172  std::string description() const;
173 
175  //using MueLu::Describable::describe; // overloading, not hiding
176  //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const
177  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
178 
180  size_t getNodeSmootherComplexity() const;
181 
183 
184  private:
185  void SetPrecParameters(const Teuchos::ParameterList& list = Teuchos::ParameterList()) const;
186 
187  void SetupAggregate(Level& currentLevel);
188 
189  private:
190 
192  std::string type_;
193 
196 
198  RCP<Matrix> A_;
199 
201  // Note: prec_ must be destroyed before A_, so declaration of prec_ appears after declaration of A_
202  RCP<Ifpack_Preconditioner> prec_;
203 
204  }; // class IfpackSmoother
205 
208  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
209  RCP<MueLu::SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
210  GetIfpackSmoother (const std::string& /* type */ = "",
211  const Teuchos::ParameterList& /* paramList */ = Teuchos::ParameterList (),
212  const LocalOrdinal& /* overlap */ = 0)
213  {
214  TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError, "IfpackSmoother cannot be used with Scalar != double, LocalOrdinal != int, GlobalOrdinal != int");
215  TEUCHOS_UNREACHABLE_RETURN(Teuchos::null);
216  }
217 
218  // Specialization for serial node (used for Epetra)
219 #if defined(HAVE_MUELU_EPETRA)
220  template <>
221  inline RCP<MueLu::SmootherPrototype<double, int, int, Xpetra::EpetraNode> >
222  GetIfpackSmoother<double, int, int, Xpetra::EpetraNode> (const std::string& type, const Teuchos::ParameterList& paramList, const int& overlap) {
223  return rcp(new MueLu::IfpackSmoother<Xpetra::EpetraNode>(type, paramList, overlap));
224  }
225 #endif
226 
227 } // namespace MueLu
228 
229 #define MUELU_IFPACKSMOOTHER_SHORT
230 #endif // HAVE_MUELU_EPETRA && HAVE_MUELU_IFPACK
231 #endif // MUELU_IFPACKSMOOTHER_HPP
void Setup(Level &currentLevel)
Set up the smoother.
MueLu::DefaultLocalOrdinal LocalOrdinal
void SetPrecParameters(const Teuchos::ParameterList &list=Teuchos::ParameterList()) const
virtual ~IfpackSmoother()
Destructor.
Base class for smoother prototypes.
RCP< SmootherPrototype > Copy() const
Namespace for MueLu classes and methods.
IfpackSmoother(std::string const &type, Teuchos::ParameterList const &paramList=Teuchos::ParameterList(), LO const &overlap=0)
Constructor.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
RCP< MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > > GetIfpackSmoother(const std::string &="", const Teuchos::ParameterList &=Teuchos::ParameterList(), const LocalOrdinal &=0)
RCP< Ifpack_Preconditioner > prec_
pointer to Ifpack solver object
std::string type_
ifpack-specific key phrase that denote smoother type
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
LO overlap_
overlap when using the smoother in additive Schwarz mode
RCP< Matrix > A_
Matrix. Not used directly, but held inside of prec_. So we have to keep an RCP pointer to it! ...
void DeclareInput(Level &currentLevel) const
Input.
void SetParameterList(const Teuchos::ParameterList &paramList)
Set parameters from a parameter list and return with default values.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
void SetupAggregate(Level &currentLevel)
std::string description() const
Return a simple one-line description of this object.
Exception throws to report errors in the internal logical of the program.
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the preconditioner.
Class that encapsulates Ifpack smoothers.