Tpetra parallel linear algebra  Version of the Day
Tpetra_Details_packCrsGraph_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_PACKCRSGRAPH_DECL_HPP
43 #define TPETRA_DETAILS_PACKCRSGRAPH_DECL_HPP
44 
45 #include "TpetraCore_config.h"
46 #include "Kokkos_DualView.hpp"
48 #include "Tpetra_CrsGraph_fwd.hpp"
49 
70 
71 #ifndef DOXYGEN_SHOULD_SKIP_THIS
72 namespace Teuchos {
73 // Forward declaration of Array
74 template<class T> class Array;
75 // Forward declaration of ArrayView
76 template<class T> class ArrayView;
77 } // namespace Teuchos
78 #endif // DOXYGEN_SHOULD_SKIP_THIS
79 
80 namespace Tpetra {
81 
82 #ifndef DOXYGEN_SHOULD_SKIP_THIS
83 // Forward declaration of Distributor
84 class Distributor;
85 #endif // DOXYGEN_SHOULD_SKIP_THIS
86 
87 //
88 // Users must never rely on anything in the Details namespace.
89 //
90 namespace Details {
91 
122 template<typename LO, typename GO, typename NT>
123 void
124 packCrsGraph (const CrsGraph<LO, GO, NT>& sourceGraph,
125  Teuchos::Array<typename CrsGraph<LO,GO,NT>::packet_type>& exports,
126  const Teuchos::ArrayView<size_t>& numPacketsPerLID,
127  const Teuchos::ArrayView<const LO>& exportLIDs,
128  size_t& constantNumPackets,
129  Distributor& distor);
130 
160 template<typename LO, typename GO, typename NT>
161 void
162 packCrsGraphNew (const CrsGraph<LO, GO, NT>& sourceGraph,
163  Kokkos::DualView<typename CrsGraph<LO,GO,NT>::packet_type*,
165  exports,
166  const Kokkos::DualView<size_t*,
168  numPacketsPerLID,
169  const Kokkos::DualView<const LO*, typename NT::device_type>& exportLIDs,
170  size_t& constantNumPackets,
171  Distributor& distor);
172 
203 template<typename LO, typename GO, typename NT>
204 void
205 packCrsGraphWithOwningPIDs (const CrsGraph<LO,GO,NT>& sourceGraph,
206  Kokkos::DualView<typename CrsGraph<LO,GO,NT>::packet_type*,
208  exports_dv,
209  const Teuchos::ArrayView<size_t>& numPacketsPerLID,
210  const Teuchos::ArrayView<const LO>& exportLIDs,
211  const Teuchos::ArrayView<const int>& sourcePIDs,
212  size_t& constantNumPackets,
213  Distributor& distor);
214 
215 } // namespace Details
216 } // namespace Tpetra
217 
218 #endif // TPETRA_DETAILS_PACKCRSGRAPH_DECL_HPP
Tpetra_CrsGraph_fwd.hpp
Forward declaration of Tpetra::CrsGraph.
Tpetra::Details::packCrsGraph
void packCrsGraph(const CrsGraph< LO, GO, NT > &sourceGraph, Teuchos::Array< typename CrsGraph< LO, GO, NT >::packet_type > &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 graph for communication.
Definition: Tpetra_Details_packCrsGraph_def.hpp:783
Details
Implementation details of Tpetra.
Tpetra_DistObject_decl.hpp
Declaration of the Tpetra::DistObject class.
Tpetra::Details::packCrsGraphWithOwningPIDs
void packCrsGraphWithOwningPIDs(const CrsGraph< LO, GO, NT > &sourceGraph, Kokkos::DualView< typename CrsGraph< LO, GO, NT >::packet_type *, typename CrsGraph< 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 graph for communication.
Definition: Tpetra_Details_packCrsGraph_def.hpp:913
Tpetra::Classes::DistObject< GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node >::packet_type
::Kokkos::Details::ArithTraits< GlobalOrdinal >::val_type packet_type
The type of each datum being sent or received in an Import or Export.
Definition: Tpetra_DistObject_decl.hpp:361
Tpetra::Details::packCrsGraphNew
void packCrsGraphNew(const CrsGraph< LO, GO, NT > &sourceGraph, Kokkos::DualView< typename CrsGraph< LO, GO, NT >::packet_type *, typename CrsGraph< LO, GO, NT >::buffer_device_type > &exports, const Kokkos::DualView< size_t *, typename CrsGraph< LO, GO, NT >::buffer_device_type > &numPacketsPerLID, const Kokkos::DualView< const LO *, typename NT::device_type > &exportLIDs, size_t &constantNumPackets, Distributor &distor)
Pack specified entries of the given local sparse graph for communication, for "new" DistObject interf...
Definition: Tpetra_Details_packCrsGraph_def.hpp:863
Tpetra
Namespace Tpetra contains the class and methods constituting the Tpetra library.
Tpetra::Classes::DistObject< GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node >::buffer_device_type
Kokkos::Device< typename device_type::execution_space, buffer_memory_space > buffer_device_type
Kokkos::Device specialization for communication buffers.
Definition: Tpetra_DistObject_decl.hpp:710