MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_Amesos2Smoother_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_AMESOS2SMOOTHER_DECL_HPP
47 #define MUELU_AMESOS2SMOOTHER_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 #if defined(HAVE_MUELU_TPETRA) && defined(HAVE_MUELU_AMESOS2)
51 
53 
55 
56 #include "MueLu_SmootherPrototype.hpp"
58 #include "MueLu_Utilities_fwd.hpp"
59 
60 namespace Amesos2 { template<class OP, class MV> class Solver; }
61 
62 namespace MueLu {
63 
73  template <class Scalar = SmootherPrototype<>::scalar_type,
74  class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type,
75  class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type,
76  class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
77  class Amesos2Smoother : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
78 #undef MUELU_AMESOS2SMOOTHER_SHORT
79 #include "MueLu_UseShortNames.hpp"
80 
81  public:
82 
84 
85 
90  Amesos2Smoother(const std::string& type = "", const Teuchos::ParameterList& paramList = Teuchos::ParameterList());
91 
93  virtual ~Amesos2Smoother();
95 
97 
98 
99  void DeclareInput(Level& currentLevel) const;
100 
102 
104 
105 
110  void Setup(Level& currentLevel);
111 
118  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
120 
122 
124 
125 
127  std::string description() const;
128 
130  //using MueLu::Describable::describe; // overloading, not hiding
131  void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const;
132 
134  size_t getNodeSmootherComplexity() const;
135 
137 
138  private:
139  typedef Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> Tpetra_CrsMatrix;
140  typedef Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> Tpetra_MultiVector;
141 
143  std::string type_;
144 
147 
150 
151  }; // class Amesos2Smoother
152 
153 #ifdef HAVE_MUELU_EPETRA
154 
155 # if ((defined(EPETRA_HAVE_OMP) && (!defined(HAVE_TPETRA_INST_OPENMP) || !defined(HAVE_TPETRA_INST_INT_INT))) || \
156  (!defined(EPETRA_HAVE_OMP) && (!defined(HAVE_TPETRA_INST_SERIAL) || !defined(HAVE_TPETRA_INST_INT_INT))))
157  // Stub specialization for missing Epetra template args
158  template<>
159  class Amesos2Smoother<double,int,int,Xpetra::EpetraNode> : public SmootherPrototype<double,int,int,Xpetra::EpetraNode> {
160  typedef double Scalar;
161  typedef int LocalOrdinal;
162  typedef int GlobalOrdinal;
164 #undef MUELU_AMESOS2SMOOTHER_SHORT
165 #include "MueLu_UseShortNames.hpp"
166 
167  public:
168  Amesos2Smoother(const std::string& type = "", const Teuchos::ParameterList& paramList = Teuchos::ParameterList()) {
169  MUELU_TPETRA_ETI_EXCEPTION("Amesos2Smoother<double,int,int,EpetraNode>","Amesos2Smoother<double,int,int,EpetraNode>","int");
170  }
171  virtual ~Amesos2Smoother() {};
172  void DeclareInput(Level& currentLevel) const {};
173  void Setup(Level& currentLevel) {};
174  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const {};
175 
176  RCP<SmootherPrototype> Copy() const { return Teuchos::null; };
177 
178  std::string description() const { return std::string(""); };
179  void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const {};
180 
182  size_t getNodeSmootherComplexity() const {size_t cplx=0; return cplx;};
183  };
184 # endif
185 #endif // HAVE_MUELU_EPETRA
186 
187 } // namespace MueLu
188 
189 #define MUELU_AMESOS2SMOOTHER_SHORT
190 #endif // HAVE_MUELU_TPETRA && HAVE_MUELU_AMESOS2
191 #endif // MUELU_AMESOS2SMOOTHER_DECL_HPP
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
std::string type_
amesos2-specific key phrase that denote smoother type
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the direct solver. Solves the linear system AX=B using the constructed solver.
Base class for smoother prototypes.
Amesos2Smoother(const std::string &type="", const Teuchos::ParameterList &paramList=Teuchos::ParameterList())
Constructor Creates a MueLu interface to the direct solvers in the Amesos2 package. If you are using type==&quot;&quot;, then either SuperLU or KLU2 are used by default.
std::string description() const
Return a simple one-line description of this object.
Amesos2Smoother(const std::string &type="", const Teuchos::ParameterList &paramList=Teuchos::ParameterList())
Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Tpetra_MultiVector
RCP< SmootherPrototype > Copy() const
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Class that encapsulates Amesos2 direct solvers.
Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > Tpetra_CrsMatrix
#define MUELU_TPETRA_ETI_EXCEPTION(cl, obj, go)
void DeclareInput(Level &currentLevel) const
Input.
virtual ~Amesos2Smoother()
Destructor.
void Setup(Level &currentLevel)
Set up the direct solver. This creates the underlying Amesos2 solver object according to the paramete...
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
RCP< Amesos2::Solver< Tpetra_CrsMatrix, Tpetra_MultiVector > > prec_
pointer to Amesos2 solver object
std::string description() const
Return a simple one-line description of this object.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply smoother.