MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_MatlabSmoother_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_MATLABSMOOTHER_DECL_HPP
47#define MUELU_MATLABSMOOTHER_DECL_HPP
48
49#include <Teuchos_ParameterList.hpp>
50#include <Xpetra_Matrix_fwd.hpp>
51#include "MueLu_ConfigDefs.hpp"
52
53#if defined(HAVE_MUELU_TPETRA) && defined(HAVE_MUELU_MATLAB)
54#include <Tpetra_CrsMatrix.hpp>
55#include "MueLu_SmootherPrototype.hpp"
58
59namespace MueLu {
60
70 template <class Scalar = SmootherPrototype<>::scalar_type,
74 class MatlabSmoother : public SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node>
75 {
76#undef MUELU_MATLABSMOOTHER_SHORT
78
79 public:
80
82
83 //TODO: update doc for Matlab.
90#ifndef _MSC_VER
91 // Avoid error C3772: invalid friend template declaration
92 template<class Scalar2, class LocalOrdinal2, class GlobalOrdinal2, class Node2>
93 friend class MatlabSmoother;
94#endif
95
96 MatlabSmoother(const Teuchos::ParameterList& paramList = Teuchos::ParameterList());
97
99 virtual ~MatlabSmoother() { }
100
102
103 void SetParameterList(const Teuchos::ParameterList& paramList);
104
106
107
108 void DeclareInput(Level &currentLevel) const;
109
111
113
114
122 void Setup(Level &currentLevel);
123
132 void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
133
135
137
138
139 RCP<SmootherPrototype> Copy() const;
140
142
144 template<typename Node2>
145 RCP<MueLu::MatlabSmoother<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >
146 clone(const RCP<Node2>& node2, const Teuchos::RCP<const Xpetra::Matrix<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >& A_newnode) const;
147
149
150
152 std::string description() const;
153
155 //using MueLu::Describable::describe; // overloading, not hiding
156 //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const
157 void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
158
159 size_t getNodeSmootherComplexity() const {return Teuchos::OrdinalTraits<size_t>::invalid();}
160
161
163
164 private:
165
167 mutable std::string needsSetup_;
168
171
173 std::vector<Teuchos::RCP<MuemexArg> > solveData_;
174
176 std::string setupFunction_;
177
179 std::string solveFunction_;
180
182 mutable RCP<Matrix> A_;
183
184 }; // class MatlabSmoother
185
186 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
187 template<typename Node2>
188 RCP<MueLu::MatlabSmoother<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >
189 MatlabSmoother<Scalar,LocalOrdinal,GlobalOrdinal,Node>::clone(const RCP<Node2>& node2, const RCP<const Xpetra::Matrix<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >& A_newnode) const {
190 const ParameterList& paramList = this->GetParameterList();
191
192 RCP<MatlabSmoother<Scalar, LocalOrdinal, GlobalOrdinal, Node2> > cloneSmoother =
194
195 cloneSmoother->needsSetup_ = needsSetup_;
196 cloneSmoother->setupFunction_ = setupFunction_;
197 cloneSmoother->solveFunction_ = solveFunction_;
198 cloneSmoother->A_ = A_;
199
200 for(size_t i=0; i< solveData_.size(); i++)
201 cloneSmoother->solveData_->push_back(solveData_[i]);
202 cloneSmoother->SetParameterList(paramList);
203 cloneSmoother->IsSetup(this->IsSetup());
204 return cloneSmoother;
205 }
206
207
208} // namespace MueLu
209
210#define MUELU_MATLABSMOOTHER_SHORT
211#endif // HAVE_MUELU_TPETRA && HAVE_MUELU_MATLAB
212#endif // MUELU_MATLABSMOOTHER_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
virtual ~MatlabSmoother()
Destructor.
std::string solveFunction_
Matlab solve function.
void DeclareInput(Level &currentLevel) const
Input.
size_t getNodeSmootherComplexity() const
Compute a rough estimate of the cost to apply this smoother on this MPI rank. Return Teuchos::Ordinal...
std::string needsSetup_
List of arguments to the MATLAB setup function besides "A", in order.
RCP< MueLu::MatlabSmoother< 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.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
void Setup(Level &currentLevel)
Set up the smoother.
size_t solveDataSize_
Amount of solve data (besides A, LHS & RHS)
RCP< SmootherPrototype > Copy() const
RCP< Matrix > A_
Matrix, (maybe) used in apply.
friend class MatlabSmoother
Constructor.
std::vector< Teuchos::RCP< MuemexArg > > solveData_
List of data generated by setup which will be sent to solve after "A", "LHS" and "RHS".
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the preconditioner.
std::string setupFunction_
Matlab setup function.
void SetParameterList(const Teuchos::ParameterList &paramList)
Set parameters from a parameter list and return with default values.
std::string description() const
Return a simple one-line description of this object.
Base class for smoother prototypes.
Namespace for MueLu classes and methods.