MueLu
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
MueLu_PermutationFactory_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
/*
11
* MueLu_PermutationFactory_decl.hpp
12
*
13
* Created on: Nov 28, 2012
14
* Author: wiesner
15
*/
16
17
#ifndef MUELU_PERMUTATIONFACTORY_DECL_HPP_
18
#define MUELU_PERMUTATIONFACTORY_DECL_HPP_
19
20
#include <Xpetra_Map_fwd.hpp>
21
#include <Xpetra_Matrix_fwd.hpp>
22
23
#include "
MueLu_ConfigDefs.hpp
"
24
#include "
MueLu_SingleLevelFactoryBase.hpp
"
25
26
#include "
MueLu_AlgebraicPermutationStrategy_fwd.hpp
"
27
#include "
MueLu_LocalPermutationStrategy_fwd.hpp
"
28
29
namespace
MueLu
{
30
37
38
template
<
class
Scalar
=
DefaultScalar
,
39
class
LocalOrdinal
=
DefaultLocalOrdinal
,
40
class
GlobalOrdinal
=
DefaultGlobalOrdinal
,
41
class
Node
=
DefaultNode
>
42
class
PermutationFactory
:
public
SingleLevelFactoryBase
{
43
#undef MUELU_PERMUTATIONFACTORY_SHORT
44
#include "
MueLu_UseShortNames.hpp
"
45
46
public
:
48
49
51
PermutationFactory
();
52
54
virtual
~PermutationFactory
();
55
57
58
RCP<const ParameterList>
GetValidParameterList
()
const
;
59
61
62
68
void
DeclareInput
(
Level
¤tLevel)
const
;
69
71
73
74
76
void
Build
(
Level
¤tLevel)
const
;
77
79
80
private
:
81
};
// class PermutationFactory
82
83
}
// namespace MueLu
84
85
#define MUELU_PERMUTATIONFACTORY_SHORT
86
87
#endif
/* MUELU_PERMUTATIONFACTORY_DECL_HPP_ */
MueLu_AlgebraicPermutationStrategy_fwd.hpp
MueLu_ConfigDefs.hpp
MueLu_LocalPermutationStrategy_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::PermutationFactory::PermutationFactory
PermutationFactory()
Constructor.
Definition
MueLu_PermutationFactory_def.hpp:46
MueLu::PermutationFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition
MueLu_PermutationFactory_def.hpp:52
MueLu::PermutationFactory::DeclareInput
void DeclareInput(Level ¤tLevel) const
Specifies the data that this class needs, and the factories that generate that data.
Definition
MueLu_PermutationFactory_def.hpp:66
MueLu::PermutationFactory::Build
void Build(Level ¤tLevel) const
Build an object with this factory.
Definition
MueLu_PermutationFactory_def.hpp:79
MueLu::PermutationFactory::~PermutationFactory
virtual ~PermutationFactory()
Destructor.
Definition
MueLu_PermutationFactory_def.hpp:49
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
Utils
MueLu_PermutationFactory_decl.hpp
Generated by
1.17.0