Debian Codegraph @

packages/muelu/src/Transfers/Energy-Minimization/MueLu_PatternFactory_decl.hpp

raw
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
15 #include "MueLu_TwoLevelFactoryBase.hpp"
16 #include "MueLu_Level_fwd.hpp"
17 #include "MueLu_Utilities_fwd.hpp"
18
19 namespace MueLu {
20
21 /*!
22 @class PatternFactory class.
23 @brief Factory for building nonzero patterns for energy minimization.
24 @ingroup MueLuTransferClasses
25 */
26
27 template <class Scalar = DefaultScalar,
28 class LocalOrdinal = DefaultLocalOrdinal,
29 class GlobalOrdinal = DefaultGlobalOrdinal,
30 class Node = DefaultNode>
31 class PatternFactory : public TwoLevelFactoryBase {
32 #undef MUELU_PATTERNFACTORY_SHORT
33 #include "MueLu_UseShortNames.hpp"
34
35 public:
36 //! @name Constructors/Destructors.
37 //@{
38
39 //! @brief Constructor.
40 PatternFactory() {}
41
42 //! Destructor.
43 virtual ~PatternFactory() {}
44
45 //@}
46
47 RCP<const ParameterList> GetValidParameterList() const;
48
49 //! @name Input
50 //@{
51
52 void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
53
54 //@}
55
56 //! @name Build methods.
57 //@{
58
59 /*!
60 @brief Build method.
61
62 Builds nonzero pattern (graph) and returns it in <tt>coarseLevel</tt>.
63 */
64 void Build(Level& fineLevel, Level& coarseLevel) const;
65
66 //@}
67
68 }; // class PatternFactory
69
70 } // namespace MueLu
71
72 #define MUELU_PATTERNFACTORY_SHORT
73 #endif // MUELU_PATTERNFACTORY_DECL_HPP