Tpetra parallel linear algebra  Version of the Day
TpetraExt_MatrixMatrix_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Tpetra: Templated Linear Algebra Services Package
5 // Copyright (2008) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
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 #ifndef TPETRA_MATRIXMATRIX_DECL_HPP
43 #define TPETRA_MATRIXMATRIX_DECL_HPP
44 
45 #include <string>
46 #include <Teuchos_RCP.hpp>
47 #include <Teuchos_Array.hpp>
48 #include "Tpetra_ConfigDefs.hpp"
49 #include "Tpetra_CrsMatrix.hpp"
50 #include "Tpetra_Vector.hpp"
51 #include "TpetraExt_MMHelpers.hpp"
52 
53 
59 namespace Tpetra {
60 
61 namespace MatrixMatrix {
62 
93 template <class Scalar,
94  class LocalOrdinal,
95  class GlobalOrdinal,
96  class Node>
97 void Multiply(
98  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
99  bool transposeA,
100  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
101  bool transposeB,
102  CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
103  bool call_FillComplete_on_result = true,
104  const std::string& label = std::string(),
105  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
106 
120 template <class Scalar,
121  class LocalOrdinal,
122  class GlobalOrdinal,
123  class Node>
124 void Add(
125  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
126  bool transposeA,
127  Scalar scalarA,
128  CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
129  Scalar scalarB );
130 
131 
161 template <class Scalar,
162  class LocalOrdinal,
163  class GlobalOrdinal,
164  class Node>
165 Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
166 add (const Scalar& alpha,
167  const bool transposeA,
168  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
169  const Scalar& beta,
170  const bool transposeB,
171  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
172  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& domainMap = Teuchos::null,
173  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& rangeMap = Teuchos::null,
174  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
175 
205 template <class Scalar,
206  class LocalOrdinal,
207  class GlobalOrdinal,
208  class Node>
209 void Add(
210  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
211  bool transposeA,
212  Scalar scalarA,
213  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
214  bool transposeB,
215  Scalar scalarB,
216  Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > C);
217 
218 
240  template <class Scalar,
241  class LocalOrdinal,
242  class GlobalOrdinal,
243  class Node>
244  void Jacobi(Scalar omega,
245  const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> & Dinv,
246  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
247  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
248  CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
249  bool call_FillComplete_on_result = true,
250  const std::string& label = std::string(),
251  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
252 
253 } // namespace MatrixMatrix
254 
255 namespace MMdetails{
256 
257 template<class Scalar,
258  class LocalOrdinal,
259  class GlobalOrdinal,
260  class Node>
261 void mult_AT_B_newmatrix(
262  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
263  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
264  CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
265  const std::string& label = std::string(),
266  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
267 
268 
269 template<class Scalar,
270  class LocalOrdinal,
271  class GlobalOrdinal,
272  class Node>
273 void mult_A_B(
274  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
275  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
276  CrsWrapper<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
277  const std::string& label = std::string(),
278  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
279 
280 template<class Scalar,
281  class LocalOrdinal,
282  class GlobalOrdinal,
283  class Node>
284 void mult_A_B_newmatrix(
285  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
286  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
287  CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
288  const std::string& label = std::string(),
289  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
290 
291 template<class Scalar,
292  class LocalOrdinal,
293  class GlobalOrdinal,
294  class Node>
295 void mult_A_B_reuse(
296  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
297  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
298  CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
299  const std::string& label = std::string(),
300  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
301 
302 template<class Scalar,
303  class LocalOrdinal,
304  class GlobalOrdinal,
305  class Node>
306 void jacobi_A_B_newmatrix(
307  Scalar omega,
308  const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> & Dinv,
309  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
310  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
311  CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
312  const std::string & label = std::string(),
313  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
314 
315 template<class Scalar,
316  class LocalOrdinal,
317  class GlobalOrdinal,
318  class Node>
319 void jacobi_A_B_reuse(
320  Scalar omega,
321  const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> & Dinv,
322  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
323  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
324  CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
325  const std::string & label = std::string(),
326  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
327 
328 template<class Scalar,
329  class LocalOrdinal,
330  class GlobalOrdinal,
331  class Node>
332 void import_and_extract_views(
333  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& M,
334  Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > targetMap,
335  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Mview,
336  Teuchos::RCP<const Import<LocalOrdinal,GlobalOrdinal, Node> > prototypeImporter = Teuchos::null,
337  bool userAssertsThereAreNoRemotes = false,
338  const std::string& label = std::string(),
339  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
340 
341 template<class Scalar,
342  class LocalOrdinal,
343  class GlobalOrdinal,
344  class Node>
345 void setMaxNumEntriesPerRow(
346  CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Mview);
347 
348 }//end namespace MMdetails
349 
350 } // end of Tpetra namespace
351 
352 #endif // TPETRA_MATRIXMATRIX_DECL_HPP
353 
Namespace Tpetra contains the class and methods constituting the Tpetra library.
void Jacobi(Scalar omega, const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Dinv, const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &C, bool call_FillComplete_on_result=true, const std::string &label=std::string(), const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
void Add(const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, bool transposeA, Scalar scalarA, CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, Scalar scalarB)
void Multiply(const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, bool transposeA, const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, bool transposeB, CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &C, bool call_FillComplete_on_result=true, const std::string &label=std::string(), const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Sparse matrix-matrix multiply.
Teuchos::RCP< CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > add(const Scalar &alpha, const bool transposeA, const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta, const bool transposeB, const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap=Teuchos::null, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Compute the sparse matrix sum C = scalarA * Op(A) + scalarB * Op(B), where Op(X) is either X or its t...