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
214 Import(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& sourceMap,
215 const GlobalOrdinal targetMapRemoteOrPermuteGlobalIndices[],
216 const int targetMapRemoteOrPermuteProcessRanks[],
217 const LocalOrdinal numTargetMapRemoteOrPermuteGlobalIndices,
218 const bool mayReorderTargetMapIndicesLocally,
219 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null,
220 const Teuchos::RCP<Teuchos::FancyOStream>& out = Teuchos::null);
221
223 Import(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& source,
224 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& target,
225 const Teuchos::ArrayView<int>& remotePIDs,
226 const Teuchos::ArrayView<const LocalOrdinal>& userExportLIDs,
227 const Teuchos::ArrayView<const int>& userExportPIDs,
228 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null,
229 const Teuchos::RCP<Teuchos::FancyOStream>& out = Teuchos::null);
230
232 Import<LocalOrdinal, GlobalOrdinal, Node>&
233 operator=(const Import<LocalOrdinal, GlobalOrdinal, Node>& Source) = default;
234
236 virtual ~Import() = default;
237
239
241
250 void
251 findUnionTargetGIDs(Teuchos::Array<GlobalOrdinal>& unionTgtGIDs,
252 Teuchos::Array<std::pair<int, GlobalOrdinal>>& remotePGIDs,
253 typename Teuchos::Array<GlobalOrdinal>::size_type& numSameGIDs,
254 typename Teuchos::Array<GlobalOrdinal>::size_type& numPermuteGIDs,
255 typename Teuchos::Array<GlobalOrdinal>::size_type& numRemoteGIDs,
256 const Teuchos::ArrayView<const GlobalOrdinal>& sameGIDs1,
257 const Teuchos::ArrayView<const GlobalOrdinal>& sameGIDs2,
258 Teuchos::Array<GlobalOrdinal>& permuteGIDs1,
259 Teuchos::Array<GlobalOrdinal>& permuteGIDs2,
260 Teuchos::Array<GlobalOrdinal>& remoteGIDs1,
261 Teuchos::Array<GlobalOrdinal>& remoteGIDs2,
262 Teuchos::Array<int>& remotePIDs1,
263 Teuchos::Array<int>& remotePIDs2) const;
264
298 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>>
299 setUnion(const Import<LocalOrdinal, GlobalOrdinal, Node>& rhs,
300 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null) const;
301
318 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>>
319 setUnion(const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null) const;
320
325 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>>
326 createRemoteOnlyImport(const Teuchos::RCP<const map_type>& remoteTarget) const;
327
329
331
354 virtual void
355 describe(Teuchos::FancyOStream& out,
356 const Teuchos::EVerbosityLevel verbLevel =
357 Teuchos::Describable::verbLevel_default) const;
358
374 virtual void print(std::ostream& os) const;
375
377 private:
379
380
397 void
398 init(const Teuchos::RCP<const map_type>& source,
399 const Teuchos::RCP<const map_type>& target,
400 bool useRemotePIDs,
401 Teuchos::Array<int>& remotePIDs,
402 const Teuchos::RCP<Teuchos::ParameterList>& plist);
403
435 void setupSamePermuteRemote(Teuchos::Array<GlobalOrdinal>& remoteGIDs);
436
465 void
466 setupExport(Teuchos::Array<GlobalOrdinal>& remoteGIDs,
467 bool useRemotePIDs, Teuchos::Array<int>& remotePIDs,
468 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null);
470
478 Import(const Teuchos::RCP<const map_type>& source,
479 const Teuchos::RCP<const map_type>& target,
480 const size_t numSameID,
481 Teuchos::Array<LocalOrdinal>& permuteToLIDs,
482 Teuchos::Array<LocalOrdinal>& permuteFromLIDs,
483 Teuchos::Array<LocalOrdinal>& remoteLIDs,
484 Teuchos::Array<LocalOrdinal>& exportLIDs,
485 Teuchos::Array<int>& exportPIDs,
486 Distributor& distributor,
487 const Teuchos::RCP<Teuchos::FancyOStream>& out = Teuchos::null,
488 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null);
489
490}; // class Import
491
501template <class LocalOrdinal, class GlobalOrdinal, class Node>
502Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>>
503createImport(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& src,
504 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& tgt) {
505 if (src == tgt) {
506 return Teuchos::null;
507 }
508#ifdef HAVE_TPETRA_DEBUG
509 TEUCHOS_TEST_FOR_EXCEPTION(
510 src == Teuchos::null || tgt == Teuchos::null, std::runtime_error,
511 "Tpetra::createImport: Neither source nor target Map may be null.");
512#endif // HAVE_TPETRA_DEBUG
513 using import_type = Import<LocalOrdinal, GlobalOrdinal, Node>;
514 return Teuchos::rcp(new import_type(src, tgt));
515}
516
527template <class LocalOrdinal, class GlobalOrdinal, class Node>
528Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node>>
529createImport(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& src,
530 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& tgt,
531 const Teuchos::RCP<Teuchos::ParameterList>& plist) {
532 if (src == tgt) {
533 return Teuchos::null;
534 }
535#ifdef HAVE_TPETRA_DEBUG
536 TEUCHOS_TEST_FOR_EXCEPTION(
537 src == Teuchos::null || tgt == Teuchos::null, std::runtime_error,
538 "Tpetra::createImport(): neither source nor target map may be null:"
539 << std::endl
540 << "source: " << src << std::endl
541 << "target: " << tgt
542 << std::endl);
543#endif // HAVE_TPETRA_DEBUG
544 typedef Import<LocalOrdinal, GlobalOrdinal, Node> import_type;
545 return Teuchos::rcp(new import_type(src, tgt, plist));
546}
547
548} // namespace Tpetra
549
550#endif // TPETRA_IMPORT_DECL_HPP
Tpetra_Export_fwd.hpp
Forward declaration of Tpetra::Export.
Tpetra_Import_fwd.hpp
Forward declaration of Tpetra::Import.
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::Import
Import(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target, const Teuchos::RCP< Teuchos::FancyOStream > &out)
Construct an Import from the source and target Maps, with an output stream for debugging output.
Definition Tpetra_Import_def.hpp:145
Tpetra::Import::Import
Import(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target, const Teuchos::RCP< Teuchos::ParameterList > &plist)
Constructor (with list of parameters).
Definition Tpetra_Import_def.hpp:155
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:855
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:529
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:1623
Tpetra::Import::Import
Import(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
Construct an Import from the source and target Maps.
Definition Tpetra_Import_def.hpp:136
Tpetra::Import::Import
Import(const Import< LocalOrdinal, GlobalOrdinal, Node > &importer)
Copy constructor.
Definition Tpetra_Import_def.hpp:186
Tpetra::Import::Import
Import(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &sourceMap, const GlobalOrdinal targetMapRemoteOrPermuteGlobalIndices[], const int targetMapRemoteOrPermuteProcessRanks[], const LocalOrdinal numTargetMapRemoteOrPermuteGlobalIndices, const bool mayReorderTargetMapIndicesLocally, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::null, const Teuchos::RCP< Teuchos::FancyOStream > &out=Teuchos::null)
Constructor that computes optimized target Map.
Definition Tpetra_Import_def.hpp:717
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:503
Tpetra::Import::Import
Import(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target, Teuchos::Array< int > &remotePIDs, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::rcp(new Teuchos::ParameterList))
Construct an Import from the source and target Maps.
Definition Tpetra_Import_def.hpp:176
Tpetra::Import::setUnion
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > setUnion(const Import< LocalOrdinal, GlobalOrdinal, Node > &rhs, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null) const
Return the union of this Import and rhs.
Definition Tpetra_Import_def.hpp:1310
Tpetra::Import< local_ordinal_type, global_ordinal_type, node_type >::map_type
::Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > map_type
Definition Tpetra_Import_decl.hpp:85
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::setUnion
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > setUnion(const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null) const
Return the union of this Import this->getSourceMap().
Definition Tpetra_Import_def.hpp:1553
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:863
Tpetra::Import::Import
Import(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &source, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &target, const Teuchos::ArrayView< int > &remotePIDs, const Teuchos::ArrayView< const LocalOrdinal > &userExportLIDs, const Teuchos::ArrayView< const int > &userExportPIDs, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::null, const Teuchos::RCP< Teuchos::FancyOStream > &out=Teuchos::null)
Expert constructor.
Definition Tpetra_Import_def.hpp:199
Tpetra::Import::~Import
virtual ~Import()=default
Destructor.
Tpetra::Import::Import
Import(const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter)
"Copy" constructor from an Export object.
Definition Tpetra_Import_def.hpp:191
Tpetra::Import::Import
Import(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target, const Teuchos::RCP< Teuchos::FancyOStream > &out, const Teuchos::RCP< Teuchos::ParameterList > &plist)
Constructor (with list of parameters and debug output stream).
Definition Tpetra_Import_def.hpp:165
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.15.0