MueLu
Version of the Day
Toggle main menu visibility
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
"
18
#include "
MueLu_SingleLevelFactoryBase.hpp
"
19
#include "
MueLu_ScaledNullspaceFactory_fwd.hpp
"
20
21
#include "
MueLu_Level_fwd.hpp
"
22
23
namespace
MueLu
{
24
68
69
template
<
class
Scalar
=
DefaultScalar
,
70
class
LocalOrdinal
=
DefaultLocalOrdinal
,
71
class
GlobalOrdinal
=
DefaultGlobalOrdinal
,
72
class
Node
=
DefaultNode
>
73
class
ScaledNullspaceFactory
:
public
SingleLevelFactoryBase
{
74
#undef MUELU_SCALEDNULLSPACEFACTORY_SHORT
75
#include "
MueLu_UseShortNames.hpp
"
76
77
public
:
79
80
82
ScaledNullspaceFactory
(
const
std::string &nspName =
"Nullspace"
) {
83
SetParameter
(
"Fine level nullspace"
, ParameterEntry(nspName));
84
}
85
87
virtual
~ScaledNullspaceFactory
() {}
88
90
92
94
96
RCP<const ParameterList>
GetValidParameterList
()
const
;
97
103
104
void
DeclareInput
(
Level
¤tLevel)
const
;
105
107
109
110
112
void
Build
(
Level
¤tLevel)
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_ConfigDefs.hpp
MueLu_Level_fwd.hpp
MueLu_ScaledNullspaceFactory_fwd.hpp
MueLu_SingleLevelFactoryBase.hpp
LocalOrdinal
MueLu::DefaultLocalOrdinal LocalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:13
Scalar
MueLu::DefaultScalar Scalar
Definition
MueLu_UseDefaultTypes.hpp:12
GlobalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:14
Node
MueLu::DefaultNode Node
Definition
MueLu_UseDefaultTypes.hpp:15
MueLu_UseShortNames.hpp
MueLu::Level
Class that holds all level-specific information.
Definition
MueLu_Level.hpp:63
MueLu::ParameterListAcceptorImpl::SetParameter
void SetParameter(const std::string &name, const ParameterEntry &entry)
Set a parameter directly as a ParameterEntry.
Definition
MueLu_ParameterListAcceptor.cpp:77
MueLu::ScaledNullspaceFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Define valid parameters for internal factory parameters.
Definition
MueLu_ScaledNullspaceFactory_def.hpp:26
MueLu::ScaledNullspaceFactory::~ScaledNullspaceFactory
virtual ~ScaledNullspaceFactory()
Destructor.
Definition
MueLu_ScaledNullspaceFactory_decl.hpp:87
MueLu::ScaledNullspaceFactory::DeclareInput
void DeclareInput(Level ¤tLevel) const
Specifies the data that this class needs, and the factories that generate that data.
Definition
MueLu_ScaledNullspaceFactory_def.hpp:37
MueLu::ScaledNullspaceFactory::ScaledNullspaceFactory
ScaledNullspaceFactory(const std::string &nspName="Nullspace")
Constructor.
Definition
MueLu_ScaledNullspaceFactory_decl.hpp:82
MueLu::ScaledNullspaceFactory::Build
void Build(Level ¤tLevel) const
Build an object with this factory.
Definition
MueLu_ScaledNullspaceFactory_def.hpp:44
MueLu::SingleLevelFactoryBase::SingleLevelFactoryBase
SingleLevelFactoryBase()
Constructor.
MueLu
Namespace for MueLu classes and methods.
Definition
MueLu_BrickAggregationFactory_decl.hpp:42
MueLu::DefaultNode
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Definition
MueLu_Details_DefaultTypes.hpp:32
MueLu::DefaultGlobalOrdinal
int DefaultGlobalOrdinal
Definition
MueLu_Details_DefaultTypes.hpp:29
MueLu::DefaultLocalOrdinal
int DefaultLocalOrdinal
Definition
MueLu_Details_DefaultTypes.hpp:22
MueLu::DefaultScalar
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar
Definition
MueLu_Details_DefaultTypes.hpp:20
src
Transfers
Smoothed-Aggregation
MueLu_ScaledNullspaceFactory_decl.hpp
Generated by
1.17.0