Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Tpetra_Details_unpackCrsMatrixAndCombine_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 // ************************************************************************
38 // @HEADER
39 
40 #ifndef TPETRA_DETAILS_UNPACKCRSMATRIXANDCOMBINE_DECL_HPP
41 #define TPETRA_DETAILS_UNPACKCRSMATRIXANDCOMBINE_DECL_HPP
42 
43 #include "TpetraCore_config.h"
44 #include "Tpetra_CombineMode.hpp"
45 #include "Kokkos_DualView.hpp"
46 #include "Tpetra_CrsMatrix_fwd.hpp"
48 
69 
70 #ifndef DOXYGEN_SHOULD_SKIP_THIS
71 namespace Teuchos {
72 // Forward declaration of Array
73 template<class T> class Array;
74 // Forward declaration of ArrayView
75 template<class T> class ArrayView;
76 } // namespace Teuchos
77 #endif // DOXYGEN_SHOULD_SKIP_THIS
78 
79 namespace Tpetra {
80 
81 #ifndef DOXYGEN_SHOULD_SKIP_THIS
82 // Forward declaration of Distributor
83 class Distributor;
84 #endif // DOXYGEN_SHOULD_SKIP_THIS
85 
86 //
87 // Users must never rely on anything in the Details namespace.
88 //
89 namespace Details {
90 
129 template<typename ST, typename LO, typename GO, typename NT>
130 void
131 unpackCrsMatrixAndCombine (const CrsMatrix<ST, LO, GO, NT>& sourceMatrix,
132  const Teuchos::ArrayView<const char>& imports,
133  const Teuchos::ArrayView<const size_t>& numPacketsPerLID,
134  const Teuchos::ArrayView<const LO>& importLIDs,
135  size_t constantNumPackets,
136  Distributor & distor,
137  CombineMode combineMode);
138 
139 template<typename ST, typename LO, typename GO, typename NT>
140 void
141 unpackCrsMatrixAndCombineNew(
142  const CrsMatrix<ST, LO, GO, NT>& sourceMatrix,
143  Kokkos::DualView<char*,
145  Kokkos::DualView<size_t*,
146  typename DistObject<char, LO, GO, NT>::buffer_device_type> numPacketsPerLID,
147  const Kokkos::DualView<const LO*,
149  const size_t constantNumPackets,
150  Distributor& distor,
151  const CombineMode combineMode);
152 
199 //
208 template<typename Scalar, typename LocalOrdinal, typename GlobalOrdinal, typename Node>
209 size_t
211  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> & sourceMatrix,
212  const Teuchos::ArrayView<const LocalOrdinal> &importLIDs,
213  const Teuchos::ArrayView<const char> &imports,
214  const Teuchos::ArrayView<const size_t>& numPacketsPerLID,
215  size_t constantNumPackets,
216  Distributor &distor,
217  CombineMode combineMode,
218  size_t numSameIDs,
219  const Teuchos::ArrayView<const LocalOrdinal>& permuteToLIDs,
220  const Teuchos::ArrayView<const LocalOrdinal>& permuteFromLIDs);
221 
236 template<typename Scalar, typename LocalOrdinal, typename GlobalOrdinal, typename Node>
237 void
239  const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> & sourceMatrix,
240  const Teuchos::ArrayView<const LocalOrdinal>& importLIDs,
241  const Teuchos::ArrayView<const char>& imports,
242  const Teuchos::ArrayView<const size_t>& numPacketsPerLID,
243  const size_t constantNumPackets,
244  Distributor& distor,
245  const CombineMode combineMode,
246  const size_t numSameIDs,
247  const Teuchos::ArrayView<const LocalOrdinal>& permuteToLIDs,
248  const Teuchos::ArrayView<const LocalOrdinal>& permuteFromLIDs,
249  size_t TargetNumRows,
250  size_t TargetNumNonzeros,
251  const int MyTargetPID,
252  const Teuchos::ArrayView<size_t>& CRS_rowptr,
253  const Teuchos::ArrayView<GlobalOrdinal>& CRS_colind,
254  const Teuchos::ArrayView<typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::impl_scalar_type>& CRS_vals,
255  const Teuchos::ArrayView<const int>& SourcePids,
256  Teuchos::Array<int>& TargetPids);
257 
258 } // namespace Details
259 } // namespace Tpetra
260 
261 #endif // TPETRA_DETAILS_UNPACKCRSMATRIXANDCOMBINE_DECL_HPP
size_t unpackAndCombineWithOwningPIDsCount(const CrsGraph< LO, GO, NT > &sourceGraph, const Teuchos::ArrayView< const LO > &importLIDs, const Teuchos::ArrayView< const typename CrsGraph< LO, GO, NT >::packet_type > &imports, const Teuchos::ArrayView< const size_t > &numPacketsPerLID, size_t constantNumPackets, Distributor &distor, CombineMode combineMode, size_t numSameIDs, const Teuchos::ArrayView< const LO > &permuteToLIDs, const Teuchos::ArrayView< const LO > &permuteFromLIDs)
Special version of Tpetra::Details::unpackCrsGraphAndCombine that also unpacks owning process ranks...
void unpackCrsMatrixAndCombine(const CrsMatrix< ST, LO, GO, NT > &sourceMatrix, const Teuchos::ArrayView< const char > &imports, const Teuchos::ArrayView< const size_t > &numPacketsPerLID, const Teuchos::ArrayView< const LO > &importLIDs, size_t constantNumPackets, Distributor &distor, CombineMode combineMode)
Unpack the imported column indices and values, and combine into matrix.
Declaration of Tpetra::CombineMode enum, and a function for setting a Tpetra::CombineMode parameter i...
CombineMode
Rule for combining data in an Import or Export.
void unpackAndCombineIntoCrsArrays(const CrsGraph< LO, GO, NT > &sourceGraph, const Teuchos::ArrayView< const LO > &importLIDs, const Teuchos::ArrayView< const typename CrsGraph< LO, GO, NT >::packet_type > &imports, const Teuchos::ArrayView< const size_t > &numPacketsPerLID, const size_t constantNumPackets, Distributor &distor, const CombineMode combineMode, const size_t numSameIDs, const Teuchos::ArrayView< const LO > &permuteToLIDs, const Teuchos::ArrayView< const LO > &permuteFromLIDs, size_t TargetNumRows, size_t TargetNumNonzeros, const int MyTargetPID, const Teuchos::ArrayView< size_t > &CRS_rowptr, const Teuchos::ArrayView< GO > &CRS_colind, const Teuchos::ArrayView< const int > &SourcePids, Teuchos::Array< int > &TargetPids)
unpackAndCombineIntoCrsArrays
Forward declaration of Tpetra::CrsMatrix.
Declaration of the Tpetra::DistObject class.
Kokkos::Device< typename device_type::execution_space, buffer_memory_space > buffer_device_type