Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_DiagonalFilter_def.hpp
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
5 // Copyright (2009) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 */
42 
43 #ifndef IFPACK2_DIAGONALFILTER_DEF_HPP
44 #define IFPACK2_DIAGONALFILTER_DEF_HPP
45 #include "Ifpack2_DiagonalFilter_decl.hpp"
46 #include <vector>
47 
48 #include "Teuchos_Comm.hpp"
49 #include "Tpetra_Map.hpp"
50 #include "Tpetra_MultiVector.hpp"
51 #include "Tpetra_Vector.hpp"
52 
53 
54 namespace Ifpack2 {
55 
56 template<class MatrixType>
58 DiagonalFilter (const Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >& Matrix,
59  typename Teuchos::ScalarTraits<Scalar>::magnitudeType AbsoluteThreshold,
60  typename Teuchos::ScalarTraits<Scalar>::magnitudeType RelativeThreshold):
61  A_(Matrix),
62  AbsoluteThreshold_(AbsoluteThreshold),
63  RelativeThreshold_(RelativeThreshold)
64 {
65  pos_.resize(getNodeNumRows());
66  val_=Teuchos::rcp(new Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>(A_->getRowMap()));
67 
68  std::vector<LocalOrdinal> Indices(getNodeMaxNumRowEntries());
69  std::vector<Scalar> Values(getNodeMaxNumRowEntries());
70  size_t NumEntries;
71  magnitudeType mysign;
72 
73 
74  for (size_t MyRow = 0 ; MyRow < getNodeNumRows() ; ++MyRow) {
75  pos_[MyRow] = -1;
76  A_->getLocalRowCopy(MyRow,Indices,Values,NumEntries);
77 
78  for (size_t i = 0 ; i < NumEntries ; ++i) {
79  if ((size_t)Indices[i] == MyRow) {
80  pos_[MyRow] = i;
81  if (Teuchos::ScalarTraits<Scalar>::real(Values[i]) < 0) {
82  mysign=-Teuchos::ScalarTraits<magnitudeType>::one();
83  }
84  else {
85  mysign=Teuchos::ScalarTraits<magnitudeType>::one();
86  }
87  val_->replaceLocalValue (MyRow, Values[i] * (RelativeThreshold_ - 1) +
88  AbsoluteThreshold_ * mysign);
89  break;
90  }
91  }
92  }
93 }
94 
95 template<class MatrixType>
97 
98 template<class MatrixType>
99 Teuchos::RCP<const Teuchos::Comm<int> > DiagonalFilter<MatrixType>::getComm() const
100 {
101  return A_->getComm();
102 }
103 
104 template<class MatrixType>
105 Teuchos::RCP <typename MatrixType::node_type> DiagonalFilter<MatrixType>::getNode() const
106 {
107  return A_->getNode();
108 }
109 
110 template<class MatrixType>
111 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
112  typename MatrixType::global_ordinal_type,
113  typename MatrixType::node_type> >
115 {
116  return A_->getRowMap();
117 }
118 
119 template<class MatrixType>
120 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
121  typename MatrixType::global_ordinal_type,
122  typename MatrixType::node_type> >
124 {
125  return A_->getColMap();
126 }
127 
128 template<class MatrixType>
129 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
130  typename MatrixType::global_ordinal_type,
131  typename MatrixType::node_type> >
133 {
134  return A_->getDomainMap();
135 }
136 
137 template<class MatrixType>
138 Teuchos::RCP<const Tpetra::Map<typename MatrixType::local_ordinal_type,
139  typename MatrixType::global_ordinal_type,
140  typename MatrixType::node_type> >
142 {
143  return A_->getRangeMap();
144 }
145 
146 template<class MatrixType>
147 Teuchos::RCP<const Tpetra::RowGraph<typename MatrixType::local_ordinal_type,
148  typename MatrixType::global_ordinal_type,
149  typename MatrixType::node_type> >
151 {
152  return A_->getGraph();
153 }
154 
155 template<class MatrixType>
157 {
158  return A_->getGlobalNumRows();
159 }
160 
161 template<class MatrixType>
163 {
164  return A_->getGlobalNumCols();
165 }
166 
167 template<class MatrixType>
169 {
170  return A_->getNodeNumRows();
171 }
172 
173 template<class MatrixType>
175 {
176  return A_->getNodeNumCols();
177 }
178 
179 template<class MatrixType>
180 typename MatrixType::global_ordinal_type DiagonalFilter<MatrixType>::getIndexBase() const
181 {
182  return A_->getIndexBase();
183 }
184 
185 template<class MatrixType>
187 {
188  return A_->getGlobalNumEntries();
189 }
190 
191 template<class MatrixType>
193 {
194  return A_->getNodeNumEntries();
195 }
196 
197 template<class MatrixType>
198 size_t DiagonalFilter<MatrixType>::getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const
199 {
200  return A_->getNumEntriesInGlobalRow(globalRow);
201 }
202 
203 template<class MatrixType>
204 size_t DiagonalFilter<MatrixType>::getNumEntriesInLocalRow(LocalOrdinal localRow) const
205 {
206  return A_->getNumEntriesInLocalRow(localRow);
207 }
208 
209 template<class MatrixType>
211 {
212  return A_->getGlobalMaxNumRowEntries();
213 }
214 
215 template<class MatrixType>
217 {
218  return A_->getNodeMaxNumRowEntries();
219 }
220 
221 template<class MatrixType>
223 {
224  return A_->hasColMap();
225 }
226 
227 template<class MatrixType>
229 {
230  return A_->isLocallyIndexed();
231 }
232 
233 template<class MatrixType>
235 {
236  return A_->isGloballyIndexed();
237 }
238 
239 template<class MatrixType>
241 {
242  return A_->isFillComplete();
243 }
244 
245 template<class MatrixType>
247 getGlobalRowCopy (GlobalOrdinal GlobalRow,
248  const Teuchos::ArrayView<GlobalOrdinal> &Indices,
249  const Teuchos::ArrayView<Scalar> &Values,
250  size_t &NumEntries) const
251 {
252  Teuchos::ArrayRCP< const Scalar > myvals=val_->get1dView();
253  LocalOrdinal LocalRow=getRowMap()->getLocalElement(GlobalRow);
254 
255  A_->getGlobalRowCopy(GlobalRow, Indices,Values,NumEntries);
256 
257  if (pos_[LocalRow] != -1)
258  Values[pos_[LocalRow]] += myvals[LocalRow];
259 }
260 
261 template<class MatrixType>
263 getLocalRowCopy (LocalOrdinal LocalRow,
264  const Teuchos::ArrayView<LocalOrdinal> &Indices,
265  const Teuchos::ArrayView<Scalar> &Values,
266  size_t &NumEntries) const
267 {
268  Teuchos::ArrayRCP< const Scalar > myvals=val_->get1dView();
269 
270  A_->getLocalRowCopy(LocalRow, Indices,Values,NumEntries);
271 
272  if (pos_[LocalRow] != -1)
273  Values[pos_[LocalRow]] += myvals[LocalRow];
274 }
275 
276 template<class MatrixType>
278 getGlobalRowView (GlobalOrdinal /* GlobalRow */,
279  Teuchos::ArrayView<const GlobalOrdinal> &/* indices */,
280  Teuchos::ArrayView<const Scalar> &/* values */) const
281 {
282  throw std::runtime_error("Ifpack2::DiagonalFilter: does not support getGlobalRowView.");
283 }
284 
285 template<class MatrixType>
287 getLocalRowView (LocalOrdinal /* LocalRow */,
288  Teuchos::ArrayView<const LocalOrdinal> &/* indices */,
289  Teuchos::ArrayView<const Scalar> &/* values */) const
290 {
291  throw std::runtime_error("Ifpack2::DiagonalFilter: does not support getLocalRowView.");
292 }
293 
294 template<class MatrixType>
295 void DiagonalFilter<MatrixType>::getLocalDiagCopy(Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &diag) const
296 {
297  // Returns the matrix's actual diagonal, rather than the "filtered" diagonal.
298  // This is dubious, but it duplicates the functionality of Old Ifpack.
299  return A_->getLocalDiagCopy(diag);
300 }
301 
302 template<class MatrixType>
303 void DiagonalFilter<MatrixType>::leftScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* x */)
304 {
305  throw std::runtime_error("Ifpack2::DiagonalFilter does not support leftScale.");
306 }
307 
308 template<class MatrixType>
309 void DiagonalFilter<MatrixType>::rightScale(const Tpetra::Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node>& /* x */)
310 {
311  throw std::runtime_error("Ifpack2::DiagonalFilter does not support rightScale.");
312 }
313 
314 template<class MatrixType>
316 apply (const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
317  Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
318  Teuchos::ETransp mode,
319  Scalar alpha,
320  Scalar beta) const
321 {
322  // FIXME (mfh 27 Jul 2015) If this is a "diagonal filter," why do we
323  // need to apply the whole matrix???
324 
325  Scalar one = Teuchos::ScalarTraits<Scalar>::one();
326  A_->apply(X,Y,mode,alpha,beta);
327  Y.elementWiseMultiply(one,*val_,X,one);
328 }
329 
330 template<class MatrixType>
332 {
333  return A_->hasTransposeApply();
334 }
335 
336 template<class MatrixType>
338 {
339  return false;
340 }
341 
342 template<class MatrixType>
343 typename DiagonalFilter<MatrixType>::mag_type DiagonalFilter<MatrixType>::getFrobeniusNorm() const
344 {
345  throw std::runtime_error("Ifpack2::DiagonalFilter does not implement getFrobeniusNorm.");
346 }
347 
348 } // namespace Ifpack2
349 
350 #define IFPACK2_DIAGONALFILTER_INSTANT(S,LO,GO,N) \
351  template class Ifpack2::DiagonalFilter< Tpetra::RowMatrix<S, LO, GO, N> >;
352 
353 #endif
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const
Returns the Map that describes the range distribution in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:141
virtual global_size_t getGlobalNumRows() const
Returns the number of global rows in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:156
virtual global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:186
virtual bool isLocallyIndexed() const
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
Definition: Ifpack2_DiagonalFilter_def.hpp:228
virtual bool isGloballyIndexed() const
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
Definition: Ifpack2_DiagonalFilter_def.hpp:234
virtual GlobalOrdinal getIndexBase() const
Returns the index base for global indices for this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:180
virtual size_t getNodeNumEntries() const
Returns the local number of entries in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:192
virtual ~DiagonalFilter()
Destructor.
Definition: Ifpack2_DiagonalFilter_def.hpp:96
virtual bool hasColMap() const
Indicates whether this matrix has a well-defined column map.
Definition: Ifpack2_DiagonalFilter_def.hpp:222
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const
Returns the Map that describes the row distribution in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:114
virtual size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
Definition: Ifpack2_DiagonalFilter_def.hpp:210
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const
Returns the Map that describes the domain distribution in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:132
virtual bool supportsRowViews() const
Returns true if RowViews are supported.
Definition: Ifpack2_DiagonalFilter_def.hpp:337
virtual void getGlobalRowView(GlobalOrdinal GlobalRow, Teuchos::ArrayView< const GlobalOrdinal > &indices, Teuchos::ArrayView< const Scalar > &values) const
Extract a const, non-persisting view of global indices in a specified row of the matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:278
virtual mag_type getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:343
virtual Teuchos::RCP< Node > getNode() const
Returns the underlying node.
Definition: Ifpack2_DiagonalFilter_def.hpp:105
virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm() const
Returns the communicator.
Definition: Ifpack2_DiagonalFilter_def.hpp:99
virtual void leftScale(const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Scales the RowMatrix on the left with the Vector x.
Definition: Ifpack2_DiagonalFilter_def.hpp:303
virtual size_t getNodeMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition: Ifpack2_DiagonalFilter_def.hpp:216
virtual bool hasTransposeApply() const
Indicates whether this operator supports applying the adjoint operator.
Definition: Ifpack2_DiagonalFilter_def.hpp:331
virtual void rightScale(const Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Scales the RowMatrix on the right with the Vector x.
Definition: Ifpack2_DiagonalFilter_def.hpp:309
virtual void apply(const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const
Computes the operator-multivector application.
Definition: Ifpack2_DiagonalFilter_def.hpp:316
virtual Teuchos::RCP< const Tpetra::RowGraph< LocalOrdinal, GlobalOrdinal, Node > > getGraph() const
Returns the RowGraph associated with this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:150
virtual global_size_t getGlobalNumCols() const
Returns the number of global columns in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:162
virtual void getLocalRowCopy(LocalOrdinal LocalRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, const Teuchos::ArrayView< Scalar > &Values, size_t &NumEntries) const
Extract a list of entries in a specified local row of the graph. Put into storage allocated by callin...
Definition: Ifpack2_DiagonalFilter_def.hpp:263
DiagonalFilter(const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Matrix, magnitudeType AbsoluteThreshold, magnitudeType RelativeThreshold)
Constructor.
Definition: Ifpack2_DiagonalFilter_def.hpp:58
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const
Returns the current number of entries on this node in the specified local row.
Definition: Ifpack2_DiagonalFilter_def.hpp:204
virtual void getLocalRowView(LocalOrdinal LocalRow, Teuchos::ArrayView< const LocalOrdinal > &indices, Teuchos::ArrayView< const Scalar > &values) const
Extract a const, non-persisting view of local indices in a specified row of the matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:287
virtual void getLocalDiagCopy(Tpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const
Get a copy of the diagonal entries owned by this node, with local row indices.
Definition: Ifpack2_DiagonalFilter_def.hpp:295
virtual size_t getNodeNumRows() const
Returns the number of rows owned on the calling node.
Definition: Ifpack2_DiagonalFilter_def.hpp:168
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:72
virtual bool isFillComplete() const
Returns true if fillComplete() has been called.
Definition: Ifpack2_DiagonalFilter_def.hpp:240
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const
Returns the Map that describes the column distribution in this matrix.
Definition: Ifpack2_DiagonalFilter_def.hpp:123
virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow, const Teuchos::ArrayView< GlobalOrdinal > &Indices, const Teuchos::ArrayView< Scalar > &Values, size_t &NumEntries) const
Extract a list of entries in a specified global row of this matrix. Put into pre-allocated storage...
Definition: Ifpack2_DiagonalFilter_def.hpp:247
virtual size_t getNodeNumCols() const
Returns the number of columns needed to apply the forward operator on this node, i.e., the number of elements listed in the column map.
Definition: Ifpack2_DiagonalFilter_def.hpp:174
virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const
Returns the current number of entries on this node in the specified global row.
Definition: Ifpack2_DiagonalFilter_def.hpp:198