MueLu Version of the Day
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"
19
20#include "MueLu_Level_fwd.hpp"
22#include "MueLu_Exceptions.hpp"
23
24namespace MueLu {
25
26template <class LocalOrdinal = DefaultLocalOrdinal,
28 class Node = DefaultNode>
30#undef MUELU_USERAGGREGATIONFACTORY_SHORT
32
33 public:
35
36
39
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 &currentLevel) const;
56
58
60
61
63 void Build(Level &currentLevel) 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::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
Base class for factories that use one level (currentLevel).
void DeclareInput(Level &currentLevel) const
Input.
void Build(Level &currentLevel) const
Build aggregates.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Namespace for MueLu classes and methods.
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode