MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_TwoLevelMatlabFactory_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_TWOLEVELMATLABFACTORY_DECL_HPP
11 #define MUELU_TWOLEVELMATLABFACTORY_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"
23 
25 #include "MueLu_Level_fwd.hpp"
26 #include "MueLu_PerfUtils_fwd.hpp"
28 #include "MueLu_Utilities_fwd.hpp"
29 
30 #ifdef HAVE_MUELU_MATLAB
31 #include "mex.h"
32 
33 namespace MueLu {
39 template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
40 class TwoLevelMatlabFactory : public TwoLevelFactoryBase {
41 #undef MUELU_TWOLEVELMATLABFACTORY_SHORT
42 #include "MueLu_UseShortNames.hpp"
43 
44  public:
46 
47 
49 
51 
53 
55 
57 
58  void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
59 
61 
63 
64  void Build(Level& fineLevel, Level& coarseLevel) const;
66 
68 
69  std::string description() const;
71  private:
73 
74  mutable bool hasDeclaredInput_;
75 
77 
79 
81  mutable std::vector<std::string> needsFine_;
82 
84  mutable std::vector<std::string> needsCoarse_;
85 
87 
88 }; // class TwoLevelMatlabFactory
89 
90 } // namespace MueLu
91 
92 #define MUELU_TWOLEVELMATLABFACTORY_SHORT
93 
94 #endif // HAVE_MUELU_MATLAB
95 #endif // MUELU TWOLEVELMATLABFACTORY_DECL_HPP
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:63
std::string description() const
@ name Description
std::vector< std::string > needsFine_
List of arguments to the MATLAB function, in order. These args must correspond to MueLu &quot;Needs&quot; objec...
std::vector< std::string > needsCoarse_
List of arguments to the MATLAB function, in order. These args must correspond to MueLu &quot;Needs&quot; objec...
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.