MueLu Version of the Day
Loading...
Searching...
No Matches
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>
17#include <Xpetra_MatrixFactory_fwd.hpp>
18#include <Xpetra_Vector_fwd.hpp>
19#include <Xpetra_VectorFactory_fwd.hpp>
20
21#include "MueLu_ConfigDefs.hpp"
24#include "MueLu_Level_fwd.hpp"
28
29#ifdef HAVE_MUELU_MATLAB
30namespace MueLu {
36template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
38#undef MUELU_SINGLELEVELMATLABFACTORY_SHORT
40
41 public:
43
44
46
48
50
52
53 RCP<const ParameterList> GetValidParameterList() const;
54
55 void DeclareInput(Level& currentLevel) const;
56
58
60
61 void Build(Level& currentLevel) const;
63
65
66 std::string description() const;
68
69 private:
71
72 mutable bool hasDeclaredInput_;
73
75
77
79 mutable std::vector<std::string> needs_;
80
82
83}; // class SingleLevelMatlabFactory
84
85} // namespace MueLu
86
87#define MUELU_SINGLELEVELMATLABFACTORY_SHORT
88
89#endif // HAVE_MUELU_MATLAB
90#endif // MUELU SINGLELEVELMATLABFACTORY_DECL_HPP
Class that holds all level-specific information.
Base class for factories that use one level (currentLevel).
std::string description() const
@ name Description
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
void Build(Level &currentLevel) const
Build an object with this factory.
std::vector< std::string > needs_
List of arguments to the MATLAB function, in order. These args must correspond to MueLu "Needs" objec...
Namespace for MueLu classes and methods.