Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tpetra_Details_packCrsMatrix_decl.hpp
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_DETAILS_PACKCRSMATRIX_DECL_HPP
43 #define TPETRA_DETAILS_PACKCRSMATRIX_DECL_HPP
44 
45 #include "TpetraCore_config.h"
46 #include "Kokkos_DualView.hpp"
48 #include "Tpetra_CrsMatrix_fwd.hpp"
49 
71 
72 #ifndef DOXYGEN_SHOULD_SKIP_THIS
73 namespace Teuchos {
74 // Forward declaration of Array
75 template<class T> class Array;
76 // Forward declaration of ArrayView
77 template<class T> class ArrayView;
78 } // namespace Teuchos
79 #endif // DOXYGEN_SHOULD_SKIP_THIS
80 
81 namespace Tpetra {
82 
83 #ifndef DOXYGEN_SHOULD_SKIP_THIS
84 // Forward declaration of Distributor
85 class Distributor;
86 #endif // DOXYGEN_SHOULD_SKIP_THIS
87 
88 //
89 // Users must never rely on anything in the Details namespace.
90 //
91 namespace Details {
92 
126 template<typename ST, typename LO, typename GO, typename NT>
127 void
128 packCrsMatrix (const CrsMatrix<ST, LO, GO, NT>& sourceMatrix,
129  Teuchos::Array<char>& exports,
130  const Teuchos::ArrayView<size_t>& numPacketsPerLID,
131  const Teuchos::ArrayView<const LO>& exportLIDs,
132  size_t& constantNumPackets,
133  Distributor& distor);
134 
166 template<typename ST, typename LO, typename GO, typename NT>
167 void
168 packCrsMatrixNew (const CrsMatrix<ST, LO, GO, NT>& sourceMatrix,
169  Kokkos::DualView<char*,
171  const Kokkos::DualView<size_t*,
172  typename DistObject<char, LO, GO, NT>::buffer_device_type>& numPacketsPerLID,
173  const Kokkos::DualView<const LO*,
175  size_t& constantNumPackets,
176  Distributor& distor);
177 
211 template<typename ST, typename LO, typename GO, typename NT>
212 void
213 packCrsMatrixWithOwningPIDs (const CrsMatrix<ST, LO, GO, NT>& sourceMatrix,
214  Kokkos::DualView<char*, typename DistObject<char, LO, GO, NT>::buffer_device_type>& exports_dv,
215  const Teuchos::ArrayView<size_t>& numPacketsPerLID,
216  const Teuchos::ArrayView<const LO>& exportLIDs,
217  const Teuchos::ArrayView<const int>& sourcePIDs,
218  size_t& constantNumPackets,
219  Distributor& distor);
220 
221 } // namespace Details
222 } // namespace Tpetra
223 
224 #endif // TPETRA_DETAILS_PACKCRSMATRIX_DECL_HPP
void packCrsMatrixWithOwningPIDs(const CrsMatrix< ST, LO, GO, NT > &sourceMatrix, Kokkos::DualView< char *, typename DistObject< char, LO, GO, NT >::buffer_device_type > &exports_dv, const Teuchos::ArrayView< size_t > &numPacketsPerLID, const Teuchos::ArrayView< const LO > &exportLIDs, const Teuchos::ArrayView< const int > &sourcePIDs, size_t &constantNumPackets, Distributor &distor)
Pack specified entries of the given local sparse matrix for communication.
void packCrsMatrixNew(const CrsMatrix< ST, LO, GO, NT > &sourceMatrix, Kokkos::DualView< char *, typename DistObject< char, LO, GO, NT >::buffer_device_type > &exports, const Kokkos::DualView< size_t *, typename DistObject< char, LO, GO, NT >::buffer_device_type > &numPacketsPerLID, const Kokkos::DualView< const LO *, typename DistObject< char, LO, GO, NT >::buffer_device_type > &exportLIDs, size_t &constantNumPackets, Distributor &distor)
Pack specified entries of the given local sparse matrix for communication, for &quot;new&quot; DistObject inter...
void packCrsMatrix(const CrsMatrix< ST, LO, GO, NT > &sourceMatrix, Teuchos::Array< char > &exports, const Teuchos::ArrayView< size_t > &numPacketsPerLID, const Teuchos::ArrayView< const LO > &exportLIDs, size_t &constantNumPackets, Distributor &distor)
Pack specified entries of the given local sparse matrix for communication.
Forward declaration of Tpetra::CrsMatrix.
Declaration of the Tpetra::DistObject class.
Kokkos::Device< typename device_type::execution_space, buffer_memory_space > buffer_device_type