Tpetra parallel linear algebra  Version of the Day
Tpetra_ImportExportData_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_IMPORTEXPORTDATA_DECL_HPP
43 #define TPETRA_IMPORTEXPORTDATA_DECL_HPP
44 
45 #include "Tpetra_Distributor.hpp"
46 
47 namespace Tpetra {
48 
49 #ifndef DOXYGEN_SHOULD_SKIP_THIS
50  // forward declaration of Import,Export, needed to prevent circular inclusions
51  template<class LocalOrdinal, class GlobalOrdinal, class Node> class Import;
52  template<class LocalOrdinal, class GlobalOrdinal, class Node> class Export;
53 
54  // Forward declaration of Map
55  template<class LocalOrdinal, class GlobalOrdinal, class Node> class Map;
56 #endif
57 
77  template<class LocalOrdinal,
78  class GlobalOrdinal,
79  class Node>
81  public:
82  typedef LocalOrdinal local_ordinal_type;
83  typedef GlobalOrdinal global_ordinal_type;
84  typedef Node node_type;
86 
91  ImportExportData (const Teuchos::RCP<const map_type>& source,
92  const Teuchos::RCP<const map_type>& target);
93 
99  ImportExportData (const Teuchos::RCP<const map_type>& source,
100  const Teuchos::RCP<const map_type>& target,
101  const Teuchos::RCP<Teuchos::FancyOStream>& out);
102 
108  ImportExportData (const Teuchos::RCP<const map_type>& source,
109  const Teuchos::RCP<const map_type>& target,
110  const Teuchos::RCP<Teuchos::ParameterList>& plist);
111 
118  ImportExportData (const Teuchos::RCP<const map_type>& source,
119  const Teuchos::RCP<const map_type>& target,
120  const Teuchos::RCP<Teuchos::FancyOStream>& out,
121  const Teuchos::RCP<Teuchos::ParameterList>& plist);
124 
126  Teuchos::RCP<Teuchos::FancyOStream> out_;
127 
133  Teuchos::RCP<ImportExportData<LocalOrdinal, GlobalOrdinal, Node> > reverseClone();
134 
146  Teuchos::Array<LocalOrdinal> permuteToLIDs_;
147 
159  Teuchos::Array<LocalOrdinal> permuteFromLIDs_;
160 
167  Teuchos::Array<LocalOrdinal> remoteLIDs_;
168 
175  Teuchos::Array<LocalOrdinal> exportLIDs_;
176 
178  Teuchos::Array<int> exportPIDs_;
179 
192  size_t numSameIDs_;
193 
195  const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > source_;
196 
198  const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > target_;
199 
201  Teuchos::RCP<const Teuchos::Comm<int> > comm_;
202 
210 
211  private:
217  }; // class ImportExportData
218 
219 } // namespace Tpetra
220 
221 #endif // TPETRA_IMPORTEXPORTDATA_DECL_HPP
size_t numSameIDs_
Number of initial identical indices.
Namespace Tpetra contains the class and methods constituting the Tpetra library.
Teuchos::RCP< const Teuchos::Comm< int > > comm_
Communicator over which the source and target objects are distributed.
Teuchos::Array< LocalOrdinal > permuteToLIDs_
Index of target Map LIDs to which to permute.
ImportExportData(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
Constructor.
Teuchos::Array< int > exportPIDs_
Ranks of the processes to which the source object sends data.
Teuchos::Array< LocalOrdinal > exportLIDs_
"Outgoing" local indices.
Implementation detail of Import and Export.
Sets up and executes a communication plan for a Tpetra DistObject.
Teuchos::Array< LocalOrdinal > permuteFromLIDs_
Index of source Map LIDs from which to permute.
Teuchos::RCP< Teuchos::FancyOStream > out_
Output stream for debug output.
Describes a parallel distribution of objects over processes.
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > target_
Target Map of the Import or Export.
Distributor distributor_
Object that actually distributes (sends and receives) data.
Teuchos::RCP< ImportExportData< LocalOrdinal, GlobalOrdinal, Node > > reverseClone()
Copy the data, but reverse the direction of the transfer as well as reversing the Distributor...
Teuchos::Array< LocalOrdinal > remoteLIDs_
"Incoming" indices.
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > source_
Source Map of the Import or Export.