MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_PermutationFactory_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 /*
11  * MueLu_PermutationFactory_decl.hpp
12  *
13  * Created on: Nov 28, 2012
14  * Author: wiesner
15  */
16 
17 #ifndef MUELU_PERMUTATIONFACTORY_DECL_HPP_
18 #define MUELU_PERMUTATIONFACTORY_DECL_HPP_
19 
20 #include <Xpetra_Map_fwd.hpp>
21 #include <Xpetra_Matrix_fwd.hpp>
22 
23 #include "MueLu_ConfigDefs.hpp"
25 
28 
29 namespace MueLu {
30 
38 template <class Scalar = DefaultScalar,
41  class Node = DefaultNode>
42 class PermutationFactory : public SingleLevelFactoryBase {
43 #undef MUELU_PERMUTATIONFACTORY_SHORT
44 #include "MueLu_UseShortNames.hpp"
45 
46  public:
48 
49 
52 
54  virtual ~PermutationFactory();
55 
57 
58  RCP<const ParameterList> GetValidParameterList() const;
59 
61 
62 
68  void DeclareInput(Level &currentLevel) const;
69 
71 
73 
74 
76  void Build(Level &currentLevel) const;
77 
79 
80  private:
81 }; // class PermutationFactory
82 
83 } // namespace MueLu
84 
85 #define MUELU_PERMUTATIONFACTORY_SHORT
86 
87 #endif /* MUELU_PERMUTATIONFACTORY_DECL_HPP_ */
MueLu::DefaultLocalOrdinal LocalOrdinal
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
MueLu::DefaultNode Node
MueLu::DefaultScalar Scalar
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void Build(Level &currentLevel) const
Build an object with this factory.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.