MueLu
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
MueLu_LocalOrdinalTransferFactory_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_LOCALORDINALTRANSFER_FACTORY_DECL_HPP
11
#define MUELU_LOCALORDINALTRANSFER_FACTORY_DECL_HPP
12
13
#include "
MueLu_ConfigDefs.hpp
"
14
#include "
MueLu_TwoLevelFactoryBase.hpp
"
15
#include "Xpetra_MultiVector_fwd.hpp"
16
#include "Xpetra_CrsGraph_fwd.hpp"
17
18
#include "
MueLu_LocalOrdinalTransferFactory_fwd.hpp
"
19
20
namespace
MueLu
{
21
56
57
template
<
class
LocalOrdinal
=
DefaultLocalOrdinal
,
58
class
GlobalOrdinal
=
DefaultGlobalOrdinal
,
59
class
Node
=
DefaultNode
>
60
class
LocalOrdinalTransferFactory
:
public
TwoLevelFactoryBase
{
61
#undef MUELU_LOCALORDINALTRANSFERFACTORY_SHORT
62
#include "
MueLu_UseShortNamesOrdinal.hpp
"
63
64
public
:
66
67
68
// Default constructor is distabled
69
LocalOrdinalTransferFactory
() =
delete
;
70
79
LocalOrdinalTransferFactory
(
const
std::string &TransferVecName,
const
std::string &mode)
80
:
TransferVecName_
(TransferVecName) {
81
if
(mode ==
"classical"
)
82
useAggregatesMode_
=
false
;
83
else
84
useAggregatesMode_
=
true
;
85
}
86
88
virtual
~LocalOrdinalTransferFactory
() {}
89
90
RCP<const ParameterList>
GetValidParameterList
()
const
;
91
93
95
96
102
void
DeclareInput
(
Level
&finelevel,
Level
&coarseLevel)
const
;
103
105
107
108
110
void
Build
(
Level
&fineLevel,
Level
&coarseLevel)
const
;
111
113
114
private
:
115
void
BuildAggregates
(
Level
&fineLevel,
Level
&coarseLevel)
const
;
116
117
void
BuildFC
(
Level
&fineLevel,
Level
&coarseLevel)
const
;
118
120
bool
useAggregatesMode_
;
121
123
std::string
TransferVecName_
;
124
125
};
// class LocalOrdinalTransferFactory
126
127
}
// namespace MueLu
128
129
#define MUELU_LOCALORDINALTRANSFERFACTORY_SHORT
130
#endif
// MUELU_LOCALORDINALTRANSFER_FACTORY_DECL_HPP
MueLu_ConfigDefs.hpp
MueLu_LocalOrdinalTransferFactory_fwd.hpp
MueLu_TwoLevelFactoryBase.hpp
LocalOrdinal
MueLu::DefaultLocalOrdinal LocalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:13
GlobalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:14
Node
MueLu::DefaultNode Node
Definition
MueLu_UseDefaultTypes.hpp:15
MueLu_UseShortNamesOrdinal.hpp
MueLu::Level
Class that holds all level-specific information.
Definition
MueLu_Level.hpp:63
MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >::TransferVecName_
std::string TransferVecName_
Definition
MueLu_LocalOrdinalTransferFactory_decl.hpp:123
MueLu::LocalOrdinalTransferFactory::BuildFC
void BuildFC(Level &fineLevel, Level &coarseLevel) const
Definition
MueLu_LocalOrdinalTransferFactory_def.hpp:67
MueLu::LocalOrdinalTransferFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition
MueLu_LocalOrdinalTransferFactory_def.hpp:29
MueLu::LocalOrdinalTransferFactory::LocalOrdinalTransferFactory
LocalOrdinalTransferFactory(const std::string &TransferVecName, const std::string &mode)
Constructor.
Definition
MueLu_LocalOrdinalTransferFactory_decl.hpp:79
MueLu::LocalOrdinalTransferFactory::Build
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
Definition
MueLu_LocalOrdinalTransferFactory_def.hpp:59
MueLu::LocalOrdinalTransferFactory::BuildAggregates
void BuildAggregates(Level &fineLevel, Level &coarseLevel) const
Definition
MueLu_LocalOrdinalTransferFactory_def.hpp:149
MueLu::LocalOrdinalTransferFactory::DeclareInput
void DeclareInput(Level &finelevel, Level &coarseLevel) const
Specifies the data that this class needs, and the factories that generate that data.
Definition
MueLu_LocalOrdinalTransferFactory_def.hpp:41
MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >::useAggregatesMode_
bool useAggregatesMode_
Definition
MueLu_LocalOrdinalTransferFactory_decl.hpp:120
MueLu::LocalOrdinalTransferFactory::LocalOrdinalTransferFactory
LocalOrdinalTransferFactory()=delete
MueLu::LocalOrdinalTransferFactory::~LocalOrdinalTransferFactory
virtual ~LocalOrdinalTransferFactory()
Destructor.
Definition
MueLu_LocalOrdinalTransferFactory_decl.hpp:88
MueLu::TwoLevelFactoryBase::TwoLevelFactoryBase
TwoLevelFactoryBase()
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
src
Misc
MueLu_LocalOrdinalTransferFactory_decl.hpp
Generated by
1.17.0