MueLu
Version of the Day
MueLu_SegregatedAFactory_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@sandia.gov)
43
//
44
// ***********************************************************************
45
//
46
// @HEADER
47
#ifndef MUELU_SEGREGATEDAFACTORY_DECL_HPP
48
#define MUELU_SEGREGATEDAFACTORY_DECL_HPP
49
50
#include "
MueLu_ConfigDefs.hpp
"
51
#include "
MueLu_SegregatedAFactory_fwd.hpp
"
52
53
#include "
MueLu_GraphBase.hpp
"
54
#include "
MueLu_Level_fwd.hpp
"
55
#include "
MueLu_SingleLevelFactoryBase.hpp
"
56
57
namespace
MueLu
{
58
73
template
<
class
Scalar =
double
,
class
LocalOrdinal =
int
,
class
GlobalOrdinal = LocalOrdinal,
class
Node = KokkosClassic::DefaultNode::DefaultNodeType>
74
class
SegregatedAFactory
:
public
SingleLevelFactoryBase
{
75
#undef MUELU_SEGREGATEDAFACTORY_SHORT
76
#include "
MueLu_UseShortNames.hpp
"
77
78
public
:
79
81
82
83
SegregatedAFactory
() { }
84
86
virtual
~SegregatedAFactory
() { }
87
88
RCP<const ParameterList>
GetValidParameterList
()
const
;
89
91
93
94
95
void
DeclareInput
(
Level
& currentLevel)
const
;
96
98
100
101
107
void
Build
(
Level
& currentLevel)
const
;
108
110
111
};
//class SegregatedAFactory
112
113
}
//namespace MueLu
114
115
#define MUELU_SEGREGATEDAFACTORY_SHORT
116
#endif // MUELU_SEGREGATEDAFACTORY_DECL_HPP
MueLu_ConfigDefs.hpp
MueLu::SegregatedAFactory::~SegregatedAFactory
virtual ~SegregatedAFactory()
Destructor.
Definition:
MueLu_SegregatedAFactory_decl.hpp:86
MueLu_SegregatedAFactory_fwd.hpp
MueLu::SegregatedAFactory
Factory for building a new "segregated" A operator. Here, "segregated" means that the user provides a...
Definition:
MueLu_SegregatedAFactory_decl.hpp:74
MueLu_Level_fwd.hpp
MueLu
Namespace for MueLu classes and methods.
Definition:
MueLu_BrickAggregationFactory_decl.hpp:76
MueLu::SegregatedAFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition:
MueLu_SegregatedAFactory_def.hpp:63
MueLu::SegregatedAFactory::DeclareInput
void DeclareInput(Level ¤tLevel) const
Input.
Definition:
MueLu_SegregatedAFactory_def.hpp:78
MueLu_SingleLevelFactoryBase.hpp
MueLu::SegregatedAFactory::SegregatedAFactory
SegregatedAFactory()
Definition:
MueLu_SegregatedAFactory_decl.hpp:83
MueLu::SegregatedAFactory::Build
void Build(Level ¤tLevel) const
Build method.
Definition:
MueLu_SegregatedAFactory_def.hpp:95
MueLu::SingleLevelFactoryBase
Base class for factories that use one level (currentLevel).
Definition:
MueLu_SingleLevelFactoryBase.hpp:64
MueLu_UseShortNames.hpp
MueLu_GraphBase.hpp
MueLu::Level
Class that holds all level-specific information.
Definition:
MueLu_Level.hpp:99
src
Misc
MueLu_SegregatedAFactory_decl.hpp
Generated on Thu Feb 27 2020 16:06:46 for MueLu by
1.8.16