MueLu
Version of the Day
Loading...
Searching...
No Matches
MueLu_PatternFactory_def.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_PATTERNFACTORY_DEF_HPP
47
#define MUELU_PATTERNFACTORY_DEF_HPP
48
49
#include <Xpetra_Matrix.hpp>
50
#include <Xpetra_MatrixMatrix.hpp>
51
52
#include "
MueLu_PatternFactory_decl.hpp
"
53
54
#include "
MueLu_MasterList.hpp
"
55
#include "
MueLu_Monitor.hpp
"
56
//#include "MueLu_Utilities.hpp"
57
58
namespace
MueLu
{
59
60
template
<
class
Scalar,
class
LocalOrdinal,
class
GlobalOrdinal,
class
Node>
61
RCP<const ParameterList>
PatternFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::GetValidParameterList
()
const
{
62
RCP<ParameterList> validParamList = rcp(
new
ParameterList());
63
64
#define SET_VALID_ENTRY(name) validParamList->setEntry(name, MasterList::getEntry(name))
65
SET_VALID_ENTRY
(
"emin: pattern order"
);
66
#undef SET_VALID_ENTRY
67
68
validParamList->set< RCP<const FactoryBase> >(
"A"
, Teuchos::null,
"Generating factory for the matrix"
);
69
validParamList->set< RCP<const FactoryBase> >(
"P"
, Teuchos::null,
"Generating factory for the matrix providing nonzero graph"
);
70
71
return
validParamList;
72
}
73
74
template
<
class
Scalar,
class
LocalOrdinal,
class
GlobalOrdinal,
class
Node>
75
void
PatternFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::DeclareInput
(
Level
& fineLevel,
Level
& coarseLevel)
const
{
76
Input(coarseLevel,
"P"
);
77
78
const
ParameterList& pL = GetParameterList();
79
if
(pL.get<
int
>(
"emin: pattern order"
) > 0)
80
Input(fineLevel,
"A"
);
81
}
82
83
template
<
class
Scalar,
class
LocalOrdinal,
class
GlobalOrdinal,
class
Node>
84
void
PatternFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node>::Build
(
Level
& fineLevel,
Level
& coarseLevel)
const
{
85
FactoryMonitor
m(*
this
,
"Ppattern"
, coarseLevel);
86
87
RCP<Matrix> P = Get< RCP<Matrix> >(coarseLevel,
"P"
);
88
89
const
ParameterList& pL = GetParameterList();
90
int
k = pL.get<
int
>(
"emin: pattern order"
);
91
92
if
(k > 0) {
93
RCP<Matrix> A = Get< RCP<Matrix> >(fineLevel,
"A"
);
94
RCP<Matrix> AP;
95
96
bool
doFillComplete =
true
;
97
bool
optimizeStorage =
true
;
98
99
for
(
int
i = 0; i < k; i++) {
100
AP = Xpetra::MatrixMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::Multiply(*A,
false
, *P,
false
, GetOStream(
Statistics2
), doFillComplete, optimizeStorage);
101
P.swap(AP);
102
}
103
}
104
105
Set(coarseLevel,
"Ppattern"
, P->getCrsGraph());
106
}
107
108
109
}
// namespace MueLu
110
111
#endif
// MUELU_PATTERNFACTORY_DEF_HPP
SET_VALID_ENTRY
#define SET_VALID_ENTRY(name)
MueLu_MasterList.hpp
MueLu_Monitor.hpp
MueLu_PatternFactory_decl.hpp
MueLu::FactoryMonitor
Timer to be used in factories. Similar to Monitor but with additional timers.
Definition
MueLu_Monitor.hpp:209
MueLu::Level
Class that holds all level-specific information.
Definition
MueLu_Level.hpp:99
MueLu::PatternFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition
MueLu_PatternFactory_def.hpp:61
MueLu::PatternFactory::DeclareInput
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Definition
MueLu_PatternFactory_def.hpp:75
MueLu::PatternFactory::Build
void Build(Level &fineLevel, Level &coarseLevel) const
Build method.
Definition
MueLu_PatternFactory_def.hpp:84
MueLu
Namespace for MueLu classes and methods.
Definition
MueLu_BrickAggregationFactory_decl.hpp:78
MueLu::Statistics2
@ Statistics2
Print even more statistics.
Definition
MueLu_VerbosityLevel.hpp:72
src
Transfers
Energy-Minimization
MueLu_PatternFactory_def.hpp
Generated by
1.10.0