| 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" |
| 14 |
#include "MueLu_TwoLevelFactoryBase.hpp" |
| 15 |
#include "MueLu_Constraint_fwd.hpp" |
| 16 |
#include "MueLu_Level_fwd.hpp" |
| 17 |
|
| 18 |
namespace MueLu { |
| 19 |
|
| 20 |
/*! |
| 21 |
@class ConstraintFactory class. |
| 22 |
@brief Factory for building the constraint operator |
| 23 |
|
| 24 |
Factory for creating the constraint operator. |
| 25 |
|
| 26 |
@ingroup MueLuTransferClasses |
| 27 |
*/ |
| 28 |
|
| 29 |
template <class Scalar = DefaultScalar, |
| 30 |
class LocalOrdinal = DefaultLocalOrdinal, |
| 31 |
class GlobalOrdinal = DefaultGlobalOrdinal, |
| 32 |
class Node = DefaultNode> |
| 33 |
class ConstraintFactory : public TwoLevelFactoryBase { |
| 34 |
#undef MUELU_CONSTRAINTFACTORY_SHORT |
| 35 |
#include "MueLu_UseShortNames.hpp" |
| 36 |
|
| 37 |
public: |
| 38 |
//! @name Constructors/Destructors. |
| 39 |
//@{ |
| 40 |
|
| 41 |
/*! @brief Constructor. |
| 42 |
User can supply a factory for generating the nonzero pattern. The nullspace vectors (both fine and coarse) will |
| 43 |
be taken from the corresponding level factories |
| 44 |
*/ |
| 45 |
ConstraintFactory() {} |
| 46 |
|
| 47 |
//! Destructor. |
| 48 |
virtual ~ConstraintFactory() {} |
| 49 |
|
| 50 |
//@} |
| 51 |
|
| 52 |
RCP<const ParameterList> GetValidParameterList() const; |
| 53 |
|
| 54 |
//! @name Input |
| 55 |
//@{ |
| 56 |
|
| 57 |
void DeclareInput(Level& fineLevel, Level& coarseLevel) const; |
| 58 |
|
| 59 |
//@} |
| 60 |
//! @name Build methods. |
| 61 |
//@{ |
| 62 |
|
| 63 |
/*! |
| 64 |
@brief Build method. |
| 65 |
|
| 66 |
Builds Constraint and returns it in <tt>coarseLevel</tt>. |
| 67 |
*/ |
| 68 |
void Build(Level& fineLevel, Level& coarseLevel) const; |
| 69 |
|
| 70 |
//@} |
| 71 |
}; // class ConstraintFactory |
| 72 |
|
| 73 |
} // namespace MueLu |
| 74 |
|
| 75 |
#define MUELU_CONSTRAINTFACTORY_SHORT |
| 76 |
#endif // MUELU_CONSTRAINTFACTORY_DECL_HPP |