Tpetra parallel linear algebra Version of the Day
Loading...
Searching...
No Matches
Tpetra_Import_decl.hpp
1// @HEADER
2// *****************************************************************************
3// Tpetra: Templated Linear Algebra Services Package
4//
5// Copyright 2008 NTESS and the Tpetra contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef TPETRA_IMPORT_DECL_HPP
11#define TPETRA_IMPORT_DECL_HPP
12
13#include "Tpetra_Details_Transfer.hpp"
14#include "Tpetra_Import_fwd.hpp"
15#include "Tpetra_Export_fwd.hpp"
16
17namespace Tpetra {
18
74template <class LocalOrdinal,
75 class GlobalOrdinal,
76 class Node>
77class Import : public ::Tpetra::Details::Transfer<LocalOrdinal, GlobalOrdinal, Node> {
78 private:
79 friend class Export<LocalOrdinal, GlobalOrdinal, Node>;
80 using base_type =
81 ::Tpetra::Details::Transfer<LocalOrdinal, GlobalOrdinal, Node>;
82
83 public:
85 using map_type = ::Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node>;
86
88
89
97 Import(const Teuchos::RCP<const map_type>& source,
98 const Teuchos::RCP<const map_type>& target);
99
110 Import(const Teuchos::RCP<const map_type>& source,
111 const Teuchos::RCP<const map_type>& target,
112 const Teuchos::RCP<Teuchos::FancyOStream>& out);
113
126 Import(const Teuchos::RCP<const map_type>& source,
127 const Teuchos::RCP<const map_type>& target,
128 const Teuchos::RCP<Teuchos::ParameterList>& plist);
129
145 Import(const Teuchos::RCP<const map_type>& source,
146 const Teuchos::RCP<const map_type>& target,
147 const Teuchos::RCP<Teuchos::FancyOStream>& out,
148 const Teuchos::RCP<Teuchos::ParameterList>& plist);
149
163 Import(const Teuchos::RCP<const map_type>& source,
164 const Teuchos::RCP<const map_type>& target,
165 Teuchos::Array<int>& remotePIDs,
166 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::rcp(new Teuchos::ParameterList));
167
172 Import(const Import<LocalOrdinal, GlobalOrdinal, Node>& importer);
173
180 Import(const Export<LocalOrdinal, GlobalOrdinal, Node>& exporter);
181
212 Import(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& sourceMap,
213 const GlobalOrdinal targetMapRemoteOrPermuteGlobalIndices[],
214 const int targetMapRemoteOrPermuteProcessRanks[],
215 const LocalOrdinal numTargetMapRemoteOrPermuteGlobalIndices,
216 const bool mayReorderTargetMapIndicesLocally,
217 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null,
218 const Teuchos::RCP<Teuchos::FancyOStream>& out = Teuchos::null);
219
221 Import(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& source,
222 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& target,
223 const Teuchos::ArrayView<int>& remotePIDs,
224 const Teuchos::ArrayView<const LocalOrdinal>& userExportLIDs,
225 const Teuchos::ArrayView<const int>& userExportPIDs,
226 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null,
227 const Teuchos::RCP<Teuchos::FancyOStream>& out = Teuchos::null);
228
230 Import<LocalOrdinal, GlobalOrdinal, Node>&
231 operator=(const Import<LocalOrdinal, GlobalOrdinal, Node>& Source) = default;
232
234 virtual ~Import() = default;
235
237
239
248 void
249 findUnionTargetGIDs(Teuchos::Array<GlobalOrdinal>& unionTgtGIDs,
250 Teuchos::Array<std::pair<int, GlobalOrdinal>>& remotePGIDs,
251 typename Teuchos::Array<GlobalOrdinal>::size_type& numSameGIDs,
252 typename Teuchos::Array<GlobalOrdinal>::size_type& numPermuteGIDs,
253 typename Teuchos::Array<GlobalOrdinal>::size_type& numRemoteGIDs,
254 const Teuchos::ArrayView<const GlobalOrdinal>& sameGIDs1,
255 const Teuchos::ArrayView<const GlobalOrdinal>& sameGIDs2,
256 Teuchos::Array<GlobalOrdinal>& permuteGIDs1,
257 Teuchos::Array<GlobalOrdinal>& permuteGIDs2,
258 Teuchos::Array<GlobalOrdinal>& remoteGIDs1,
259 Teuchos::Array<GlobalOrdinal>& remoteGIDs2,
260 Teuchos::Array<int>& remotePIDs1,
261 Teuchos::Array<int>& remotePIDs2) const;
262
296 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>>
297 setUnion(const Import<LocalOrdinal, GlobalOrdinal, Node>& rhs) const;
298
315 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>>
316 setUnion() const;
317
322 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>>
323 createRemoteOnlyImport(const Teuchos::RCP<const map_type>& remoteTarget) const;
324
326
328
351 virtual void
352 describe(Teuchos::FancyOStream& out,
353 const Teuchos::EVerbosityLevel verbLevel =
354 Teuchos::Describable::verbLevel_default) const;
355
371 virtual void print(std::ostream& os) const;
372
374 private:
376
377
394 void
395 init(const Teuchos::RCP<const map_type>& source,
396 const Teuchos::RCP<const map_type>& target,
397 bool useRemotePIDs,
398 Teuchos::Array<int>& remotePIDs,
399 const Teuchos::RCP<Teuchos::ParameterList>& plist);
400
432 void setupSamePermuteRemote(Teuchos::Array<GlobalOrdinal>& remoteGIDs);
433
462 void
463 setupExport(Teuchos::Array<GlobalOrdinal>& remoteGIDs,
464 bool useRemotePIDs, Teuchos::Array<int>& remotePIDs,
465 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null);
467
475 Import(const Teuchos::RCP<const map_type>& source,
476 const Teuchos::RCP<const map_type>& target,
477 const size_t numSameID,
478 Teuchos::Array<LocalOrdinal>& permuteToLIDs,
479 Teuchos::Array<LocalOrdinal>& permuteFromLIDs,
480 Teuchos::Array<LocalOrdinal>& remoteLIDs,
481 Teuchos::Array<LocalOrdinal>& exportLIDs,
482 Teuchos::Array<int>& exportPIDs,
483 Distributor& distributor,
484 const Teuchos::RCP<Teuchos::FancyOStream>& out = Teuchos::null,
485 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null);
486
487}; // class Import
488
498template <class LocalOrdinal, class GlobalOrdinal, class Node>
499Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>>
500createImport(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& src,
501 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& tgt) {
502 if (src == tgt) {
503 return Teuchos::null;
504 }
505#ifdef HAVE_TPETRA_DEBUG
506 TEUCHOS_TEST_FOR_EXCEPTION(
507 src == Teuchos::null || tgt == Teuchos::null, std::runtime_error,
508 "Tpetra::createImport: Neither source nor target Map may be null.");
509#endif // HAVE_TPETRA_DEBUG
510 using import_type = Import<LocalOrdinal, GlobalOrdinal, Node>;
511 return Teuchos::rcp(new import_type(src, tgt));
512}
513
524template <class LocalOrdinal, class GlobalOrdinal, class Node>
525Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>>
526createImport(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& src,
527 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& tgt,
528 const Teuchos::RCP<Teuchos::ParameterList>& plist) {
529 if (src == tgt) {
530 return Teuchos::null;
531 }
532#ifdef HAVE_TPETRA_DEBUG
533 TEUCHOS_TEST_FOR_EXCEPTION(
534 src == Teuchos::null || tgt == Teuchos::null, std::runtime_error,
535 "Tpetra::createImport(): neither source nor target map may be null:"
536 << std::endl
537 << "source: " << src << std::endl
538 << "target: " << tgt
539 << std::endl);
540#endif // HAVE_TPETRA_DEBUG
541 typedef Import<LocalOrdinal, GlobalOrdinal, Node> import_type;
542 return Teuchos::rcp(new import_type(src, tgt, plist));
543}
544
545} // namespace Tpetra
546
547#endif // TPETRA_IMPORT_DECL_HPP
Tpetra_Export_fwd.hpp
Forward declaration of Tpetra::Export.
Tpetra_Import_fwd.hpp
Forward declaration of Tpetra::Import.
Tpetra::CrsMatrixStruct
Struct that holds views of the contents of a CrsMatrix.
Definition TpetraExt_MMHelpers_decl.hpp:36
Tpetra::Details::Transfer
Common base class of Import and Export.
Definition Tpetra_Details_Transfer_decl.hpp:47
Tpetra::Distributor
Sets up and executes a communication plan for a Tpetra DistObject.
Definition Tpetra_Distributor.hpp:95
Tpetra::Export
Communication plan for data redistribution from a (possibly) multiply-owned to a uniquely-owned distr...
Definition Tpetra_Export_decl.hpp:86
Tpetra::Import
Communication plan for data redistribution from a uniquely-owned to a (possibly) multiply-owned distr...
Definition Tpetra_Import_decl.hpp:77
Tpetra::Import::setUnion
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > setUnion() const
Return the union of this Import this->getSourceMap()
Definition Tpetra_Import_def.hpp:1523
Tpetra::Import::describe
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Describe this object in a human-readable way to the given output stream.
Definition Tpetra_Import_def.hpp:859
Tpetra::Import::createImport
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > createImport(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &src, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &tgt, const Teuchos::RCP< Teuchos::ParameterList > &plist)
Nonmember constructor for Import that takes a ParameterList.
Definition Tpetra_Import_decl.hpp:526
Tpetra::Import::createRemoteOnlyImport
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > createRemoteOnlyImport(const Teuchos::RCP< const map_type > &remoteTarget) const
Returns an importer that contains only the remote entries of this.
Definition Tpetra_Import_def.hpp:1596
Tpetra::Import::createImport
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > createImport(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &src, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &tgt)
Nonmember constructor for Import.
Definition Tpetra_Import_decl.hpp:500
Tpetra::Import::findUnionTargetGIDs
void findUnionTargetGIDs(Teuchos::Array< GlobalOrdinal > &unionTgtGIDs, Teuchos::Array< std::pair< int, GlobalOrdinal > > &remotePGIDs, typename Teuchos::Array< GlobalOrdinal >::size_type &numSameGIDs, typename Teuchos::Array< GlobalOrdinal >::size_type &numPermuteGIDs, typename Teuchos::Array< GlobalOrdinal >::size_type &numRemoteGIDs, const Teuchos::ArrayView< const GlobalOrdinal > &sameGIDs1, const Teuchos::ArrayView< const GlobalOrdinal > &sameGIDs2, Teuchos::Array< GlobalOrdinal > &permuteGIDs1, Teuchos::Array< GlobalOrdinal > &permuteGIDs2, Teuchos::Array< GlobalOrdinal > &remoteGIDs1, Teuchos::Array< GlobalOrdinal > &remoteGIDs2, Teuchos::Array< int > &remotePIDs1, Teuchos::Array< int > &remotePIDs2) const
Find the union of the target IDs from two Import objects.
Definition Tpetra_Import_def.hpp:1210
Tpetra::Import::print
virtual void print(std::ostream &os) const
Print the Import's data to the given output stream.
Definition Tpetra_Import_def.hpp:867
Tpetra::Import::~Import
virtual ~Import()=default
Destructor.
Tpetra::Import::operator=
Import< LocalOrdinal, GlobalOrdinal, Node > & operator=(const Import< LocalOrdinal, GlobalOrdinal, Node > &Source)=default
Assignment operator.
Tpetra::Map
A parallel distribution of indices over processes.
Definition Tpetra_Map_decl.hpp:196
Tpetra
Namespace Tpetra contains the class and methods constituting the Tpetra library.
Generated by doxygen 1.9.8