MueLu Version of the Day
Loading...
Searching...
No Matches
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
52#include <Teuchos_ParameterList.hpp>
53
55
56#include "MueLu_SmootherPrototype.hpp"
59
60namespace Amesos2 { template<class OP, class MV> class Solver; }
61
62namespace MueLu {
63
73 template <class Scalar = SmootherPrototype<>::scalar_type,
77 class Amesos2Smoother : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
78#undef MUELU_AMESOS2SMOOTHER_SHORT
80
81 public:
82
84
85
90 Amesos2Smoother(const std::string& type = "", const Teuchos::ParameterList& paramList = Teuchos::ParameterList());
91
93 virtual ~Amesos2Smoother();
94
95 RCP<const ParameterList> GetValidParameterList() const;
96
98
100
101
102 void DeclareInput(Level& currentLevel) const;
103
105
107
108
113 void Setup(Level& currentLevel);
114
121 void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
123
124 RCP<SmootherPrototype> Copy() const;
125
127
128
130 std::string description() const;
131
133 //using MueLu::Describable::describe; // overloading, not hiding
134 void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const;
135
137 size_t getNodeSmootherComplexity() const;
138
140
141 private:
142 typedef Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> Tpetra_CrsMatrix;
143 typedef Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> Tpetra_MultiVector;
144
146 std::string type_;
147
149 RCP<Amesos2::Solver<Tpetra_CrsMatrix, Tpetra_MultiVector> > prec_;
150
152 RCP<MultiVector> X_, B_;
153
154 }; // class Amesos2Smoother
155
156#ifdef HAVE_MUELU_EPETRA
157
158# if ((defined(EPETRA_HAVE_OMP) && (!defined(HAVE_TPETRA_INST_OPENMP) || !defined(HAVE_TPETRA_INST_INT_INT))) || \
159 (!defined(EPETRA_HAVE_OMP) && (!defined(HAVE_TPETRA_INST_SERIAL) || !defined(HAVE_TPETRA_INST_INT_INT))))
160 // Stub specialization for missing Epetra template args
161 template<>
162 class Amesos2Smoother<double,int,int,Xpetra::EpetraNode> : public SmootherPrototype<double,int,int,Xpetra::EpetraNode> {
163 typedef double Scalar;
164 typedef int LocalOrdinal;
165 typedef int GlobalOrdinal;
166 typedef Xpetra::EpetraNode Node;
167#undef MUELU_AMESOS2SMOOTHER_SHORT
169
170 public:
171 Amesos2Smoother(const std::string& type = "", const Teuchos::ParameterList& paramList = Teuchos::ParameterList()) {
172 MUELU_TPETRA_ETI_EXCEPTION("Amesos2Smoother<double,int,int,EpetraNode>","Amesos2Smoother<double,int,int,EpetraNode>","int");
173 }
174 virtual ~Amesos2Smoother() {};
175 void DeclareInput(Level& currentLevel) const {};
176 void Setup(Level& currentLevel) {};
177 void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const {};
178
179 RCP<SmootherPrototype> Copy() const { return Teuchos::null; };
180
181 std::string description() const { return std::string(""); };
182 void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const {};
183
185 size_t getNodeSmootherComplexity() const {size_t cplx=0; return cplx;};
186 };
187# endif
188#endif // HAVE_MUELU_EPETRA
189
190} // namespace MueLu
191
192#define MUELU_AMESOS2SMOOTHER_SHORT
193#endif // HAVE_MUELU_TPETRA && HAVE_MUELU_AMESOS2
194#endif // MUELU_AMESOS2SMOOTHER_DECL_HPP
Kokkos::Compat::KokkosSerialWrapperNode EpetraNode
#define MUELU_TPETRA_ETI_EXCEPTION(cl, obj, go)
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply smoother.
std::string description() const
Return a simple one-line description of this object.
Amesos2Smoother(const std::string &type="", const Teuchos::ParameterList &paramList=Teuchos::ParameterList())
Class that encapsulates Amesos2 direct solvers.
void DeclareInput(Level &currentLevel) const
Input.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
std::string type_
amesos2-specific key phrase that denote smoother type
RCP< SmootherPrototype > Copy() const
std::string description() const
Return a simple one-line description of this object.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > Tpetra_CrsMatrix
RCP< Amesos2::Solver< Tpetra_CrsMatrix, Tpetra_MultiVector > > prec_
pointer to Amesos2 solver object
Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Tpetra_MultiVector
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void Setup(Level &currentLevel)
Set up the direct solver. This creates the underlying Amesos2 solver object according to the paramete...
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.
Amesos2Smoother(const std::string &type="", const Teuchos::ParameterList &paramList=Teuchos::ParameterList())
Constructor Creates a MueLu interface to the direct solvers in the Amesos2 package....
Class that holds all level-specific information.
Base class for smoother prototypes.
Namespace for MueLu classes and methods.