Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 
17 namespace Tpetra {
18 
74  template<class LocalOrdinal,
75  class GlobalOrdinal,
76  class Node>
77  class Import:
78  public ::Tpetra::Details::Transfer<LocalOrdinal, GlobalOrdinal, Node>
79  {
80  private:
81  friend class Export<LocalOrdinal,GlobalOrdinal,Node>;
82  using base_type =
83  ::Tpetra::Details::Transfer<LocalOrdinal, GlobalOrdinal, Node>;
84  public:
86  using map_type = ::Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node>;
87 
89 
90 
98  Import (const Teuchos::RCP<const map_type>& source,
99  const Teuchos::RCP<const map_type>& target);
100 
111  Import (const Teuchos::RCP<const map_type>& source,
112  const Teuchos::RCP<const map_type>& target,
113  const Teuchos::RCP<Teuchos::FancyOStream>& out);
114 
127  Import (const Teuchos::RCP<const map_type>& source,
128  const Teuchos::RCP<const map_type>& target,
129  const Teuchos::RCP<Teuchos::ParameterList>& plist);
130 
146  Import (const Teuchos::RCP<const map_type>& source,
147  const Teuchos::RCP<const map_type>& target,
148  const Teuchos::RCP<Teuchos::FancyOStream>& out,
149  const Teuchos::RCP<Teuchos::ParameterList>& plist);
150 
162  Import (const Teuchos::RCP<const map_type>& source,
163  const Teuchos::RCP<const map_type>& target,
164  Teuchos::Array<int> & remotePIDs,
165  const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::rcp(new Teuchos::ParameterList) );
166 
171  Import (const Import<LocalOrdinal,GlobalOrdinal,Node>& importer);
172 
179  Import (const Export<LocalOrdinal,GlobalOrdinal,Node>& exporter);
180 
211  Import (const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& sourceMap,
212  const GlobalOrdinal targetMapRemoteOrPermuteGlobalIndices[],
213  const int targetMapRemoteOrPermuteProcessRanks[],
214  const LocalOrdinal numTargetMapRemoteOrPermuteGlobalIndices,
215  const bool mayReorderTargetMapIndicesLocally,
216  const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null,
217  const Teuchos::RCP<Teuchos::FancyOStream>& out = Teuchos::null);
218 
220  Import (const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& source,
221  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& target,
222  const Teuchos::ArrayView<int> & remotePIDs,
223  const Teuchos::ArrayView<const LocalOrdinal> & userExportLIDs,
224  const Teuchos::ArrayView<const int> & userExportPIDs,
225  const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null,
226  const Teuchos::RCP<Teuchos::FancyOStream>& out = Teuchos::null);
227 
229  Import<LocalOrdinal,GlobalOrdinal,Node>&
230  operator= (const Import<LocalOrdinal,GlobalOrdinal,Node>& Source) = default;
231 
233  virtual ~Import () = default;
234 
236 
238 
247  void
248  findUnionTargetGIDs(Teuchos::Array<GlobalOrdinal>& unionTgtGIDs,
249  Teuchos::Array<std::pair<int,GlobalOrdinal>>& remotePGIDs,
250  typename Teuchos::Array<GlobalOrdinal>::size_type& numSameGIDs,
251  typename Teuchos::Array<GlobalOrdinal>::size_type& numPermuteGIDs,
252  typename Teuchos::Array<GlobalOrdinal>::size_type& numRemoteGIDs,
253  const Teuchos::ArrayView<const GlobalOrdinal>& sameGIDs1,
254  const Teuchos::ArrayView<const GlobalOrdinal>& sameGIDs2,
255  Teuchos::Array<GlobalOrdinal>& permuteGIDs1,
256  Teuchos::Array<GlobalOrdinal>& permuteGIDs2,
257  Teuchos::Array<GlobalOrdinal>& remoteGIDs1,
258  Teuchos::Array<GlobalOrdinal>& remoteGIDs2,
259  Teuchos::Array<int>& remotePIDs1,
260  Teuchos::Array<int>& remotePIDs2) const;
261 
295  Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
296  setUnion (const Import<LocalOrdinal, GlobalOrdinal, Node>& rhs) const;
297 
314  Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
315  setUnion () const;
316 
321  Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
322  createRemoteOnlyImport (const Teuchos::RCP<const map_type>& remoteTarget) const;
323 
325 
327 
350  virtual void
351  describe (Teuchos::FancyOStream& out,
352  const Teuchos::EVerbosityLevel verbLevel =
353  Teuchos::Describable::verbLevel_default) const;
354 
370  virtual void print (std::ostream& os) const;
371 
373  private:
375 
376 
393  void
394  init (const Teuchos::RCP<const map_type>& source,
395  const Teuchos::RCP<const map_type>& target,
396  bool useRemotePIDs,
397  Teuchos::Array<int> & remotePIDs,
398  const Teuchos::RCP<Teuchos::ParameterList>& plist);
399 
431  void setupSamePermuteRemote (Teuchos::Array<GlobalOrdinal>& remoteGIDs);
432 
461  void
462  setupExport (Teuchos::Array<GlobalOrdinal>& remoteGIDs,
463  bool useRemotePIDs, Teuchos::Array<int> & remotePIDs,
464  const Teuchos::RCP<Teuchos::ParameterList>& plist= Teuchos::null);
466 
474  Import (const Teuchos::RCP<const map_type>& source,
475  const Teuchos::RCP<const map_type>& target,
476  const size_t numSameID,
477  Teuchos::Array<LocalOrdinal>& permuteToLIDs,
478  Teuchos::Array<LocalOrdinal>& permuteFromLIDs,
479  Teuchos::Array<LocalOrdinal>& remoteLIDs,
480  Teuchos::Array<LocalOrdinal>& exportLIDs,
481  Teuchos::Array<int>& exportPIDs,
482  Distributor& distributor,
483  const Teuchos::RCP<Teuchos::FancyOStream>& out = Teuchos::null,
484  const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null);
485 
486 
487  }; // class Import
488 
498  template<class LocalOrdinal, class GlobalOrdinal, class Node>
499  Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
500  createImport (const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& src,
501  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& tgt)
502  {
503  if (src == tgt) {
504  return Teuchos::null;
505  }
506 #ifdef HAVE_TPETRA_DEBUG
507  TEUCHOS_TEST_FOR_EXCEPTION(
508  src == Teuchos::null || tgt == Teuchos::null, std::runtime_error,
509  "Tpetra::createImport: Neither source nor target Map may be null.");
510 #endif // HAVE_TPETRA_DEBUG
511  using import_type = Import<LocalOrdinal, GlobalOrdinal, Node>;
512  return Teuchos::rcp (new import_type (src, tgt));
513  }
514 
525  template<class LocalOrdinal, class GlobalOrdinal, class Node>
526  Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
527  createImport (const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& src,
528  const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& tgt,
529  const Teuchos::RCP<Teuchos::ParameterList>& plist)
530  {
531  if (src == tgt) {
532  return Teuchos::null;
533  }
534 #ifdef HAVE_TPETRA_DEBUG
535  TEUCHOS_TEST_FOR_EXCEPTION(
536  src == Teuchos::null || tgt == Teuchos::null, std::runtime_error,
537  "Tpetra::createImport(): neither source nor target map may be null:"
538  << std::endl << "source: " << src << std::endl << "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::Import
Communication plan for data redistribution from a uniquely-owned to a (possibly) multiply-owned distr...
Definition: Tpetra_Import_decl.hpp:77
Tpetra::Details::Transfer
Common base class of Import and Export.
Definition: Tpetra_Details_Transfer_decl.hpp:50
Tpetra::Import::operator=
Import< LocalOrdinal, GlobalOrdinal, Node > & operator=(const Import< LocalOrdinal, GlobalOrdinal, Node > &Source)=default
Assignment operator.
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:1724
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:908
Tpetra::Import::setUnion
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > setUnion() const
Return the union of this Import this-&gt;getSourceMap()
Definition: Tpetra_Import_def.hpp:1653
Tpetra_Export_fwd.hpp
Forward declaration of Tpetra::Export.
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:158
Tpetra_Import_fwd.hpp
Forward declaration of Tpetra::Import.
Tpetra::Export
Communication plan for data redistribution from a (possibly) multiply-owned to a uniquely-owned distr...
Definition: Tpetra_Export_decl.hpp:85
Tpetra::Distributor
Sets up and executes a communication plan for a Tpetra DistObject.
Definition: Tpetra_Distributor.hpp:103
Tpetra::Import::~Import
virtual ~Import()=default
Destructor.
Tpetra::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:1291
Tpetra::Map
A parallel distribution of indices over processes.
Definition: Tpetra_Map_decl.hpp:198
Tpetra::Import::print
virtual void print(std::ostream &os) const
Print the Import&#39;s data to the given output stream.
Definition: Tpetra_Import_def.hpp:917
Generated on Fri Nov 22 2024 09:17:31 for Tpetra parallel linear algebra by   doxygen 1.8.5