MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_PatternFactory_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_PATTERNFACTORY_DECL_HPP
11 #define MUELU_PATTERNFACTORY_DECL_HPP
12 
13 #include "MueLu_ConfigDefs.hpp"
14 
16 #include "MueLu_Level_fwd.hpp"
17 #include "MueLu_Utilities_fwd.hpp"
18 
19 namespace MueLu {
20 
27 template <class Scalar = DefaultScalar,
30  class Node = DefaultNode>
32 #undef MUELU_PATTERNFACTORY_SHORT
33 #include "MueLu_UseShortNames.hpp"
34 
35  public:
37 
38 
41 
43  virtual ~PatternFactory() {}
44 
46 
48 
50 
51 
52  void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
53 
55 
57 
58 
64  void Build(Level& fineLevel, Level& coarseLevel) const;
65 
67 
68 }; // class PatternFactory
69 
70 } // namespace MueLu
71 
72 #define MUELU_PATTERNFACTORY_SHORT
73 #endif // MUELU_PATTERNFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Base class for factories that use two levels (fineLevel and coarseLevel).
MueLu::DefaultNode Node
void Build(Level &fineLevel, Level &coarseLevel) const
Build method.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
MueLu::DefaultScalar Scalar
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:63
Factory for building nonzero patterns for energy minimization.
virtual ~PatternFactory()
Destructor.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.