MueLu
Version of the Day
Toggle main menu visibility
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
"
22
#include "
MueLu_TwoLevelMatlabFactory_fwd.hpp
"
23
24
#include "
MueLu_FactoryBase_fwd.hpp
"
25
#include "
MueLu_Level_fwd.hpp
"
26
#include "
MueLu_PerfUtils_fwd.hpp
"
27
#include "
MueLu_TwoLevelFactoryBase.hpp
"
28
#include "
MueLu_Utilities_fwd.hpp
"
29
30
#ifdef HAVE_MUELU_MATLAB
31
32
namespace
MueLu
{
38
template
<
class
Scalar
=
DefaultScalar
,
39
class
LocalOrdinal
=
DefaultLocalOrdinal
,
40
class
GlobalOrdinal
=
DefaultGlobalOrdinal
,
41
class
Node
=
DefaultNode
>
42
class
TwoLevelMatlabFactory
:
public
TwoLevelFactoryBase
{
43
#undef MUELU_TWOLEVELMATLABFACTORY_SHORT
44
#include "
MueLu_UseShortNames.hpp
"
45
46
public
:
48
49
50
TwoLevelMatlabFactory
();
51
52
virtual
~TwoLevelMatlabFactory
() {}
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_ConfigDefs.hpp
MueLu_FactoryBase_fwd.hpp
MueLu_Level_fwd.hpp
MueLu_PerfUtils_fwd.hpp
MueLu_TwoLevelFactoryBase.hpp
MueLu_TwoLevelMatlabFactory_fwd.hpp
LocalOrdinal
MueLu::DefaultLocalOrdinal LocalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:13
Scalar
MueLu::DefaultScalar Scalar
Definition
MueLu_UseDefaultTypes.hpp:12
GlobalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:14
Node
MueLu::DefaultNode Node
Definition
MueLu_UseDefaultTypes.hpp:15
MueLu_UseShortNames.hpp
MueLu_Utilities_fwd.hpp
MueLu::Level
Class that holds all level-specific information.
Definition
MueLu_Level.hpp:63
MueLu::TwoLevelFactoryBase::TwoLevelFactoryBase
TwoLevelFactoryBase()
Constructor.
MueLu::TwoLevelMatlabFactory::description
std::string description() const
@ name Description
Definition
MueLu_TwoLevelMatlabFactory_def.hpp:89
MueLu::TwoLevelMatlabFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::needsCoarse_
std::vector< std::string > needsCoarse_
Definition
MueLu_TwoLevelMatlabFactory_decl.hpp:86
MueLu::TwoLevelMatlabFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition
MueLu_TwoLevelMatlabFactory_def.hpp:32
MueLu::TwoLevelMatlabFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasDeclaredInput_
bool hasDeclaredInput_
Definition
MueLu_TwoLevelMatlabFactory_decl.hpp:76
MueLu::TwoLevelMatlabFactory::~TwoLevelMatlabFactory
virtual ~TwoLevelMatlabFactory()
Definition
MueLu_TwoLevelMatlabFactory_decl.hpp:52
MueLu::TwoLevelMatlabFactory::TwoLevelMatlabFactory
TwoLevelMatlabFactory()
Definition
MueLu_TwoLevelMatlabFactory_def.hpp:28
MueLu::TwoLevelMatlabFactory::Build
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
Definition
MueLu_TwoLevelMatlabFactory_def.hpp:62
MueLu::TwoLevelMatlabFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::needsFine_
std::vector< std::string > needsFine_
Definition
MueLu_TwoLevelMatlabFactory_decl.hpp:83
MueLu::TwoLevelMatlabFactory::DeclareInput
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Definition
MueLu_TwoLevelMatlabFactory_def.hpp:42
MueLu
Namespace for MueLu classes and methods.
Definition
MueLu_BrickAggregationFactory_decl.hpp:42
MueLu::DefaultNode
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Definition
MueLu_Details_DefaultTypes.hpp:32
MueLu::DefaultGlobalOrdinal
int DefaultGlobalOrdinal
Definition
MueLu_Details_DefaultTypes.hpp:29
MueLu::DefaultLocalOrdinal
int DefaultLocalOrdinal
Definition
MueLu_Details_DefaultTypes.hpp:22
MueLu::DefaultScalar
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar
Definition
MueLu_Details_DefaultTypes.hpp:20
matlab
src
MueLu_TwoLevelMatlabFactory_decl.hpp
Generated by
1.17.0