Belos
Version of the Day
src
BelosOperatorT.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 BELOS_OPERATORT_HPP
47
#define BELOS_OPERATORT_HPP
48
49
#include "
BelosOperatorTraits.hpp
"
50
51
namespace
Belos
{
52
// Base class for the Belos OP template type. Similar to Belos::Operator<> but this one deals with any kind of vector (not only Belos::MultiVec as the Belos::Operator interface)
53
template
<
class
MV>
54
class
OperatorT
{
55
56
public
:
57
59
60
62
OperatorT
() {};
63
65
virtual
~OperatorT
() {};
67
69
70
76
virtual
void
Apply
(
const
MV & x, MV & y,
ETrans
trans=
NOTRANS
)
const
= 0;
77
};
78
86
template
<
class
ScalarType,
class
MV>
87
class
OperatorTraits
<ScalarType, MV,
OperatorT
<MV> >
88
{
89
90
public
:
92
static
void
Apply
(
const
OperatorT<MV>
& Op,
93
const
MV& x,
94
MV& y,
ETrans
trans=
NOTRANS
) {
95
Op.
Apply
(x, y, trans);
96
}
97
};
98
99
}
// namespace Belos
100
101
#endif // BELOS_OPERATORT_HPP
Belos::OperatorT::~OperatorT
virtual ~OperatorT()
Destructor.
Definition:
BelosOperatorT.hpp:65
Belos::OperatorTraits
Class which defines basic traits for the operator type.
Definition:
BelosOperatorTraits.hpp:109
Belos::OperatorT
Definition:
BelosOperatorT.hpp:54
Belos::ETrans
ETrans
Whether to apply the (conjugate) transpose of an operator.
Definition:
BelosTypes.hpp:81
Belos
Definition:
Belos_Details_EBelosSolverType.cpp:45
Belos::OperatorT::Apply
virtual void Apply(const MV &x, MV &y, ETrans trans=NOTRANS) const =0
This routine takes the Belos::MultiVec x and applies the operator to it resulting in the Belos::Multi...
BelosOperatorTraits.hpp
Class which defines basic traits for the operator type.
Belos::NOTRANS
Definition:
BelosTypes.hpp:81
Belos::OperatorTraits< ScalarType, MV, OperatorT< MV > >::Apply
static void Apply(const OperatorT< MV > &Op, const MV &x, MV &y, ETrans trans=NOTRANS)
Specialization of Apply() for OperatorT.
Definition:
BelosOperatorT.hpp:92
Belos::OperatorT::OperatorT
OperatorT()
Default constructor.
Definition:
BelosOperatorT.hpp:62
Generated on Thu Feb 27 2020 16:06:46 for Belos by
1.8.16