MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_AmesosSmoother.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_AMESOSSMOOTHER_HPP
47#define MUELU_AMESOSSMOOTHER_HPP
48
49#include "MueLu_ConfigDefs.hpp"
50#if defined(HAVE_MUELU_EPETRA) && defined(HAVE_MUELU_AMESOS)
51
52#include <Teuchos_ParameterList.hpp>
53#include <Xpetra_Matrix_fwd.hpp>
54
57
58#include "MueLu_SmootherPrototype.hpp"
59#include "MueLu_Exceptions.hpp"
60
61#include "MueLu_Level_fwd.hpp"
64
65namespace MueLu {
66
75 template <class Node = typename SmootherPrototype<double,int,int>::node_type>
76 class AmesosSmoother : public SmootherPrototype<double, int, int, Node>
77 {
78 typedef double Scalar;
79 typedef int LocalOrdinal;
80 typedef int GlobalOrdinal;
81
82#undef MUELU_AMESOSSMOOTHER_SHORT
84
85 public:
86
88
89
116 AmesosSmoother(const std::string& type = "", const Teuchos::ParameterList& paramList = Teuchos::ParameterList());
117
119 virtual ~AmesosSmoother() { };
120
122
124
125
126 void DeclareInput(Level& currentLevel) const;
127
129
131
132
137 void Setup(Level& currentLevel);
138
147 void Apply(MultiVector& X, const MultiVector& B, bool /* InitialGuessIsZero */ = false) const;
148
150
151 RCP<SmootherPrototype> Copy() const;
152
154
155
157 std::string description() const;
158
160 //using MueLu::Describable::describe; // overloading, not hiding
161 void print(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const;
162
164 size_t getNodeSmootherComplexity() const;
165
166
168
169 private:
170
171 // Important note:
172 // linearProblem_ must be destroyed before A_, because destructor of linearProblem_ is using A_.
173 // In C++, destructor of member objects are called in the reverse order they appear within the declaration for the class.
174 // ==18029== Invalid read of size 8
175 // ==18029== at 0xC0780A: Epetra_LinearProblem::GetMatrix() const (Epetra_LinearProblem.h:173)
176 // ==18029== by 0xC5EC27: Amesos_Superlu::PrintTiming() const (Amesos_Superlu.cpp:664)
177 // ==18029== by 0xC628C6: Amesos_Superlu::~Amesos_Superlu() (Amesos_Superlu.cpp:108)
178
180 std::string type_;
181
183 RCP<Matrix> A_;
184
186 RCP<Epetra_LinearProblem> linearProblem_;
187
189 RCP<Amesos_BaseSolver> prec_;
190
191 }; // class AmesosSmoother
192
194 // when <Scalar, LocalOrdinal, GlobalOrdinal> == <double, int, int>. Otherwise, an exception is thrown.
196 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
197 RCP<MueLu::SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
198 GetAmesosSmoother (const std::string& /* type */ = "", const Teuchos::ParameterList& /* paramList */ = Teuchos::ParameterList ()) {
199 TEUCHOS_TEST_FOR_EXCEPTION(true, Exceptions::RuntimeError,
200 "AmesosSmoother cannot be used with Scalar != double, LocalOrdinal != int, GlobalOrdinal != int");
201 TEUCHOS_UNREACHABLE_RETURN(Teuchos::null);
202 }
203
204 // specialization for Epetra
205#if defined(HAVE_MUELU_SERIAL)
206 template <>
207 inline RCP<MueLu::SmootherPrototype<double, int, int, Xpetra::EpetraNode> >
208 GetAmesosSmoother<double, int, int, Xpetra::EpetraNode> (const std::string& type, const Teuchos::ParameterList& paramList) {
209 return rcp (new MueLu::AmesosSmoother<Xpetra::EpetraNode>(type, paramList));
210 }
211#endif // HAVE_MUELU_SERIAL
212
213} // namespace MueLu
214
215#define MUELU_AMESOSSMOOTHER_SHORT
216
217#endif // HAVE_MUELU_AMESOS
218#endif // MUELU_AMESOSSMOOTHER_HPP
Class that encapsulates Amesos direct solvers.
std::string description() const
Return a simple one-line description of this object.
std::string type_
amesos-specific key phrase that denote smoother type
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
RCP< Matrix > A_
Matrix. Not used directly, but held inside of linearProblem_. So we have to keep an RCP pointer to it...
void Setup(Level &currentLevel)
Set up the direct solver. This creates the underlying Amesos solver object according to the parameter...
RCP< SmootherPrototype > Copy() const
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
RCP< Epetra_LinearProblem > linearProblem_
Problem that Amesos uses internally.
void DeclareInput(Level &currentLevel) const
Input.
void Apply(MultiVector &X, const MultiVector &B, bool=false) const
Apply the direct solver.
virtual ~AmesosSmoother()
Destructor.
RCP< Amesos_BaseSolver > prec_
pointer to Amesos solver object
Exception throws to report errors in the internal logical of the program.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Base class for smoother prototypes.
Namespace for MueLu classes and methods.
RCP< MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > > GetAmesosSmoother(const std::string &="", const Teuchos::ParameterList &=Teuchos::ParameterList())
Non-member templated function GetAmesosSmoother() returns a new AmesosSmoother object.