Stokhos Package Browser (Single Doxygen Collection)
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
src
epetra
Stokhos_EpetraMultiVectorOperator.cpp
Go to the documentation of this file.
1
// $Id$
2
// $Source$
3
// @HEADER
4
// ***********************************************************************
5
//
6
// Stokhos Package
7
// Copyright (2009) Sandia Corporation
8
//
9
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
10
// license for use of this work by or on behalf of the U.S. Government.
11
//
12
// Redistribution and use in source and binary forms, with or without
13
// modification, are permitted provided that the following conditions are
14
// met:
15
//
16
// 1. Redistributions of source code must retain the above copyright
17
// notice, this list of conditions and the following disclaimer.
18
//
19
// 2. Redistributions in binary form must reproduce the above copyright
20
// notice, this list of conditions and the following disclaimer in the
21
// documentation and/or other materials provided with the distribution.
22
//
23
// 3. Neither the name of the Corporation nor the names of the
24
// contributors may be used to endorse or promote products derived from
25
// this software without specific prior written permission.
26
//
27
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38
//
39
// Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
40
//
41
// ***********************************************************************
42
// @HEADER
43
44
#include "
Stokhos_EpetraMultiVectorOperator.hpp
"
45
#include "
Epetra_Vector.h
"
46
#include "
Epetra_LocalMap.h
"
47
48
Stokhos::EpetraMultiVectorOperator::
49
EpetraMultiVectorOperator
(
50
const
Teuchos::RCP<const Epetra_MultiVector>& multi_vec_,
51
bool
is_multi_vec_transposed_)
52
:
label
(
"Epetra MultiVector Operator"
),
53
multi_vec
(multi_vec_),
54
nonconst_multi_vec
(),
55
is_multi_vec_transposed
(is_multi_vec_transposed_),
56
useTranspose
(
is_multi_vec_transposed
),
57
domain_map
()
58
{
59
domain_map
= Teuchos::rcp(
new
Epetra_LocalMap
(
multi_vec
->NumVectors(), 0,
60
multi_vec
->Map().Comm()));
61
}
62
63
Stokhos::EpetraMultiVectorOperator::
64
EpetraMultiVectorOperator
(
65
const
Teuchos::RCP<Epetra_MultiVector>& multi_vec_,
66
bool
is_multi_vec_transposed_)
67
:
label
(
"Epetra MultiVector Operator"
),
68
multi_vec
(multi_vec_),
69
nonconst_multi_vec
(multi_vec_),
70
is_multi_vec_transposed
(is_multi_vec_transposed_),
71
useTranspose
(
is_multi_vec_transposed
),
72
domain_map
()
73
{
74
domain_map
= Teuchos::rcp(
new
Epetra_LocalMap
(
multi_vec
->NumVectors(), 0,
75
multi_vec
->Map().Comm()));
76
}
77
78
Stokhos::EpetraMultiVectorOperator::
79
~EpetraMultiVectorOperator
()
80
{
81
}
82
83
int
84
Stokhos::EpetraMultiVectorOperator::
85
SetUseTranspose
(
bool
UseTranspose
)
86
{
87
if
(
is_multi_vec_transposed
)
88
useTranspose
= !
UseTranspose
;
89
else
90
useTranspose
=
UseTranspose
;
91
92
return
0;
93
}
94
95
int
96
Stokhos::EpetraMultiVectorOperator::
97
Apply
(
const
Epetra_MultiVector
& Input,
Epetra_MultiVector
& Result)
const
98
{
99
char
trans =
'N'
;
100
if
(
useTranspose
)
101
trans =
'T'
;
102
103
int
ret = Result.
Multiply
(trans,
'N'
, 1.0, *
multi_vec
, Input, 0.0);
104
TEUCHOS_TEST_FOR_EXCEPTION(ret != 0, std::logic_error,
105
"Error! Stokhos::EpetraMultiVectorOperator: "
<<
106
"Result.Multiply() returned "
<< ret <<
"!"
);
107
108
return
ret;
109
}
110
111
int
112
Stokhos::EpetraMultiVectorOperator::
113
ApplyInverse
(
const
Epetra_MultiVector
& Input,
114
Epetra_MultiVector
& Result)
const
115
{
116
throw
"EpetraMultiVectorOperator::ApplyInverse not defined!"
;
117
return
-1;
118
}
119
120
double
121
Stokhos::EpetraMultiVectorOperator::
122
NormInf
()
const
123
{
124
// ||A||_inf = || (|A_1| + ... + |A_n|) ||_inf where A_i is the i-th column
125
// of the multi-vector A
126
Epetra_Vector
tmp1(
multi_vec
->Map());
127
Epetra_Vector
tmp2(
multi_vec
->Map());
128
for
(
int
j
=0;
j
<
multi_vec
->NumVectors();
j
++) {
129
tmp1.
Abs
(*((*
multi_vec
)(
j
)));
130
tmp2.
Update
(1.0, tmp1, 1.0);
131
}
132
double
nrm;
133
tmp2.
NormInf
(&nrm);
134
135
return
nrm;
136
}
137
138
139
const
char
*
140
Stokhos::EpetraMultiVectorOperator::
141
Label
()
const
142
{
143
return
const_cast<
char
*
>
(
label
.c_str());
144
}
145
146
bool
147
Stokhos::EpetraMultiVectorOperator::
148
UseTranspose
()
const
149
{
150
if
(
is_multi_vec_transposed
)
151
return
!
useTranspose
;
152
return
useTranspose
;
153
}
154
155
bool
156
Stokhos::EpetraMultiVectorOperator::
157
HasNormInf
()
const
158
{
159
return
true
;
160
}
161
162
const
Epetra_Comm
&
163
Stokhos::EpetraMultiVectorOperator::
164
Comm
()
const
165
{
166
return
domain_map
->Comm();
167
}
168
const
Epetra_Map
&
169
Stokhos::EpetraMultiVectorOperator::
170
OperatorDomainMap
()
const
171
{
172
if
(
useTranspose
)
173
return
dynamic_cast<
const
Epetra_Map
&
>
(
multi_vec
->Map());
174
return
*
domain_map
;
175
}
176
177
const
Epetra_Map
&
178
Stokhos::EpetraMultiVectorOperator::
179
OperatorRangeMap
()
const
180
{
181
if
(
useTranspose
)
182
return
*
domain_map
;
183
return
dynamic_cast<
const
Epetra_Map
&
>
(
multi_vec
->Map());
184
}
Epetra_LocalMap.h
Epetra_Vector.h
j
j
Definition
Sacado_Fad_Exp_MP_Vector.hpp:527
Stokhos_EpetraMultiVectorOperator.hpp
Epetra_Comm
Epetra_LocalMap
Epetra_Map
Epetra_MultiVector
Epetra_MultiVector::NormInf
int NormInf(double *Result) const
Epetra_MultiVector::Abs
int Abs(const Epetra_MultiVector &A)
Epetra_MultiVector::Multiply
int Multiply(char TransA, char TransB, double ScalarAB, const Epetra_MultiVector &A, const Epetra_MultiVector &B, double ScalarThis)
Epetra_MultiVector::Update
int Update(double ScalarA, const Epetra_MultiVector &A, double ScalarThis)
Epetra_Vector
Stokhos::EpetraMultiVectorOperator::ApplyInverse
virtual int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of the inverse of the operator applied to a Epetra_MultiVector Input in Result as ...
Definition
Stokhos_EpetraMultiVectorOperator.cpp:113
Stokhos::EpetraMultiVectorOperator::useTranspose
bool useTranspose
Flag indicating whether transpose was selected.
Definition
Stokhos_EpetraMultiVectorOperator.hpp:164
Stokhos::EpetraMultiVectorOperator::label
std::string label
Label for operator.
Definition
Stokhos_EpetraMultiVectorOperator.hpp:152
Stokhos::EpetraMultiVectorOperator::UseTranspose
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
Definition
Stokhos_EpetraMultiVectorOperator.cpp:148
Stokhos::EpetraMultiVectorOperator::Comm
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
Definition
Stokhos_EpetraMultiVectorOperator.cpp:164
Stokhos::EpetraMultiVectorOperator::OperatorRangeMap
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
Definition
Stokhos_EpetraMultiVectorOperator.cpp:179
Stokhos::EpetraMultiVectorOperator::multi_vec
Teuchos::RCP< const Epetra_MultiVector > multi_vec
Multi-vector.
Definition
Stokhos_EpetraMultiVectorOperator.hpp:155
Stokhos::EpetraMultiVectorOperator::NormInf
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
Definition
Stokhos_EpetraMultiVectorOperator.cpp:122
Stokhos::EpetraMultiVectorOperator::HasNormInf
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Definition
Stokhos_EpetraMultiVectorOperator.cpp:157
Stokhos::EpetraMultiVectorOperator::SetUseTranspose
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
Definition
Stokhos_EpetraMultiVectorOperator.cpp:85
Stokhos::EpetraMultiVectorOperator::nonconst_multi_vec
Teuchos::RCP< Epetra_MultiVector > nonconst_multi_vec
Non-const multi-vector.
Definition
Stokhos_EpetraMultiVectorOperator.hpp:158
Stokhos::EpetraMultiVectorOperator::~EpetraMultiVectorOperator
virtual ~EpetraMultiVectorOperator()
Destructor.
Definition
Stokhos_EpetraMultiVectorOperator.cpp:79
Stokhos::EpetraMultiVectorOperator::is_multi_vec_transposed
bool is_multi_vec_transposed
Whether the multivector is already transposed.
Definition
Stokhos_EpetraMultiVectorOperator.hpp:161
Stokhos::EpetraMultiVectorOperator::OperatorDomainMap
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator.
Definition
Stokhos_EpetraMultiVectorOperator.cpp:170
Stokhos::EpetraMultiVectorOperator::domain_map
Teuchos::RCP< Epetra_Map > domain_map
Domain map ( = number of columns of multi_vec).
Definition
Stokhos_EpetraMultiVectorOperator.hpp:167
Stokhos::EpetraMultiVectorOperator::Apply
virtual int Apply(const Epetra_MultiVector &Input, Epetra_MultiVector &Result) const
Returns the result of a Epetra_Operator applied to a Epetra_MultiVector Input in Result as described ...
Definition
Stokhos_EpetraMultiVectorOperator.cpp:97
Stokhos::EpetraMultiVectorOperator::Label
virtual const char * Label() const
Returns a character string describing the operator.
Definition
Stokhos_EpetraMultiVectorOperator.cpp:141
Stokhos::EpetraMultiVectorOperator::EpetraMultiVectorOperator
EpetraMultiVectorOperator(const Teuchos::RCP< const Epetra_MultiVector > &multi_vec, bool is_multi_vec_transposed)
Constructor.
Definition
Stokhos_EpetraMultiVectorOperator.cpp:49
Generated by
1.17.0