MueLu  Version of the Day
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"
57 
58 namespace MueLu {
59 
69  template <class Scalar = SmootherPrototype<>::scalar_type,
70  class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type,
73  class MatlabSmoother : public SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node>
74  {
75 #undef MUELU_MATLABSMOOTHER_SHORT
76 #include "MueLu_UseShortNames.hpp"
77 
78  public:
79 
81 
82  //TODO: update doc for Matlab.
89 #ifndef _MSC_VER
90  // Avoid error C3772: invalid friend template declaration
91  template<class Scalar2, class LocalOrdinal2, class GlobalOrdinal2, class Node2>
92  friend class MatlabSmoother;
93 #endif
94 
95  MatlabSmoother(const Teuchos::ParameterList& paramList = Teuchos::ParameterList());
96 
98  virtual ~MatlabSmoother() { }
99 
101 
102  void SetParameterList(const Teuchos::ParameterList& paramList);
103 
105 
106 
107  void DeclareInput(Level &currentLevel) const;
108 
110 
112 
113 
121  void Setup(Level &currentLevel);
122 
131  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
132 
134 
136 
137 
138  RCP<SmootherPrototype> Copy() const;
139 
141 
143  template<typename Node2>
144  RCP<MueLu::MatlabSmoother<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >
145  clone(const RCP<Node2>& node2, const Teuchos::RCP<const Xpetra::Matrix<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >& A_newnode) const;
146 
148 
149 
151  std::string description() const;
152 
154  //using MueLu::Describable::describe; // overloading, not hiding
155  //void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const
156  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
157 
159 
160  private:
161 
163  mutable std::string needsSetup_;
164 
167 
169  std::vector<Teuchos::RCP<MuemexArg> > solveData_;
170 
172  std::string setupFunction_;
173 
175  std::string solveFunction_;
176 
178  mutable RCP<Matrix> A_;
179 
180  }; // class MatlabSmoother
181 
182  template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
183  template<typename Node2>
184  RCP<MueLu::MatlabSmoother<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >
185  MatlabSmoother<Scalar,LocalOrdinal,GlobalOrdinal,Node>::clone(const RCP<Node2>& node2, const RCP<const Xpetra::Matrix<Scalar,LocalOrdinal,GlobalOrdinal,Node2> >& A_newnode) const {
186  const ParameterList& paramList = this->GetParameterList();
187 
188  RCP<MatlabSmoother<Scalar, LocalOrdinal, GlobalOrdinal, Node2> > cloneSmoother =
190 
191  cloneSmoother->needsSetup_ = needsSetup_;
192  cloneSmoother->setupFunction_ = setupFunction_;
193  cloneSmoother->solveFunction_ = solveFunction_;
194  cloneSmoother->A_ = A_;
195 
196  for(size_t i=0; i< solveData_.size(); i++)
197  cloneSmoother->solveData_->push_back(solveData_[i]);
198  cloneSmoother->SetParameterList(paramList);
199  cloneSmoother->IsSetup(this->IsSetup());
200  return cloneSmoother;
201  }
202 
203 
204 } // namespace MueLu
205 
206 #define MUELU_MATLABSMOOTHER_SHORT
207 #endif // HAVE_MUELU_TPETRA && HAVE_MUELU_MATLAB
208 #endif // MUELU_MATLABSMOOTHER_DECL_HPP
void SetParameterList(const Teuchos::ParameterList &paramList)
void DeclareInput(Level &currentLevel) const
Input.
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the preconditioner.
RCP< SmootherPrototype > Copy() const
size_t solveDataSize_
Amount of solve data (besides A, LHS & RHS)
std::vector< Teuchos::RCP< MuemexArg > > solveData_
List of data generated by setup which will be sent to solve after "A", "LHS" and "RHS".
Base class for smoother prototypes.
void Setup(Level &currentLevel)
Set up the smoother.
Namespace for MueLu classes and methods.
virtual const Teuchos::ParameterList & GetParameterList() const
RCP< Matrix > A_
Matrix, (maybe) used in apply.
virtual ~MatlabSmoother()
Destructor.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
std::string setupFunction_
Matlab setup function.
bool IsSetup() const
Get the state of a smoother prototype.
friend class MatlabSmoother
Constructor.
std::string solveFunction_
Matlab solve function.
Class that encapsulates Matlab smoothers.
std::string description() const
Return a simple one-line description of this object.
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.