MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
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 
65 namespace MueLu {
66 
75  template <class Node = typename SmootherPrototype<double,int,int>::node_type>
76  class IfpackSmoother : public MueLu::SmootherPrototype<double,int,int,Node> {
77  typedef double Scalar;
78  typedef int LocalOrdinal;
79  typedef int GlobalOrdinal;
80 #undef MUELU_IFPACKSMOOTHER_SHORT
81 #include "MueLu_UseShortNames.hpp"
82 
83  public:
84 
86 
87 
122  IfpackSmoother(std::string const & type, Teuchos::ParameterList const & paramList = Teuchos::ParameterList(), LO const &overlap=0); //TODO: empty paramList valid for Ifpack??
123 
125  virtual ~IfpackSmoother() { }
126 
128 
129  void SetParameterList(const Teuchos::ParameterList& paramList);
130 
132 
133 
134  void DeclareInput(Level &currentLevel) const;
135 
137 
139 
140 
146  void Setup(Level &currentLevel);
147 
156  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
157 
159 
161 
162 
164 
166 
168 
169 
171  std::string description() const;
172 
174  //using MueLu::Describable::describe; // overloading, not hiding
175  //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const
176  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
177 
179  size_t getNodeSmootherComplexity() const;
180 
182 
183  private:
185 
186  private:
187 
189  std::string type_;
190 
193 
196 
198  // Note: prec_ must be destroyed before A_, so declaration of prec_ appears after declaration of A_
200 
201  }; // class IfpackSmoother
202 
205  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
207  GetIfpackSmoother (const std::string& /* type */ = "",
208  const Teuchos::ParameterList& /* paramList */ = Teuchos::ParameterList (),
209  const LocalOrdinal& /* overlap */ = 0)
210  {
211  TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError, "IfpackSmoother cannot be used with Scalar != double, LocalOrdinal != int, GlobalOrdinal != int");
212  TEUCHOS_UNREACHABLE_RETURN(Teuchos::null);
213  }
214 
215  // Specialization for serial node (used for Epetra)
216 #if defined(HAVE_MUELU_EPETRA)
217  template <>
218  inline RCP<MueLu::SmootherPrototype<double, int, int, Xpetra::EpetraNode> >
219  GetIfpackSmoother<double, int, int, Xpetra::EpetraNode> (const std::string& type, const Teuchos::ParameterList& paramList, const int& overlap) {
220  return rcp(new MueLu::IfpackSmoother<Xpetra::EpetraNode>(type, paramList, overlap));
221  }
222 #endif
223 
224 } // namespace MueLu
225 
226 #define MUELU_IFPACKSMOOTHER_SHORT
227 #endif // HAVE_MUELU_EPETRA && HAVE_MUELU_IFPACK
228 #endif // MUELU_IFPACKSMOOTHER_HPP
void Setup(Level &currentLevel)
Set up the smoother.
RCP< SmootherPrototype > Copy() const
MueLu::DefaultLocalOrdinal LocalOrdinal
void SetPrecParameters(const Teuchos::ParameterList &list=Teuchos::ParameterList()) const
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
virtual ~IfpackSmoother()
Destructor.
Base class for smoother prototypes.
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)
void DeclareInput(Level &currentLevel) const
Input.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
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
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
RCP< Matrix > A_
Matrix. Not used directly, but held inside of prec_. So we have to keep an RCP pointer to it! ...
void SetParameterList(const Teuchos::ParameterList &paramList)
Set parameters from a parameter list and return with default values.
#define TEUCHOS_UNREACHABLE_RETURN(dummyReturnVal)
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.