MueLu
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
MueLu_TogglePFactory_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_TOGGLEPFACTORY_DECL_HPP
11
#define MUELU_TOGGLEPFACTORY_DECL_HPP
12
13
#include "
MueLu_ConfigDefs.hpp
"
14
#include "
MueLu_TogglePFactory_fwd.hpp
"
15
16
#include "
MueLu_Level_fwd.hpp
"
17
#include "
MueLu_ParameterListAcceptor.hpp
"
18
#include "MueLu_PFactory.hpp"
19
20
namespace
MueLu
{
21
53
54
template
<
class
Scalar
=
DefaultScalar
,
55
class
LocalOrdinal
=
DefaultLocalOrdinal
,
56
class
GlobalOrdinal
=
DefaultGlobalOrdinal
,
57
class
Node
=
DefaultNode
>
58
class
TogglePFactory
:
public
PFactory
{
59
#undef MUELU_TOGGLEPFACTORY_SHORT
60
#include "
MueLu_UseShortNames.hpp
"
61
62
public
:
64
65
67
TogglePFactory
()
68
:
hasDeclaredInput_
(false) {}
69
71
virtual
~TogglePFactory
() {}
72
73
RCP<const ParameterList>
GetValidParameterList
()
const
;
74
76
78
79
80
void
DeclareInput
(
Level
&fineLevel,
Level
&coarseLevel)
const
;
81
83
85
86
88
void
Build
(
Level
&fineLevel,
Level
&coarseLevel)
const
;
89
90
void
BuildP
(
Level
&
/* fineLevel */
,
Level
&
/* coarseLevel */
)
const
{
/* empty */
};
92
94
96
void
AddProlongatorFactory
(
const
RCP<const FactoryBase> &factory);
97
99
size_t
NumProlongatorFactories
()
const
{
return
prolongatorFacts_
.size(); }
100
102
void
AddPtentFactory
(
const
RCP<const FactoryBase> &factory);
103
105
size_t
NumPtentFactories
()
const
{
return
ptentFacts_
.size(); }
106
108
void
AddCoarseNullspaceFactory
(
const
RCP<const FactoryBase> &factory);
109
111
size_t
NumCoarseNullspaceFactories
()
const
{
return
prolongatorFacts_
.size(); }
112
113
RCP<const FactoryBase>
getProlongatorFactory
(
size_t
t)
const
{
return
prolongatorFacts_
[t]; }
115
private
:
117
mutable
std::vector<RCP<const FactoryBase> >
prolongatorFacts_
;
118
120
mutable
std::vector<RCP<const FactoryBase> >
ptentFacts_
;
121
123
mutable
std::vector<RCP<const FactoryBase> >
nspFacts_
;
124
125
mutable
bool
hasDeclaredInput_
;
126
};
// class TogglePFactory
127
128
}
// namespace MueLu
129
130
#define MUELU_TOGGLEPFACTORY_SHORT
131
#endif
// MUELU_TOGGLEPFACTORY_DECL_HPP
MueLu_ConfigDefs.hpp
MueLu_Level_fwd.hpp
MueLu_ParameterListAcceptor.hpp
MueLu_TogglePFactory_fwd.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::PFactory::PFactory
PFactory()
Constructor.
Definition
MueLu_PFactory_decl.hpp:37
MueLu::TogglePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ptentFacts_
std::vector< RCP< const FactoryBase > > ptentFacts_
Definition
MueLu_TogglePFactory_decl.hpp:120
MueLu::TogglePFactory::getProlongatorFactory
RCP< const FactoryBase > getProlongatorFactory(size_t t) const
Definition
MueLu_TogglePFactory_decl.hpp:113
MueLu::TogglePFactory::NumCoarseNullspaceFactories
size_t NumCoarseNullspaceFactories() const
Returns number of coarse null space factories.
Definition
MueLu_TogglePFactory_decl.hpp:111
MueLu::TogglePFactory::NumPtentFactories
size_t NumPtentFactories() const
Returns number of tentative prolongator factories.
Definition
MueLu_TogglePFactory_decl.hpp:105
MueLu::TogglePFactory::NumProlongatorFactories
size_t NumProlongatorFactories() const
Returns number of prolongator factories.
Definition
MueLu_TogglePFactory_decl.hpp:99
MueLu::TogglePFactory::BuildP
void BuildP(Level &, Level &) const
Abstract Build method.
Definition
MueLu_TogglePFactory_decl.hpp:90
MueLu::TogglePFactory::AddCoarseNullspaceFactory
void AddCoarseNullspaceFactory(const RCP< const FactoryBase > &factory)
Add a coarse nullspace factory in the end of list of coarse nullspace factories.
Definition
MueLu_TogglePFactory_def.hpp:166
MueLu::TogglePFactory::AddProlongatorFactory
void AddProlongatorFactory(const RCP< const FactoryBase > &factory)
Add a prolongator factory in the end of list of prolongator factories.
Definition
MueLu_TogglePFactory_def.hpp:146
MueLu::TogglePFactory::AddPtentFactory
void AddPtentFactory(const RCP< const FactoryBase > &factory)
Add a tentative prolongator factory in the end of list of prolongator factories.
Definition
MueLu_TogglePFactory_def.hpp:156
MueLu::TogglePFactory::DeclareInput
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Definition
MueLu_TogglePFactory_def.hpp:36
MueLu::TogglePFactory::TogglePFactory
TogglePFactory()
Constructor.
Definition
MueLu_TogglePFactory_decl.hpp:67
MueLu::TogglePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::prolongatorFacts_
std::vector< RCP< const FactoryBase > > prolongatorFacts_
Definition
MueLu_TogglePFactory_decl.hpp:117
MueLu::TogglePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nspFacts_
std::vector< RCP< const FactoryBase > > nspFacts_
Definition
MueLu_TogglePFactory_decl.hpp:123
MueLu::TogglePFactory::~TogglePFactory
virtual ~TogglePFactory()
Destructor.
Definition
MueLu_TogglePFactory_decl.hpp:71
MueLu::TogglePFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition
MueLu_TogglePFactory_def.hpp:24
MueLu::TogglePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasDeclaredInput_
bool hasDeclaredInput_
Definition
MueLu_TogglePFactory_decl.hpp:125
MueLu::TogglePFactory::Build
void Build(Level &fineLevel, Level &coarseLevel) const
Build method.
Definition
MueLu_TogglePFactory_def.hpp:66
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
SemiCoarsen
MueLu_TogglePFactory_decl.hpp
Generated by
1.17.0