MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_SingleLevelMatlabFactory_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // MueLu: A package for multigrid based preconditioning
4 //
5 // Copyright 2012 NTESS and the MueLu contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef MUELU_SINGLELEVELMATLABFACTORY_DECL_HPP
11 #define MUELU_SINGLELEVELMATLABFACTORY_DECL_HPP
12 
13 #include <string>
14 
15 #include <Xpetra_Matrix_fwd.hpp>
16 #include <Xpetra_CrsMatrix_fwd.hpp>
18 #include <Xpetra_Vector_fwd.hpp>
20 
21 #include "MueLu_ConfigDefs.hpp"
24 #include "MueLu_Level_fwd.hpp"
25 #include "MueLu_PerfUtils_fwd.hpp"
27 #include "MueLu_Utilities_fwd.hpp"
28 
29 #ifdef HAVE_MUELU_MATLAB
30 #include "mex.h"
31 
32 namespace MueLu {
38 template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
39 class SingleLevelMatlabFactory : public SingleLevelFactoryBase {
40 #undef MUELU_SINGLELEVELMATLABFACTORY_SHORT
41 #include "MueLu_UseShortNames.hpp"
42 
43  public:
45 
46 
48 
50 
52 
54 
56 
57  void DeclareInput(Level& currentLevel) const;
58 
60 
62 
63  void Build(Level& currentLevel) const;
65 
67 
68  std::string description() const;
70 
71  private:
73 
74  mutable bool hasDeclaredInput_;
75 
77 
79 
81  mutable std::vector<std::string> needs_;
82 
84 
85 }; // class SingleLevelMatlabFactory
86 
87 } // namespace MueLu
88 
89 #define MUELU_SINGLELEVELMATLABFACTORY_SHORT
90 
91 #endif // HAVE_MUELU_MATLAB
92 #endif // MUELU SINGLELEVELMATLABFACTORY_DECL_HPP
std::vector< std::string > needs_
List of arguments to the MATLAB function, in order. These args must correspond to MueLu &quot;Needs&quot; objec...
void Build(Level &currentLevel) const
Build an object with this factory.
std::string description() const
@ name Description
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:63
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.