MueLu
Version of the Day
MueLu_RepartitionHeuristicFactory_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
// Tobias Wiesner (tawiesn@sandai.gov)
43
//
44
// ***********************************************************************
45
//
46
// @HEADER
47
#ifndef PACKAGES_MUELU_SRC_REBALANCING_MUELU_REPARTITIONHEURISTICFACTORY_DECL_HPP_
48
#define PACKAGES_MUELU_SRC_REBALANCING_MUELU_REPARTITIONHEURISTICFACTORY_DECL_HPP_
49
50
#include "
MueLu_ConfigDefs.hpp
"
51
#ifdef HAVE_MPI
52
53
// Some classes are only used in the definition (_def.hpp) of this class
54
// but forward declarations are needed here to enable the UseShortNames mechanism.
55
#include <Xpetra_Map_fwd.hpp>
56
#include <Xpetra_MapFactory_fwd.hpp>
57
#include <Xpetra_Import_fwd.hpp>
58
#include <Xpetra_ImportFactory_fwd.hpp>
59
#include <Xpetra_Export_fwd.hpp>
60
#include <Xpetra_ExportFactory_fwd.hpp>
61
#include <Xpetra_Vector_fwd.hpp>
62
#include <Xpetra_Matrix_fwd.hpp>
63
#include <Xpetra_MatrixFactory_fwd.hpp>
64
65
#include "
MueLu_SingleLevelFactoryBase.hpp
"
66
#include "
MueLu_BlockedRAPFactory_fwd.hpp
"
67
#include "
MueLu_RAPFactory_fwd.hpp
"
68
#include "
MueLu_SubBlockAFactory_fwd.hpp
"
69
#include "
MueLu_RepartitionFactory_fwd.hpp
"
70
#include "
MueLu_Utilities_fwd.hpp
"
71
72
namespace
MueLu
{
73
118
template
<
class
Scalar =
double
,
class
LocalOrdinal =
int
,
class
GlobalOrdinal = LocalOrdinal,
class
Node = KokkosClassic::DefaultNode::DefaultNodeType>
119
class
RepartitionHeuristicFactory
:
public
SingleLevelFactoryBase
{
120
#undef MUELU_REPARTITIONHEURISTICFACTORY_SHORT
121
#include "
MueLu_UseShortNames.hpp
"
122
123
public
:
125
126
128
RepartitionHeuristicFactory
() { }
129
131
virtual
~RepartitionHeuristicFactory
() { }
132
133
RCP<const ParameterList>
GetValidParameterList
()
const
;
134
136
138
139
145
void
DeclareInput
(
Level
& currentLevel)
const
;
146
148
150
151
153
void
Build
(
Level
& currentLevel)
const
;
154
156
};
// class RepartitionHeuristicFactory
157
158
}
// namespace MueLu
159
160
#define MUELU_REPARTITIONHEURISTICFACTORY_SHORT
161
162
#endif //ifdef HAVE_MPI
163
#endif
/* PACKAGES_MUELU_SRC_REBALANCING_MUELU_REPARTITIONHEURISTICFACTORY_DECL_HPP_ */
MueLu_ConfigDefs.hpp
MueLu_RAPFactory_fwd.hpp
MueLu::RepartitionHeuristicFactory::RepartitionHeuristicFactory
RepartitionHeuristicFactory()
Constructor.
Definition:
MueLu_RepartitionHeuristicFactory_decl.hpp:128
MueLu::RepartitionHeuristicFactory::DeclareInput
void DeclareInput(Level ¤tLevel) const
Determines the data that RepartitionHeuristicFactory needs, and the factories that generate that data...
Definition:
MueLu_RepartitionHeuristicFactory_def.hpp:91
MueLu::RepartitionHeuristicFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition:
MueLu_RepartitionHeuristicFactory_def.hpp:75
MueLu::RepartitionHeuristicFactory::Build
void Build(Level ¤tLevel) const
Build an object with this factory.
Definition:
MueLu_RepartitionHeuristicFactory_def.hpp:96
MueLu
Namespace for MueLu classes and methods.
Definition:
MueLu_BrickAggregationFactory_decl.hpp:76
MueLu_SubBlockAFactory_fwd.hpp
MueLu::RepartitionHeuristicFactory::~RepartitionHeuristicFactory
virtual ~RepartitionHeuristicFactory()
Destructor.
Definition:
MueLu_RepartitionHeuristicFactory_decl.hpp:131
MueLu_BlockedRAPFactory_fwd.hpp
MueLu_RepartitionFactory_fwd.hpp
MueLu_SingleLevelFactoryBase.hpp
MueLu_Utilities_fwd.hpp
MueLu::RepartitionHeuristicFactory
Factory for determing the number of partitions for rebalancing.
Definition:
MueLu_RepartitionHeuristicFactory_decl.hpp:119
MueLu::SingleLevelFactoryBase
Base class for factories that use one level (currentLevel).
Definition:
MueLu_SingleLevelFactoryBase.hpp:64
MueLu_UseShortNames.hpp
MueLu::Level
Class that holds all level-specific information.
Definition:
MueLu_Level.hpp:99
src
Rebalancing
MueLu_RepartitionHeuristicFactory_decl.hpp
Generated on Thu Feb 27 2020 16:06:46 for MueLu by
1.8.16