42#ifndef TPETRA_MATRIXMATRIX_DECL_HPP
43#define TPETRA_MATRIXMATRIX_DECL_HPP
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#include "KokkosKernels_Handle.hpp"
62namespace MatrixMatrix {
94template <
class Scalar,
99 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
101 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
103 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
104 bool call_FillComplete_on_result =
true,
105 const std::string& label = std::string(),
106 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
121template <
class Scalar,
126 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
129 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
161template <
class Scalar,
165Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
166add (
const Scalar& alpha,
167 const bool transposeA,
168 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
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);
212template <
class Scalar,
217add (
const Scalar& alpha,
218 const bool transposeA,
219 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
221 const bool transposeB,
222 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
223 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> & C,
224 const Teuchos::RCP<
const Map<LocalOrdinal, GlobalOrdinal, Node> >& domainMap = Teuchos::null,
225 const Teuchos::RCP<
const Map<LocalOrdinal, GlobalOrdinal, Node> >& rangeMap = Teuchos::null,
226 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
258template <
class Scalar,
263 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
266 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
269 Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > C);
293 template <
class Scalar,
298 const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> & Dinv,
299 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
300 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
301 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
302 bool call_FillComplete_on_result =
true,
303 const std::string& label = std::string(),
304 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
311template<
class Scalar,
315void mult_AT_B_newmatrix(
316 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& A,
317 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& B,
318 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
319 const std::string& label = std::string(),
320 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
323template<
class Scalar,
328 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
329 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
330 CrsWrapper<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
331 const std::string& label = std::string(),
332 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
334template<
class Scalar,
338void mult_A_B_newmatrix(
339 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
340 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
341 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
342 const std::string& label = std::string(),
343 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
348template<
class Scalar,
353 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
354 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
355 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
356 const std::string& label = std::string(),
357 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
363template<
class Scalar,
367void jacobi_A_B_newmatrix(
369 const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> & Dinv,
370 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
371 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
372 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
373 const std::string & label = std::string(),
374 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
377template<
class Scalar,
381void jacobi_A_B_reuse(
383 const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> & Dinv,
384 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
385 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
386 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
387 const std::string & label = std::string(),
388 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
391template<
class Scalar,
395void import_and_extract_views(
396 const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& M,
397 Teuchos::RCP<
const Map<LocalOrdinal, GlobalOrdinal, Node> > targetMap,
398 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Mview,
399 Teuchos::RCP<
const Import<LocalOrdinal,GlobalOrdinal, Node> > prototypeImporter = Teuchos::null,
400 bool userAssertsThereAreNoRemotes =
false,
401 const std::string& label = std::string(),
402 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
404template<
class Scalar,
408void setMaxNumEntriesPerRow(
409 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Mview);
414 template<
class Scalar,
418 class LocalOrdinalViewType>
419 struct KernelWrappers {
420 static inline void mult_A_B_newmatrix_kernel_wrapper(CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
421 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
422 const LocalOrdinalViewType & Acol2Brow,
423 const LocalOrdinalViewType & Acol2Irow,
424 const LocalOrdinalViewType & Bcol2Ccol,
425 const LocalOrdinalViewType & Icol2Ccol,
426 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
427 Teuchos::RCP<
const Import<LocalOrdinal,GlobalOrdinal,Node> > Cimport,
428 const std::string& label = std::string(),
429 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
431 static inline void mult_A_B_reuse_kernel_wrapper(CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
432 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
433 const LocalOrdinalViewType & Acol2Brow,
434 const LocalOrdinalViewType & Acol2Irow,
435 const LocalOrdinalViewType & Bcol2Ccol,
436 const LocalOrdinalViewType & Icol2Ccol,
437 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
438 Teuchos::RCP<
const Import<LocalOrdinal,GlobalOrdinal,Node> > Cimport,
439 const std::string& label = std::string(),
440 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
446 template<
class Scalar,
450 class LocalOrdinalViewType>
451 struct KernelWrappers2 {
452 static inline void jacobi_A_B_newmatrix_kernel_wrapper(Scalar omega,
453 const Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> & Dinv,
454 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
455 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
456 const LocalOrdinalViewType & Acol2Brow,
457 const LocalOrdinalViewType & Acol2Irow,
458 const LocalOrdinalViewType & Bcol2Ccol,
459 const LocalOrdinalViewType & Icol2Ccol,
460 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
461 Teuchos::RCP<
const Import<LocalOrdinal,GlobalOrdinal,Node> > Cimport,
462 const std::string& label = std::string(),
463 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
465 static inline void jacobi_A_B_reuse_kernel_wrapper(Scalar omega,
466 const Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> & Dinv,
467 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
468 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
469 const LocalOrdinalViewType & Acol2Brow,
470 const LocalOrdinalViewType & Acol2Irow,
471 const LocalOrdinalViewType & Bcol2Ccol,
472 const LocalOrdinalViewType & Icol2Ccol,
473 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
474 Teuchos::RCP<
const Import<LocalOrdinal,GlobalOrdinal,Node> > Cimport,
475 const std::string& label = std::string(),
476 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
482 template<
class Scalar,
486 class LocalOrdinalViewType>
487 struct KernelWrappers3 {
488 static inline void mult_R_A_P_newmatrix_kernel_wrapper(CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Rview,
489 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
490 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Pview,
491 const LocalOrdinalViewType & Acol2Prow,
492 const LocalOrdinalViewType & Acol2PIrow,
493 const LocalOrdinalViewType & Pcol2Ccol,
494 const LocalOrdinalViewType & PIcol2Ccol,
495 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Ac,
496 Teuchos::RCP<
const Import<LocalOrdinal,GlobalOrdinal,Node> > Acimport,
497 const std::string& label = std::string(),
498 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
500 static inline void mult_R_A_P_reuse_kernel_wrapper(CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Rview,
501 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
502 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Pview,
503 const LocalOrdinalViewType & Acol2Prow,
504 const LocalOrdinalViewType & Acol2PIrow,
505 const LocalOrdinalViewType & Pcol2Ccol,
506 const LocalOrdinalViewType & PIcol2Ccol,
507 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Ac,
508 Teuchos::RCP<
const Import<LocalOrdinal,GlobalOrdinal,Node> > Acimport,
509 const std::string& label = std::string(),
510 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
513 static inline void mult_PT_A_P_newmatrix_kernel_wrapper(CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
514 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Pview,
515 const LocalOrdinalViewType & Acol2Prow,
516 const LocalOrdinalViewType & Acol2PIrow,
517 const LocalOrdinalViewType & Pcol2Ccol,
518 const LocalOrdinalViewType & PIcol2Ccol,
519 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Ac,
520 Teuchos::RCP<
const Import<LocalOrdinal,GlobalOrdinal,Node> > Acimport,
521 const std::string& label = std::string(),
522 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
524 static inline void mult_PT_A_P_reuse_kernel_wrapper(CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
525 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Pview,
526 const LocalOrdinalViewType & Acol2Prow,
527 const LocalOrdinalViewType & Acol2PIrow,
528 const LocalOrdinalViewType & Pcol2Ccol,
529 const LocalOrdinalViewType & PIcol2Ccol,
530 CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Ac,
531 Teuchos::RCP<
const Import<LocalOrdinal,GlobalOrdinal,Node> > Acimport,
532 const std::string& label = std::string(),
533 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
537 template<
class Scalar,
class LocalOrdinal,
class GlobalOrdinal,
class Node,
class LocalOrdinalViewType>
539 merge_matrices(CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Aview,
540 CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node>& Bview,
541 const LocalOrdinalViewType & Acol2Brow,
542 const LocalOrdinalViewType & Acol2Irow,
543 const LocalOrdinalViewType & Bcol2Ccol,
544 const LocalOrdinalViewType & Icol2Ccol,
545 const size_t mergedNodeNumCols);
550template<
class CrsMatrixType>
551size_t C_estimate_nnz(CrsMatrixType & A, CrsMatrixType &B);
553template<
typename Scalar,
typename LocalOrdinal,
typename GlobalOrdinal,
typename Node>
558 typedef typename Node::device_type device_type;
559 typedef typename device_type::execution_space execution_space;
560 typedef typename device_type::memory_space memory_space;
563 typedef typename KCRS::values_type::non_const_type values_array;
564 typedef typename KCRS::row_map_type::non_const_type row_ptrs_array;
565 typedef typename KCRS::row_map_type row_ptrs_array_const;
566 typedef typename KCRS::index_type::non_const_type col_inds_array;
568 typedef typename Kokkos::View<GlobalOrdinal*, device_type> global_col_inds_array;
569 typedef Kokkos::RangePolicy<execution_space> range_type;
570 typedef KokkosKernels::Experimental::KokkosKernelsHandle<size_t, LocalOrdinal, impl_scalar_type,
571 execution_space, memory_space, memory_space> KKH;
586 static void addSorted(
587 const values_array& Avals,
588 const row_ptrs_array_const& Arowptrs,
589 const col_inds_array& Acolinds,
590 const impl_scalar_type scalarA,
591 const values_array& Bvals,
592 const row_ptrs_array_const& Browptrs,
593 const col_inds_array& Bcolinds,
594 const impl_scalar_type scalarB,
596 row_ptrs_array& Crowptrs,
597 col_inds_array& Ccolinds);
610 static void convertToGlobalAndAdd(
612 const impl_scalar_type scalarA,
614 const impl_scalar_type scalarB,
615 const local_map_type& AcolMap,
616 const local_map_type& BcolMap,
618 row_ptrs_array& Crowptrs,
619 global_col_inds_array& Ccolinds);
635 static void addUnsorted(
636 const values_array& Avals,
637 const row_ptrs_array_const& Arowptrs,
638 const col_inds_array& Acolinds,
639 const impl_scalar_type scalarA,
640 const values_array& Bvals,
641 const row_ptrs_array_const& Browptrs,
642 const col_inds_array& Bcolinds,
643 const impl_scalar_type scalarB,
644 GlobalOrdinal numGlobalCols,
646 row_ptrs_array& Crowptrs,
647 col_inds_array& Ccolinds);
Sparse matrix that presents a row-oriented interface that lets users read or modify entries.
KokkosSparse::CrsMatrix< impl_scalar_type, local_ordinal_type, device_type, void, typename local_graph_device_type::size_type > local_matrix_device_type
The specialization of Kokkos::CrsMatrix that represents the part of the sparse matrix on each MPI pro...
typename row_matrix_type::impl_scalar_type impl_scalar_type
The type used internally in place of Scalar.
A parallel distribution of indices over processes.
::Tpetra::Details::LocalMap< local_ordinal_type, global_ordinal_type, device_type > local_map_type
Type of the "local" Map.
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 > ¶ms=Teuchos::null)
Compute the sparse matrix sum C = scalarA * Op(A) + scalarB * Op(B), where Op(X) is either X or its t...
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 > ¶ms=Teuchos::null)
Sparse matrix-matrix multiply.
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 > ¶ms=Teuchos::null)
void Add(const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, bool transposeA, Scalar scalarA, CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, Scalar scalarB)
Namespace Tpetra contains the class and methods constituting the Tpetra library.