MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_ConstraintFactory_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_CONSTRAINTFACTORY_DECL_HPP
11 #define MUELU_CONSTRAINTFACTORY_DECL_HPP
12 
13 #include "MueLu_ConfigDefs.hpp"
15 #include "MueLu_Constraint_fwd.hpp"
16 #include "MueLu_Level_fwd.hpp"
17 
18 namespace MueLu {
19 
29 template <class Scalar = DefaultScalar,
32  class Node = DefaultNode>
34 #undef MUELU_CONSTRAINTFACTORY_SHORT
35 #include "MueLu_UseShortNames.hpp"
36 
37  public:
39 
40 
46 
48  virtual ~ConstraintFactory() {}
49 
51 
53 
55 
56 
57  void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
58 
60 
62 
68  void Build(Level& fineLevel, Level& coarseLevel) const;
69 
71 }; // class ConstraintFactory
72 
73 } // namespace MueLu
74 
75 #define MUELU_CONSTRAINTFACTORY_SHORT
76 #endif // MUELU_CONSTRAINTFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Base class for factories that use two levels (fineLevel and coarseLevel).
MueLu::DefaultNode Node
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 the constraint operator.
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.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
ConstraintFactory()
Constructor. User can supply a factory for generating the nonzero pattern. The nullspace vectors (bot...