MueLu
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
MueLu_UserAggregationFactory_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_USERAGGREGATIONFACTORY_DECL_HPP_
11
#define MUELU_USERAGGREGATIONFACTORY_DECL_HPP_
12
13
#include <Xpetra_Map_fwd.hpp>
14
#include <Xpetra_MapFactory_fwd.hpp>
15
16
#include "
MueLu_ConfigDefs.hpp
"
17
#include "
MueLu_SingleLevelFactoryBase.hpp
"
18
#include "
MueLu_UserAggregationFactory_fwd.hpp
"
19
20
#include "
MueLu_Level_fwd.hpp
"
21
#include "
MueLu_Aggregates_fwd.hpp
"
22
#include "
MueLu_Exceptions.hpp
"
23
24
namespace
MueLu
{
25
26
template
<
class
LocalOrdinal
=
DefaultLocalOrdinal
,
27
class
GlobalOrdinal
=
DefaultGlobalOrdinal
,
28
class
Node
=
DefaultNode
>
29
class
UserAggregationFactory
:
public
SingleLevelFactoryBase
{
30
#undef MUELU_USERAGGREGATIONFACTORY_SHORT
31
#include "
MueLu_UseShortNamesOrdinal.hpp
"
32
33
public
:
35
36
38
UserAggregationFactory
(){};
39
41
virtual
~UserAggregationFactory
() {}
42
43
RCP<const ParameterList>
GetValidParameterList
()
const
;
44
46
48
49
50
// Options shared by all aggregation algorithms
51
53
54
55
void
DeclareInput
(
Level
¤tLevel)
const
;
56
58
60
61
63
void
Build
(
Level
¤tLevel)
const
;
64
66
67
private
:
68
};
// class UserAggregationFactory
69
70
}
// namespace MueLu
71
72
#define MUELU_USERAGGREGATIONFACTORY_SHORT
73
#endif
/* MUELU_USERAGGREGATIONFACTORY_DECL_HPP_ */
MueLu_Aggregates_fwd.hpp
MueLu_ConfigDefs.hpp
MueLu_Exceptions.hpp
MueLu_Level_fwd.hpp
MueLu_SingleLevelFactoryBase.hpp
LocalOrdinal
MueLu::DefaultLocalOrdinal LocalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:13
GlobalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:14
Node
MueLu::DefaultNode Node
Definition
MueLu_UseDefaultTypes.hpp:15
MueLu_UseShortNamesOrdinal.hpp
MueLu_UserAggregationFactory_fwd.hpp
MueLu::Level
Class that holds all level-specific information.
Definition
MueLu_Level.hpp:63
MueLu::SingleLevelFactoryBase::SingleLevelFactoryBase
SingleLevelFactoryBase()
Constructor.
MueLu::UserAggregationFactory::DeclareInput
void DeclareInput(Level ¤tLevel) const
Input.
Definition
MueLu_UserAggregationFactory_def.hpp:39
MueLu::UserAggregationFactory::UserAggregationFactory
UserAggregationFactory()
Constructor.
Definition
MueLu_UserAggregationFactory_decl.hpp:38
MueLu::UserAggregationFactory::~UserAggregationFactory
virtual ~UserAggregationFactory()
Destructor.
Definition
MueLu_UserAggregationFactory_decl.hpp:41
MueLu::UserAggregationFactory::Build
void Build(Level ¤tLevel) const
Build aggregates.
Definition
MueLu_UserAggregationFactory_def.hpp:48
MueLu::UserAggregationFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition
MueLu_UserAggregationFactory_def.hpp:28
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
src
Graph
UserAggregation
MueLu_UserAggregationFactory_decl.hpp
Generated by
1.17.0