MueLu  Version of the Day
MueLu_Ifpack2Smoother_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_IFPACK2SMOOTHER_DECL_HPP
47 #define MUELU_IFPACK2SMOOTHER_DECL_HPP
48 
49 #include <Teuchos_ParameterList.hpp>
50 
51 #include <Xpetra_BlockedCrsMatrix_fwd.hpp>
52 #include <Xpetra_CrsMatrixWrap.hpp>
53 #include <Xpetra_Matrix_fwd.hpp>
54 #include <Xpetra_Matrix.hpp>
55 #include <Xpetra_MultiVectorFactory_fwd.hpp>
56 #ifdef HAVE_XPETRA_TPETRA // needed for clone()
57 #include <Xpetra_TpetraCrsMatrix.hpp>
58 #endif
59 
60 #include "MueLu_ConfigDefs.hpp"
62 
63 #if defined(HAVE_MUELU_TPETRA) && defined(HAVE_MUELU_IFPACK2)
64 
65 #include <Tpetra_CrsMatrix.hpp>
66 
67 #include <Ifpack2_Factory_decl.hpp>
68 #include <Ifpack2_Factory_def.hpp>
69 #include <Ifpack2_Preconditioner.hpp>
70 
73 #include "MueLu_Level_fwd.hpp"
74 #include "MueLu_SmootherPrototype.hpp"
75 #include "MueLu_Utilities_fwd.hpp"
76 
77 namespace MueLu {
78 
89  template <class Scalar = SmootherPrototype<>::scalar_type,
90  class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type,
93  class Ifpack2Smoother : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
94 #undef MUELU_IFPACK2SMOOTHER_SHORT
95 #include "MueLu_UseShortNames.hpp"
96 
97  public:
98 
100 
101  //TODO: update doc for Ifpack2. Right now, it's a copy of the doc of IfpackSmoother
137 #ifndef _MSC_VER
138  // Avoid error C3772: invalid friend template declaration
139  template<class Scalar2, class LocalOrdinal2, class GlobalOrdinal2, class Node2>
140  friend class Ifpack2Smoother;
141 #endif
142 
143  Ifpack2Smoother(const std::string& type, const Teuchos::ParameterList& paramList = Teuchos::ParameterList(), const LO& overlap = 0); //TODO: empty paramList valid for Ifpack??
144 
146  virtual ~Ifpack2Smoother() { }
147 
149 
150  void SetParameterList(const Teuchos::ParameterList& paramList);
151 
153 
154 
155  void DeclareInput(Level &currentLevel) const;
156 
158 
160 
161 
169  void Setup(Level &currentLevel);
170 
179  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
180 
182 
184 
185 
186  RCP<SmootherPrototype> Copy() const;
187 
189 
191  template<typename Node2>
192  RCP<MueLu::Ifpack2Smoother<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >
193  clone(const RCP<Node2>& node2, const Teuchos::RCP<const Xpetra::Matrix<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >& A_newnode) const;
194 
196 
197 
199  std::string description() const;
200 
202  //using MueLu::Describable::describe; // overloading, not hiding
203  //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const
204  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
205 
207 
209  RCP<Ifpack2::Preconditioner<Scalar,LocalOrdinal,GlobalOrdinal,Node> > getPreconditioner(){return prec_;}
210 
212  size_t getNodeSmootherComplexity() const;
213 
214  private:
215  void SetPrecParameters(const Teuchos::ParameterList& list = Teuchos::ParameterList()) const;
216 
217  void SetupSchwarz (Level& currentLevel);
218  void SetupChebyshev (Level& currentLevel);
219  void SetupLineSmoothing (Level& currentLevel);
220  void SetupBlockRelaxation (Level& currentLevel);
221  void SetupTopological (Level& currentLevel);
222  void SetupGeneric (Level& currentLevel);
223 
224  private:
225 
227  std::string type_;
228 
231 
233  RCP<Ifpack2::Preconditioner<Scalar,LocalOrdinal,GlobalOrdinal,Node> > prec_;
234 
236  RCP<Matrix> A_;
237 
238  }; // class Ifpack2Smoother
239 
240  template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
241  template<typename Node2>
242  RCP<MueLu::Ifpack2Smoother<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >
243  Ifpack2Smoother<Scalar,LocalOrdinal,GlobalOrdinal,Node>::clone(const RCP<Node2>& node2, const RCP<const Xpetra::Matrix<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >& A_newnode) const {
244 #ifdef HAVE_XPETRA_TPETRA
245  const ParameterList& paramList = this->GetParameterList();
246  typedef Tpetra::CrsMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> Matrix1;
247  typedef Tpetra::CrsMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node2> Matrix2;
248  RCP<Ifpack2Smoother<Scalar, LocalOrdinal, GlobalOrdinal, Node2> > cloneSmoother =
249  rcp(new Ifpack2Smoother<Scalar, LocalOrdinal, GlobalOrdinal, Node2>(type_, paramList, overlap_));
250 
251  //Get Tpetra::CrsMatrix from Xpetra::Matrix
252  RCP<const Xpetra::CrsMatrixWrap<Scalar, LocalOrdinal, GlobalOrdinal, Node2> > crsOp =
253  rcp_dynamic_cast<const Xpetra::CrsMatrixWrap<Scalar, LocalOrdinal, GlobalOrdinal, Node2> >(A_newnode);
254  const RCP<const Xpetra::TpetraCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node2> >& tmp =
255  rcp_dynamic_cast<const Xpetra::TpetraCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node2> >(crsOp->getCrsMatrix());
256 
257  Ifpack2::Factory factory;
258  cloneSmoother->prec_ = factory.clone<Matrix1, Matrix2>(prec_, tmp->getTpetra_CrsMatrix(), paramList);
259  cloneSmoother->type_ = type_;
260  cloneSmoother->SetParameterList(paramList);
261  cloneSmoother->IsSetup(this->IsSetup());
262  return cloneSmoother;
263 #else
264  TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError,
265  "MueLu::Ifpack2Smoother::clone(): clone only available with Tpetra.");
266 #endif
267  }
268 
269 #ifdef HAVE_MUELU_EPETRA
270 
271 # if ((defined(EPETRA_HAVE_OMP) && (!defined(HAVE_TPETRA_INST_OPENMP) || !defined(HAVE_TPETRA_INST_INT_INT))) || \
272  (!defined(EPETRA_HAVE_OMP) && (!defined(HAVE_TPETRA_INST_SERIAL) || !defined(HAVE_TPETRA_INST_INT_INT))))
273  // Stub specialization for missing Epetra template args
274  template<>
275  class Ifpack2Smoother<double,int,int,Xpetra::EpetraNode> : public SmootherPrototype<double,int,int,Xpetra::EpetraNode> {
276  typedef double Scalar;
277  typedef int LocalOrdinal;
278  typedef int GlobalOrdinal;
280 #undef MUELU_AMESOS2SMOOTHER_SHORT
281 #include "MueLu_UseShortNames.hpp"
282 
283  public:
284 #ifndef _MSC_VER
285  // Avoid error C3772: invalid friend template declaration
286  template<class Scalar2, class LocalOrdinal2, class GlobalOrdinal2, class Node2>
287  friend class Ifpack2Smoother;
288 #endif
289 
290  Ifpack2Smoother(const std::string& type, const Teuchos::ParameterList& paramList = Teuchos::ParameterList(), const LocalOrdinal& overlap = 0) {
291  MUELU_TPETRA_ETI_EXCEPTION("Ifpack2Smoother<double,int,int,EpetraNode>","Ifpack2Smoother<double,int,int,EpetraNode>","int");
292  };
293 
294  virtual ~Ifpack2Smoother() { }
295 
296  void SetParameterList(const Teuchos::ParameterList& paramList) {}
297  void DeclareInput(Level &currentLevel) const {}
298  void Setup(Level &currentLevel) {}
299  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const {}
300  RCP<SmootherPrototype> Copy() const { return Teuchos::null;}
301 
302  template<typename Node2>
303  RCP<MueLu::Ifpack2Smoother<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >
304  clone(const RCP<Node2>& node2, const Teuchos::RCP<const Matrix >& A_newnode) const { return Teuchos::null; }
305  std::string description() const { return std::string(""); }
306  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const {}
307 
309  size_t getNodeSmootherComplexity() const {size_t cplx=0; return cplx;};
310 
311  private:
312  void SetPrecParameters(const Teuchos::ParameterList& list = Teuchos::ParameterList()) const {}
313  };
314 # endif
315 
316 #endif // HAVE_MUELU_EPETRA
317 
318 } // namespace MueLu
319 
320 #define MUELU_IFPACK2SMOOTHER_SHORT
321 #endif // HAVE_MUELU_TPETRA && HAVE_MUELU_IFPACK2
322 #endif // MUELU_IFPACK2SMOOTHER_DECL_HPP
Ifpack2Smoother(const std::string &type, const Teuchos::ParameterList &paramList=Teuchos::ParameterList(), const LocalOrdinal &overlap=0)
void SetupGeneric(Level &currentLevel)
RCP< SmootherPrototype > Copy() const
RCP< Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getPreconditioner()
For diagnostic purposes.
void SetPrecParameters(const Teuchos::ParameterList &list=Teuchos::ParameterList()) const
std::string description() const
Return a simple one-line description of this object.
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply smoother.
friend class Ifpack2Smoother
Constructor.
RCP< Matrix > A_
matrix, used in apply if solving residual equation
Base class for smoother prototypes.
void SetParameterList(const Teuchos::ParameterList &paramList)
Namespace for MueLu classes and methods.
LO overlap_
overlap when using the smoother in additive Schwarz mode
RCP< MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node2 > > clone(const RCP< Node2 > &node2, const Teuchos::RCP< const Matrix > &A_newnode) const
std::string type_
ifpack2-specific key phrase that denote smoother type
void SetupBlockRelaxation(Level &currentLevel)
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
void SetupSchwarz(Level &currentLevel)
void SetupLineSmoothing(Level &currentLevel)
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void Setup(Level &currentLevel)
Set up the smoother.
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the preconditioner.
void SetupTopological(Level &currentLevel)
#define MUELU_TPETRA_ETI_EXCEPTION(cl, obj, go)
void DeclareInput(Level &currentLevel) const
Input.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
virtual ~Ifpack2Smoother()
Destructor.
void SetPrecParameters(const Teuchos::ParameterList &list=Teuchos::ParameterList()) const
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 SetupChebyshev(Level &currentLevel)
Kokkos::Compat::KokkosSerialWrapperNode EpetraNode
Class that encapsulates Ifpack2 smoothers.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
RCP< MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node2 > > clone(const RCP< Node2 > &node2, const Teuchos::RCP< const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node2 > > &A_newnode) const
Clone the smoother to a different node type.
RCP< Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node > > prec_
pointer to Ifpack2 preconditioner object