| 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_EMINPFACTORY_DECL_HPP |
| 11 |
#define MUELU_EMINPFACTORY_DECL_HPP |
| 12 |
|
| 13 |
#include "MueLu_ConfigDefs.hpp" |
| 14 |
|
| 15 |
#include <Xpetra_Matrix_fwd.hpp> |
| 16 |
#include <Xpetra_StridedMapFactory_fwd.hpp> |
| 17 |
|
| 18 |
#include "MueLu_EminPFactory_fwd.hpp" |
| 19 |
|
| 20 |
#include "MueLu_CGSolver_fwd.hpp" |
| 21 |
#include "MueLu_Constraint_fwd.hpp" |
| 22 |
#include "MueLu_GMRESSolver_fwd.hpp" |
| 23 |
#include "MueLu_Level_fwd.hpp" |
| 24 |
#include "MueLu_PerfUtils_fwd.hpp" |
| 25 |
#include "MueLu_PFactory.hpp" |
| 26 |
#include "MueLu_SolverBase_fwd.hpp" |
| 27 |
#include "MueLu_SteepestDescentSolver_fwd.hpp" |
| 28 |
|
| 29 |
namespace MueLu { |
| 30 |
|
| 31 |
/*! |
| 32 |
@class EminPFactory class. |
| 33 |
@brief Factory for building Energy Minimization prolongators. |
| 34 |
@ingroup MueLuTransferClasses |
| 35 |
*/ |
| 36 |
|
| 37 |
template <class Scalar = DefaultScalar, |
| 38 |
class LocalOrdinal = DefaultLocalOrdinal, |
| 39 |
class GlobalOrdinal = DefaultGlobalOrdinal, |
| 40 |
class Node = DefaultNode> |
| 41 |
class EminPFactory : public PFactory { |
| 42 |
#undef MUELU_EMINPFACTORY_SHORT |
| 43 |
#include "MueLu_UseShortNames.hpp" |
| 44 |
|
| 45 |
public: |
| 46 |
//! @name Constructors/Destructors. |
| 47 |
//@{ |
| 48 |
|
| 49 |
//! @brief Constructor. |
| 50 |
EminPFactory() {} |
| 51 |
|
| 52 |
//! Destructor. |
| 53 |
virtual ~EminPFactory() {} |
| 54 |
|
| 55 |
//@} |
| 56 |
|
| 57 |
RCP<const ParameterList> GetValidParameterList() const; |
| 58 |
|
| 59 |
//! @name Input |
| 60 |
//@{ |
| 61 |
|
| 62 |
void DeclareInput(Level& fineLevel, Level& coarseLevel) const; |
| 63 |
|
| 64 |
//@} |
| 65 |
|
| 66 |
//! @name Build methods. |
| 67 |
//@{ |
| 68 |
|
| 69 |
/*! |
| 70 |
@brief Build method. |
| 71 |
|
| 72 |
Builds energy minimization prolongator and returns it in <tt>coarseLevel</tt>. |
| 73 |
*/ |
| 74 |
void Build(Level& fineLevel, Level& coarseLevel) const; |
| 75 |
void BuildP(Level& fineLevel, Level& coarseLevel) const; |
| 76 |
|
| 77 |
//@} |
| 78 |
|
| 79 |
}; // class EminPFactory |
| 80 |
|
| 81 |
} // namespace MueLu |
| 82 |
|
| 83 |
#define MUELU_EMINPFACTORY_SHORT |
| 84 |
#endif // MUELU_EMINPFACTORY_DECL_HPP |