MueLu
Version of the Day
MueLu_CoordinatesTransferFactory_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_COORDINATESTRANSFER_FACTORY_DECL_HPP
47
#define MUELU_COORDINATESTRANSFER_FACTORY_DECL_HPP
48
49
#include "
MueLu_ConfigDefs.hpp
"
50
#include "
MueLu_TwoLevelFactoryBase.hpp
"
51
#include "Xpetra_MultiVector_fwd.hpp"
52
#include "Xpetra_MultiVectorFactory_fwd.hpp"
53
#include "Xpetra_Matrix.hpp"
54
55
#include "
MueLu_CoarseMapFactory_fwd.hpp
"
56
#include "
MueLu_CoordinatesTransferFactory_fwd.hpp
"
57
#include "
MueLu_Utilities_fwd.hpp
"
58
59
namespace
MueLu
{
60
98
template
<
class
Scalar =
double
,
class
LocalOrdinal =
int
,
class
GlobalOrdinal = LocalOrdinal,
class
Node = KokkosClassic::DefaultNode::DefaultNodeType>
99
class
CoordinatesTransferFactory
:
public
TwoLevelFactoryBase
{
100
#undef MUELU_COORDINATESTRANSFERFACTORY_SHORT
101
#include "
MueLu_UseShortNames.hpp
"
102
103
public
:
105
106
115
CoordinatesTransferFactory
() { }
116
118
virtual
~CoordinatesTransferFactory
() { }
119
120
RCP<const ParameterList>
GetValidParameterList
()
const
;
121
123
125
126
132
void
DeclareInput
(
Level
&finelevel,
Level
&coarseLevel)
const
;
133
135
137
138
140
void
Build
(
Level
& fineLevel,
Level
&coarseLevel)
const
;
141
143
144
private
:
145
146
};
// class CoordinatesTransferFactory
147
148
}
// namespace MueLu
149
150
#define MUELU_COORDINATESTRANSFERFACTORY_SHORT
151
#endif // MUELU_COORDINATESTRANSFER_FACTORY_DECL_HPP
MueLu_ConfigDefs.hpp
MueLu::CoordinatesTransferFactory::~CoordinatesTransferFactory
virtual ~CoordinatesTransferFactory()
Destructor.
Definition:
MueLu_CoordinatesTransferFactory_decl.hpp:118
MueLu::CoordinatesTransferFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition:
MueLu_CoordinatesTransferFactory_def.hpp:65
MueLu_CoordinatesTransferFactory_fwd.hpp
MueLu_TwoLevelFactoryBase.hpp
MueLu::CoordinatesTransferFactory::CoordinatesTransferFactory
CoordinatesTransferFactory()
Constructor.
Definition:
MueLu_CoordinatesTransferFactory_decl.hpp:115
MueLu
Namespace for MueLu classes and methods.
Definition:
MueLu_BrickAggregationFactory_decl.hpp:76
MueLu_Utilities_fwd.hpp
MueLu::CoordinatesTransferFactory::DeclareInput
void DeclareInput(Level &finelevel, Level &coarseLevel) const
Specifies the data that this class needs, and the factories that generate that data.
Definition:
MueLu_CoordinatesTransferFactory_def.hpp:87
MueLu::TwoLevelFactoryBase
Base class for factories that use two levels (fineLevel and coarseLevel).
Definition:
MueLu_TwoLevelFactoryBase.hpp:67
MueLu::CoordinatesTransferFactory
Class for transferring coordinates from a finer level to a coarser one.
Definition:
MueLu_CoordinatesTransferFactory_decl.hpp:99
MueLu_UseShortNames.hpp
MueLu_CoarseMapFactory_fwd.hpp
MueLu::CoordinatesTransferFactory::Build
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
Definition:
MueLu_CoordinatesTransferFactory_def.hpp:117
MueLu::Level
Class that holds all level-specific information.
Definition:
MueLu_Level.hpp:99
src
Misc
MueLu_CoordinatesTransferFactory_decl.hpp
Generated on Thu Feb 27 2020 16:06:46 for MueLu by
1.8.16