MueLu
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
MueLu_RebalanceBlockAcFactory_decl.hpp
Go to the documentation of this file.
1
// @HEADER
2
//
3
// ***********************************************************************
4
//
5
// MueLu: A package for multigrid based preconditioning
6
// Copyright 2012 Sandia Corporation
7
//
8
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9
// the U.S. Government retains certain rights in this software.
10
//
11
// Redistribution and use in source and binary forms, with or without
12
// modification, are permitted provided that the following conditions are
13
// met:
14
//
15
// 1. Redistributions of source code must retain the above copyright
16
// notice, this list of conditions and the following disclaimer.
17
//
18
// 2. Redistributions in binary form must reproduce the above copyright
19
// notice, this list of conditions and the following disclaimer in the
20
// documentation and/or other materials provided with the distribution.
21
//
22
// 3. Neither the name of the Corporation nor the names of the
23
// contributors may be used to endorse or promote products derived from
24
// this software without specific prior written permission.
25
//
26
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37
//
38
// Questions? Contact
39
// Jonathan Hu (jhu@sandia.gov)
40
// Andrey Prokopenko (aprokop@sandia.gov)
41
// Ray Tuminaro (rstumin@sandia.gov)
42
//
43
// ***********************************************************************
44
//
45
// @HEADER
46
47
#ifndef MUELU_REBALANCEBLOCKACFACTORY_DECL_HPP_
48
#define MUELU_REBALANCEBLOCKACFACTORY_DECL_HPP_
49
50
#include <Xpetra_Matrix_fwd.hpp>
51
#include <Xpetra_CrsMatrix_fwd.hpp>
52
#include <Xpetra_CrsMatrixWrap_fwd.hpp>
53
#include <Xpetra_MatrixFactory_fwd.hpp>
54
#include <Xpetra_Vector_fwd.hpp>
55
#include <Xpetra_MapExtractor_fwd.hpp>
56
#include <Xpetra_MapExtractorFactory_fwd.hpp>
57
58
#include "
MueLu_ConfigDefs.hpp
"
59
#include "
MueLu_RebalanceBlockAcFactory_fwd.hpp
"
60
61
#include "
MueLu_FactoryBase_fwd.hpp
"
62
#include "
MueLu_FactoryManager_fwd.hpp
"
63
#include "
MueLu_Level_fwd.hpp
"
64
#include "
MueLu_PerfUtils_fwd.hpp
"
65
#include "
MueLu_TwoLevelFactoryBase.hpp
"
66
#include "
MueLu_Types.hpp
"
67
68
namespace
MueLu
{
97
template
<
class
Scalar
=
DefaultScalar
,
98
class
LocalOrdinal
=
DefaultLocalOrdinal
,
99
class
GlobalOrdinal
=
DefaultGlobalOrdinal
,
100
class
Node
=
DefaultNode
>
101
class
RebalanceBlockAcFactory
:
public
TwoLevelFactoryBase
{
102
#undef MUELU_REBALANCEBLOCKACFACTORY_SHORT
103
#include "
MueLu_UseShortNames.hpp
"
104
public
:
106
107
108
RCP<const ParameterList>
GetValidParameterList
()
const
;
109
110
void
DeclareInput
(
Level
&fineLevel,
Level
&coarseLevel)
const
;
111
113
void
AddFactoryManager
(RCP<const FactoryManagerBase> FactManager);
115
117
118
void
Build
(
Level
&fineLevel,
Level
&coarseLevel)
const
;
120
122
127
void
AddRebalanceFactory
(
const
RCP<const FactoryBase>& factory);
128
130
size_t
NumRebalanceFactories
()
const
{
return
rebalanceFacts_
.size(); }
131
133
134
private
:
136
std::vector<RCP<const FactoryBase> >
rebalanceFacts_
;
137
139
std::vector<Teuchos::RCP<const FactoryManagerBase> >
FactManager_
;
140
141
};
//class RebalanceAcFactory
142
143
}
//namespace MueLu
144
145
#define MUELU_REBALANCEBLOCKACFACTORY_SHORT
146
147
#endif
/* MUELU_REBALANCEBLOCKACFACTORY_DECL_HPP_ */
MueLu_ConfigDefs.hpp
MueLu_FactoryBase_fwd.hpp
MueLu_FactoryManager_fwd.hpp
MueLu_Level_fwd.hpp
MueLu_PerfUtils_fwd.hpp
MueLu_RebalanceBlockAcFactory_fwd.hpp
MueLu_TwoLevelFactoryBase.hpp
MueLu_Types.hpp
LocalOrdinal
MueLu::DefaultLocalOrdinal LocalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:50
Scalar
MueLu::DefaultScalar Scalar
Definition
MueLu_UseDefaultTypes.hpp:49
GlobalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Definition
MueLu_UseDefaultTypes.hpp:51
Node
MueLu::DefaultNode Node
Definition
MueLu_UseDefaultTypes.hpp:52
MueLu_UseShortNames.hpp
MueLu::Level
Class that holds all level-specific information.
Definition
MueLu_Level.hpp:99
MueLu::RebalanceBlockAcFactory
Definition
MueLu_RebalanceBlockAcFactory_decl.hpp:101
MueLu::RebalanceBlockAcFactory::AddFactoryManager
void AddFactoryManager(RCP< const FactoryManagerBase > FactManager)
Add a factory manager.
Definition
MueLu_RebalanceBlockAcFactory_def.hpp:88
MueLu::RebalanceBlockAcFactory::rebalanceFacts_
std::vector< RCP< const FactoryBase > > rebalanceFacts_
list of user-defined rebalancing Factories
Definition
MueLu_RebalanceBlockAcFactory_decl.hpp:136
MueLu::RebalanceBlockAcFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition
MueLu_RebalanceBlockAcFactory_def.hpp:73
MueLu::RebalanceBlockAcFactory::DeclareInput
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Definition
MueLu_RebalanceBlockAcFactory_def.hpp:93
MueLu::RebalanceBlockAcFactory::Build
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
Definition
MueLu_RebalanceBlockAcFactory_def.hpp:112
MueLu::RebalanceBlockAcFactory::NumRebalanceFactories
size_t NumRebalanceFactories() const
Returns number of transfer factories.
Definition
MueLu_RebalanceBlockAcFactory_decl.hpp:130
MueLu::RebalanceBlockAcFactory::AddRebalanceFactory
void AddRebalanceFactory(const RCP< const FactoryBase > &factory)
Add rebalancing factory in the end of list of rebalancing factories in RebalanceAcFactory.
Definition
MueLu_RebalanceBlockAcFactory_def.hpp:419
MueLu::RebalanceBlockAcFactory::FactManager_
std::vector< Teuchos::RCP< const FactoryManagerBase > > FactManager_
Input factories.
Definition
MueLu_RebalanceBlockAcFactory_decl.hpp:139
MueLu::TwoLevelFactoryBase::TwoLevelFactoryBase
TwoLevelFactoryBase()
Constructor.
Definition
MueLu_TwoLevelFactoryBase.hpp:75
MueLu
Namespace for MueLu classes and methods.
Definition
MueLu_BrickAggregationFactory_decl.hpp:78
MueLu::DefaultNode
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Definition
MueLu_Details_DefaultTypes.hpp:70
MueLu::DefaultGlobalOrdinal
int DefaultGlobalOrdinal
Definition
MueLu_Details_DefaultTypes.hpp:67
MueLu::DefaultLocalOrdinal
int DefaultLocalOrdinal
Definition
MueLu_Details_DefaultTypes.hpp:60
MueLu::DefaultScalar
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar
Definition
MueLu_Details_DefaultTypes.hpp:58
src
Rebalancing
MueLu_RebalanceBlockAcFactory_decl.hpp
Generated by
1.17.0