MueLu  Version of the Day
MueLu_SmootherCloner.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_SMOOTHERBASECLONER_HPP
47 #define MUELU_SMOOTHERBASECLONER_HPP
48 
50 
51 #include "MueLu_ConfigDefs.hpp"
52 #include "MueLu_BaseClass.hpp"
53 
54 #include "MueLu_SmootherBase.hpp"
55 #if defined(HAVE_MUELU_IFPACK2)
56 #include "MueLu_Ifpack2Smoother.hpp"
57 #endif
58 #include "MueLu_TrilinosSmoother.hpp"
59 
60 namespace MueLu {
61 
62 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node1, class Node2>
66  const RCP<Node2>& node2)
67 {
68 #if defined(HAVE_MUELU_IFPACK2)
72  if (trilSmoother != Teuchos::null){
73  cloneSB = trilSmoother->clone (node2, cloneA);
74  return cloneSB;
75  }
76 
79  if (ifSmoother != Teuchos::null){
80  cloneSB = ifSmoother->clone(node2, cloneA);
81  return cloneSB;
82  }
83 
84  else {
86  true, std::invalid_argument, "MueLu::SmootherClone: "
87  "Invalid smoother type to clone (not TrilinosSmoother or Ifpack2 ) \"");
88  }
89 #else
91  true, std::invalid_argument, "MueLu::SmootherClone: "
92  "clone() only available with IFPACK2 enabled.");
93 #endif
94 
95 }
96 } //namespace MueLu
97 
98 #define MUELU_SMOOTHERBASECLONER_SHORT
99 #endif //ifndef MUELU_SMOOTHERBASECLONER_HPP
100 
Class that encapsulates external library smoothers.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Namespace for MueLu classes and methods.
Base class for smoothers.
Teuchos::RCP< SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node2 > > clone(const Teuchos::RCP< SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node1 > > &SB, const Teuchos::RCP< const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node2 > > &cloneA, const RCP< Node2 > &node2)
Class that encapsulates Ifpack2 smoothers.