MueLu
Version of the Day
MueLu_RebalanceTransferFactory_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
#ifndef MUELU_REBALANCETRANSFERFACTORY_DECL_HPP
47
#define MUELU_REBALANCETRANSFERFACTORY_DECL_HPP
48
49
#include <Xpetra_Matrix_fwd.hpp>
50
#include <Xpetra_MatrixFactory_fwd.hpp>
51
#include "Xpetra_Vector_fwd.hpp"
52
#include "Xpetra_VectorFactory_fwd.hpp"
53
#include "Xpetra_MultiVector_fwd.hpp"
54
#include "Xpetra_MultiVectorFactory_fwd.hpp"
55
#include "Xpetra_Import_fwd.hpp"
56
#include "Xpetra_ImportFactory_fwd.hpp"
57
58
#include "
MueLu_ConfigDefs.hpp
"
59
60
#include "
MueLu_RebalanceTransferFactory_fwd.hpp
"
61
62
#include "
MueLu_PerfUtils_fwd.hpp
"
63
#include "
MueLu_TwoLevelFactoryBase.hpp
"
64
#include "
MueLu_Types.hpp
"
65
#include "
MueLu_Utilities_fwd.hpp
"
66
67
namespace
MueLu
{
68
75
template
<
class
Scalar =
double
,
class
LocalOrdinal =
int
,
class
GlobalOrdinal = LocalOrdinal,
class
Node = KokkosClassic::DefaultNode::DefaultNodeType>
76
class
RebalanceTransferFactory
:
public
TwoLevelFactoryBase
{
77
#undef MUELU_REBALANCETRANSFERFACTORY_SHORT
78
#include "
MueLu_UseShortNames.hpp
"
79
80
public
:
82
83
85
RebalanceTransferFactory
() { }
86
88
virtual
~RebalanceTransferFactory
() { }
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
};
// class RebalanceTransferFactory
115
116
}
// namespace MueLu
117
118
#define MUELU_REBALANCETRANSFERFACTORY_SHORT
119
#endif // MUELU_REBALANCETRANSFERFACTORY_DECL_HPP
MueLu::RebalanceTransferFactory::DeclareInput
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Specifies the data that this class needs, and the factories that generate that data.
Definition:
MueLu_RebalanceTransferFactory_def.hpp:103
MueLu_ConfigDefs.hpp
MueLu::RebalanceTransferFactory::~RebalanceTransferFactory
virtual ~RebalanceTransferFactory()
Destructor.
Definition:
MueLu_RebalanceTransferFactory_decl.hpp:88
MueLu_TwoLevelFactoryBase.hpp
MueLu::RebalanceTransferFactory::Build
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
Definition:
MueLu_RebalanceTransferFactory_def.hpp:121
MueLu
Namespace for MueLu classes and methods.
Definition:
MueLu_BrickAggregationFactory_decl.hpp:76
MueLu_Types.hpp
MueLu_Utilities_fwd.hpp
MueLu::RebalanceTransferFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition:
MueLu_RebalanceTransferFactory_def.hpp:72
MueLu::TwoLevelFactoryBase
Base class for factories that use two levels (fineLevel and coarseLevel).
Definition:
MueLu_TwoLevelFactoryBase.hpp:67
MueLu_PerfUtils_fwd.hpp
MueLu_RebalanceTransferFactory_fwd.hpp
MueLu::RebalanceTransferFactory::RebalanceTransferFactory
RebalanceTransferFactory()
Constructor.
Definition:
MueLu_RebalanceTransferFactory_decl.hpp:85
MueLu_UseShortNames.hpp
MueLu::RebalanceTransferFactory
Applies permutation to grid transfer operators.
Definition:
MueLu_RebalanceTransferFactory_decl.hpp:76
MueLu::Level
Class that holds all level-specific information.
Definition:
MueLu_Level.hpp:99
src
Rebalancing
MueLu_RebalanceTransferFactory_decl.hpp
Generated on Thu Feb 27 2020 16:06:46 for MueLu by
1.8.16