MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_ScaledNullspaceFactory_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_SCALEDNULLSPACEFACTORY_DECL_HPP
11#define MUELU_SCALEDNULLSPACEFACTORY_DECL_HPP
12
13#include <Xpetra_Matrix_fwd.hpp>
14#include <Xpetra_VectorFactory_fwd.hpp>
15#include <Xpetra_MultiVectorFactory_fwd.hpp>
16
17#include "MueLu_ConfigDefs.hpp"
20
21#include "MueLu_Level_fwd.hpp"
22
23namespace MueLu {
24
69template <class Scalar = DefaultScalar,
72 class Node = DefaultNode>
74#undef MUELU_SCALEDNULLSPACEFACTORY_SHORT
76
77 public:
79
80
82 ScaledNullspaceFactory(const std::string &nspName = "Nullspace") {
83 SetParameter("Fine level nullspace", ParameterEntry(nspName));
84 }
85
88
90
92
94
96 RCP<const ParameterList> GetValidParameterList() const;
97
104 void DeclareInput(Level &currentLevel) const;
105
107
109
110
112 void Build(Level &currentLevel) const;
113
115
116 private:
117}; // class NullspaceFactory
118
119} // namespace MueLu
120
121#define MUELU_SCALEDNULLSPACEFACTORY_SHORT
122#endif // MUELU_SCALEDNULLSPACEFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
void SetParameter(const std::string &name, const ParameterEntry &entry)
Set a parameter directly as a ParameterEntry.
Factory for generating a very special nullspace.
RCP< const ParameterList > GetValidParameterList() const
Define valid parameters for internal factory parameters.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
ScaledNullspaceFactory(const std::string &nspName="Nullspace")
Constructor.
void Build(Level &currentLevel) const
Build an object with this factory.
Base class for factories that use one level (currentLevel).
Namespace for MueLu classes and methods.
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar