MueLu
Version of the Day
MueLu_EminPFactory_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_EMINPFACTORY_DECL_HPP
47
#define MUELU_EMINPFACTORY_DECL_HPP
48
49
#include "
MueLu_ConfigDefs.hpp
"
50
51
#include <Xpetra_Matrix_fwd.hpp>
52
#include <Xpetra_StridedMapFactory_fwd.hpp>
53
54
#include "
MueLu_EminPFactory_fwd.hpp
"
55
56
#include "
MueLu_CGSolver_fwd.hpp
"
57
#include "
MueLu_Constraint_fwd.hpp
"
58
#include "
MueLu_GMRESSolver_fwd.hpp
"
59
#include "
MueLu_Level_fwd.hpp
"
60
#include "
MueLu_PerfUtils_fwd.hpp
"
61
#include "MueLu_PFactory.hpp"
62
#include "
MueLu_SolverBase_fwd.hpp
"
63
#include "
MueLu_SteepestDescentSolver_fwd.hpp
"
64
65
namespace
MueLu
{
66
73
template
<
class
Scalar =
double
,
class
LocalOrdinal =
int
,
class
GlobalOrdinal = LocalOrdinal,
class
Node = KokkosClassic::DefaultNode::DefaultNodeType>
74
class
EminPFactory
:
public
PFactory
{
75
#undef MUELU_EMINPFACTORY_SHORT
76
#include "
MueLu_UseShortNames.hpp
"
77
78
public
:
79
81
82
84
EminPFactory
() { }
85
87
virtual
~EminPFactory
() { }
88
90
91
RCP<const ParameterList>
GetValidParameterList
()
const
;
92
94
95
96
void
DeclareInput
(
Level
& fineLevel,
Level
& coarseLevel)
const
;
97
99
101
102
108
void
Build
(
Level
& fineLevel,
Level
& coarseLevel)
const
;
109
void
BuildP
(
Level
& fineLevel,
Level
& coarseLevel)
const
;
110
112
113
};
// class EminPFactory
114
115
}
// namespace MueLu
116
117
#define MUELU_EMINPFACTORY_SHORT
118
#endif // MUELU_EMINPFACTORY_DECL_HPP
MueLu_ConfigDefs.hpp
MueLu::EminPFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition:
MueLu_EminPFactory_def.hpp:24
MueLu_SteepestDescentSolver_fwd.hpp
MueLu::EminPFactory
Factory for building Energy Minimization prolongators.
Definition:
MueLu_EminPFactory_decl.hpp:74
MueLu::EminPFactory::BuildP
void BuildP(Level &fineLevel, Level &coarseLevel) const
Abstract Build method.
Definition:
MueLu_EminPFactory_def.hpp:87
MueLu_Level_fwd.hpp
MueLu::EminPFactory::Build
void Build(Level &fineLevel, Level &coarseLevel) const
Build method.
Definition:
MueLu_EminPFactory_def.hpp:82
MueLu
Namespace for MueLu classes and methods.
Definition:
MueLu_BrickAggregationFactory_decl.hpp:76
MueLu::EminPFactory::EminPFactory
EminPFactory()
Constructor.
Definition:
MueLu_EminPFactory_decl.hpp:84
MueLu::EminPFactory::~EminPFactory
virtual ~EminPFactory()
Destructor.
Definition:
MueLu_EminPFactory_decl.hpp:87
MueLu_Constraint_fwd.hpp
MueLu::EminPFactory::DeclareInput
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Definition:
MueLu_EminPFactory_def.hpp:52
MueLu_GMRESSolver_fwd.hpp
MueLu_PerfUtils_fwd.hpp
MueLu_CGSolver_fwd.hpp
MueLu_EminPFactory_fwd.hpp
MueLu::PFactory
Factory that provides an interface for a concrete implementation of a prolongation operator.
Definition:
MueLu_PFactory_decl.hpp:64
MueLu_UseShortNames.hpp
MueLu_SolverBase_fwd.hpp
MueLu::Level
Class that holds all level-specific information.
Definition:
MueLu_Level.hpp:99
src
Transfers
Energy-Minimization
MueLu_EminPFactory_decl.hpp
Generated on Thu Feb 27 2020 16:06:46 for MueLu by
1.8.16