Tpetra parallel linear algebra  Version of the Day
Tpetra_ImportExportData_def.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_IMPORTEXPORTDATA_DEF_HPP
43 #define TPETRA_IMPORTEXPORTDATA_DEF_HPP
44 
45 #include <Tpetra_ImportExportData_decl.hpp>
46 
47 #include <Tpetra_Map.hpp>
48 
49 namespace Tpetra {
50  template <class LocalOrdinal, class GlobalOrdinal, class Node>
52  ImportExportData (const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& source,
53  const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& target) :
54  source_ (source),
55  target_ (target),
56  out_ (Teuchos::getFancyOStream (Teuchos::rcpFromRef (std::cerr))),
57  numSameIDs_ (0),
58  distributor_ (source->getComm (), out_),
59  isLocallyComplete_ (true) // Import/Export constructor may change this
60  {}
61 
62  template <class LocalOrdinal, class GlobalOrdinal, class Node>
64  ImportExportData (const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& source,
65  const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& target,
66  const Teuchos::RCP<Teuchos::FancyOStream>& out) :
67  source_ (source),
68  target_ (target),
69  out_ (out),
70  numSameIDs_ (0),
71  distributor_ (source->getComm (), out_),
72  isLocallyComplete_ (true) // Import/Export constructor may change this
73  {}
74 
75  template <class LocalOrdinal, class GlobalOrdinal, class Node>
77  ImportExportData (const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& source,
78  const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& target,
79  const Teuchos::RCP<Teuchos::ParameterList>& plist) :
80  source_ (source),
81  target_ (target),
82  out_ (Teuchos::getFancyOStream (Teuchos::rcpFromRef (std::cerr))),
83  numSameIDs_ (0),
84  distributor_ (source->getComm (), out_, plist),
85  isLocallyComplete_ (true) // Import/Export constructor may change this
86  {}
87 
88  template <class LocalOrdinal, class GlobalOrdinal, class Node>
90  ImportExportData (const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& source,
91  const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> >& target,
92  const Teuchos::RCP<Teuchos::FancyOStream>& out,
93  const Teuchos::RCP<Teuchos::ParameterList>& plist) :
94  source_ (source),
95  target_ (target),
96  out_ (out),
97  numSameIDs_ (0),
98  distributor_ (source->getComm (), out_, plist),
99  isLocallyComplete_ (true) // Import/Export constructor may change this
100  {}
101 
102  template <class LocalOrdinal, class GlobalOrdinal, class Node>
103  Teuchos::RCP<ImportExportData<LocalOrdinal, GlobalOrdinal, Node> >
105  {
106  using Teuchos::ArrayView;
107 
108  Teuchos::RCP<ImportExportData<LocalOrdinal,GlobalOrdinal,Node> > tData =
109  Teuchos::rcp (new ImportExportData<LocalOrdinal,GlobalOrdinal,Node> (target_, source_));
110 
111  // Things that stay the same
112  tData->numSameIDs_ = numSameIDs_;
113 
114  // Things that reverse
115  tData->distributor_ = *distributor_.getReverse();
116  tData->permuteToLIDs_ = permuteFromLIDs_;
117  tData->permuteFromLIDs_ = permuteToLIDs_;
118 
119  // Remotes / exports (easy part)
120  tData->exportLIDs_ = remoteLIDs_;
121  tData->remoteLIDs_ = exportLIDs_;
122  tData->exportPIDs_.resize(tData->exportLIDs_.size());
123 
124  // Remotes / exports (hard part) - extract the exportPIDs from the remotes of my distributor
125  size_t NumReceives = distributor_.getNumReceives();
126  ArrayView<const int> ProcsFrom = distributor_.getProcsFrom();
127  ArrayView<const size_t> LengthsFrom = distributor_.getLengthsFrom();
128 
129  // isLocallyComplete is a local predicate.
130  // It could be true in one direction but false in another.
131 
132  bool isLocallyComplete = true; // by default
133  for (size_t i = 0, j = 0; i < NumReceives; ++i) {
134  const int pid = ProcsFrom[i];
135  if (pid == -1) {
136  isLocallyComplete = false;
137  }
138  for (size_t k = 0; k < LengthsFrom[i]; ++k) {
139  tData->exportPIDs_[j] = pid;
140  ++j;
141  }
142  }
143  tData->isLocallyComplete_ = isLocallyComplete;
144 
145  return tData;
146  }
147 
148 
149  template <class LocalOrdinal, class GlobalOrdinal, class Node>
151  {}
152 
153 } // namespace Tpetra
154 
155 // Explicit instantiation macro.
156 // Only invoke this when in the Tpetra namespace.
157 // Most users do not need to use this.
158 //
159 // LO: The local ordinal type.
160 // GO: The global ordinal type.
161 // NODE: The Kokkos Node type.
162 #define TPETRA_IMPORTEXPORTDATA_INSTANT(LO, GO, NODE) \
163  \
164  template class ImportExportData< LO , GO , NODE >;
165 
166 #endif // TPETRA_IMPORTEXPORTDATA_DEF_HPP
Namespace Tpetra contains the class and methods constituting the Tpetra library.
ImportExportData(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
Constructor.
Implementation detail of Import and Export.
Describes a parallel distribution of objects over processes.
Teuchos::RCP< ImportExportData< LocalOrdinal, GlobalOrdinal, Node > > reverseClone()
Copy the data, but reverse the direction of the transfer as well as reversing the Distributor...