MueLu Version of the Day
Loading...
Searching...
No Matches
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>
17#include <Xpetra_MatrixFactory_fwd.hpp>
18#include <Xpetra_Vector_fwd.hpp>
19#include <Xpetra_VectorFactory_fwd.hpp>
20
21#include "MueLu_ConfigDefs.hpp"
23
25#include "MueLu_Level_fwd.hpp"
29
30#ifdef HAVE_MUELU_MATLAB
31
32namespace MueLu {
38template <class Scalar = DefaultScalar,
41 class Node = DefaultNode>
43#undef MUELU_TWOLEVELMATLABFACTORY_SHORT
45
46 public:
48
49
51
53
55
57
58 RCP<const ParameterList> GetValidParameterList() const;
59
60 void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
61
63
65
66 void Build(Level& fineLevel, Level& coarseLevel) const;
68
70
71 std::string description() const;
73 private:
75
76 mutable bool hasDeclaredInput_;
77
79
81
83 mutable std::vector<std::string> needsFine_;
84
86 mutable std::vector<std::string> needsCoarse_;
87
89
90}; // class TwoLevelMatlabFactory
91
92} // namespace MueLu
93
94#define MUELU_TWOLEVELMATLABFACTORY_SHORT
95
96#endif // HAVE_MUELU_MATLAB
97#endif // MUELU TWOLEVELMATLABFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
Base class for factories that use two levels (fineLevel and coarseLevel).
Factory for interacting with Matlab.
std::string description() const
@ name Description
std::vector< std::string > needsCoarse_
List of arguments to the MATLAB function, in order. These args must correspond to MueLu "Needs" objec...
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
std::vector< std::string > needsFine_
List of arguments to the MATLAB function, in order. These args must correspond to MueLu "Needs" objec...
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Namespace for MueLu classes and methods.
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar