MueLu
Version of the Day
MueLu_MultiVectorTransferFactory_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_MULTIVECTORTRANSFER_FACTORY_DECL_HPP
47
#define MUELU_MULTIVECTORTRANSFER_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
#include "
MueLu_MultiVectorTransferFactory_fwd.hpp
"
55
56
namespace
MueLu
{
57
65
template
<
class
Scalar =
double
,
class
LocalOrdinal =
int
,
class
GlobalOrdinal = LocalOrdinal,
class
Node = KokkosClassic::DefaultNode::DefaultNodeType>
66
class
MultiVectorTransferFactory
:
public
TwoLevelFactoryBase
{
67
#undef MUELU_MULTIVECTORTRANSFERFACTORY_SHORT
68
#include "
MueLu_UseShortNames.hpp
"
69
70
public
:
72
73
82
MultiVectorTransferFactory
() { }
83
84
MultiVectorTransferFactory
(std::string
const
& vectorName);
// deprecated
85
87
virtual
~MultiVectorTransferFactory
() { }
88
89
RCP<const ParameterList>
GetValidParameterList
()
const
;
90
92
94
95
101
void
DeclareInput
(
Level
&finelevel,
Level
&coarseLevel)
const
;
102
104
106
107
109
void
Build
(
Level
& fineLevel,
Level
&coarseLevel)
const
;
110
112
113
private
:
114
115
static
ArrayRCP<SC>
expandCoordinates
(
ArrayRCP<SC>
coord, LocalOrdinal blksize);
116
117
};
// class MultiVectorTransferFactory
118
119
}
// namespace MueLu
120
121
#define MUELU_MULTIVECTORTRANSFERFACTORY_SHORT
122
#endif // MUELU_MULTIVECTORTRANSFER_FACTORY_DECL_HPP
MueLu_ConfigDefs.hpp
MueLu_TwoLevelFactoryBase.hpp
MueLu::MultiVectorTransferFactory
Class for restricting a MultiVector from a finer to a coarser level.
Definition:
MueLu_MultiVectorTransferFactory_decl.hpp:66
Xpetra_MultiVector_fwd.hpp
MueLu
Namespace for MueLu classes and methods.
Definition:
MueLu_BrickAggregationFactory_decl.hpp:76
MueLu::MultiVectorTransferFactory::Build
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
Definition:
MueLu_MultiVectorTransferFactory_def.hpp:83
Teuchos::RCP
MueLu::MultiVectorTransferFactory::expandCoordinates
static ArrayRCP< SC > expandCoordinates(ArrayRCP< SC > coord, LocalOrdinal blksize)
Definition:
MueLu_MultiVectorTransferFactory_def.hpp:109
Teuchos::ArrayRCP
MueLu::MultiVectorTransferFactory::DeclareInput
void DeclareInput(Level &finelevel, Level &coarseLevel) const
Specifies the data that this class needs, and the factories that generate that data.
Definition:
MueLu_MultiVectorTransferFactory_def.hpp:74
MueLu::MultiVectorTransferFactory::~MultiVectorTransferFactory
virtual ~MultiVectorTransferFactory()
Destructor.
Definition:
MueLu_MultiVectorTransferFactory_decl.hpp:87
MueLu::TwoLevelFactoryBase
Base class for factories that use two levels (fineLevel and coarseLevel).
Definition:
MueLu_TwoLevelFactoryBase.hpp:67
MueLu_MultiVectorTransferFactory_fwd.hpp
MueLu_UseShortNames.hpp
MueLu::MultiVectorTransferFactory::GetValidParameterList
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Definition:
MueLu_MultiVectorTransferFactory_def.hpp:58
Xpetra_MultiVectorFactory_fwd.hpp
MueLu::Level
Class that holds all level-specific information.
Definition:
MueLu_Level.hpp:99
Xpetra_Matrix.hpp
MueLu::MultiVectorTransferFactory::MultiVectorTransferFactory
MultiVectorTransferFactory()
Constructor.
Definition:
MueLu_MultiVectorTransferFactory_decl.hpp:82
src
Misc
MueLu_MultiVectorTransferFactory_decl.hpp
Generated by
1.8.16