42 #ifndef TPETRA_IMPORT_DECL_HPP 43 #define TPETRA_IMPORT_DECL_HPP 45 #include <Tpetra_Details_Transfer.hpp> 53 #ifndef DOXYGEN_SHOULD_SKIP_THIS 54 template<
class LocalOrdinal,
class GlobalOrdinal,
class Node>
55 class ImportExportData;
57 template<
class LocalOrdinal,
class GlobalOrdinal,
class Node>
59 #endif // DOXYGEN_SHOULD_SKIP_THIS 122 class GlobalOrdinal = ::Tpetra::Details::DefaultTypes::global_ordinal_type,
128 friend class Export<LocalOrdinal,GlobalOrdinal,Node>;
132 typedef ::Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node>
map_type;
144 Import (
const Teuchos::RCP<const map_type>& source,
145 const Teuchos::RCP<const map_type>& target);
157 Import (
const Teuchos::RCP<const map_type>& source,
158 const Teuchos::RCP<const map_type>& target,
159 const Teuchos::RCP<Teuchos::FancyOStream>& out);
173 Import (
const Teuchos::RCP<const map_type>& source,
174 const Teuchos::RCP<const map_type>& target,
175 const Teuchos::RCP<Teuchos::ParameterList>& plist);
192 Import (
const Teuchos::RCP<const map_type>& source,
193 const Teuchos::RCP<const map_type>& target,
194 const Teuchos::RCP<Teuchos::FancyOStream>& out,
195 const Teuchos::RCP<Teuchos::ParameterList>& plist);
208 Import (
const Teuchos::RCP<const map_type>& source,
209 const Teuchos::RCP<const map_type>& target,
210 Teuchos::Array<int> & remotePIDs);
232 Teuchos::Array<int> & userRemotePIDs,
233 Teuchos::Array<GlobalOrdinal>& remoteGIDs,
234 const Teuchos::ArrayView<const LocalOrdinal> & userExportLIDs,
235 const Teuchos::ArrayView<const int> & userExportPIDs,
236 const bool useRemotePIDs,
237 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null,
238 const Teuchos::RCP<Teuchos::FancyOStream>& out = Teuchos::null);
278 Teuchos::ArrayView<const LocalOrdinal>
getRemoteLIDs()
const;
284 Teuchos::ArrayView<const LocalOrdinal>
getExportLIDs()
const;
350 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
369 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
377 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
408 describe (Teuchos::FancyOStream& out,
409 const Teuchos::EVerbosityLevel verbLevel =
410 Teuchos::Describable::verbLevel_default)
const;
427 virtual void print (std::ostream& os)
const;
432 Teuchos::RCP<ImportExportData<LocalOrdinal,GlobalOrdinal,Node> > ImportData_;
434 Teuchos::RCP<Teuchos::FancyOStream> out_;
458 init (
const Teuchos::RCP<const map_type>& source,
459 const Teuchos::RCP<const map_type>& target,
461 Teuchos::Array<int> & remotePIDs,
462 const Teuchos::RCP<Teuchos::ParameterList>& plist);
495 void setupSamePermuteRemote (Teuchos::Array<GlobalOrdinal>& remoteGIDs);
526 setupExport (Teuchos::Array<GlobalOrdinal>& remoteGIDs,
bool useRemotePIDs, Teuchos::Array<int> & remotePIDs);
536 Import (
const Teuchos::RCP<const map_type>& source,
537 const Teuchos::RCP<const map_type>& target,
538 const size_t numSameID,
539 Teuchos::Array<LocalOrdinal>& permuteToLIDs,
540 Teuchos::Array<LocalOrdinal>& permuteFromLIDs,
541 Teuchos::Array<LocalOrdinal>& remoteLIDs,
542 Teuchos::Array<LocalOrdinal>& exportLIDs,
543 Teuchos::Array<int>& exportPIDs,
545 const Teuchos::RCP<Teuchos::FancyOStream>& out = Teuchos::null,
546 const Teuchos::RCP<Teuchos::ParameterList>& plist = Teuchos::null);
561 template<
class LocalOrdinal,
class GlobalOrdinal,
class Node>
562 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
567 return Teuchos::null;
569 #ifdef HAVE_TPETRA_DEBUG 570 TEUCHOS_TEST_FOR_EXCEPTION(
571 src == Teuchos::null || tgt == Teuchos::null, std::runtime_error,
572 "Tpetra::createImport(): neither source nor target map may be null:" 573 << std::endl <<
"source: " << src << std::endl <<
"target: " << tgt
575 #endif // HAVE_TPETRA_DEBUG 577 return Teuchos::rcp (
new import_type (src, tgt));
591 template<
class LocalOrdinal,
class GlobalOrdinal,
class Node>
592 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> >
595 const Teuchos::RCP<Teuchos::ParameterList>& plist)
598 return Teuchos::null;
600 #ifdef HAVE_TPETRA_DEBUG 601 TEUCHOS_TEST_FOR_EXCEPTION(
602 src == Teuchos::null || tgt == Teuchos::null, std::runtime_error,
603 "Tpetra::createImport(): neither source nor target map may be null:" 604 << std::endl <<
"source: " << src << std::endl <<
"target: " << tgt
606 #endif // HAVE_TPETRA_DEBUG 608 return Teuchos::rcp (
new import_type (src, tgt, plist));
613 #endif // TPETRA_IMPORT_DECL_HPP Communication plan for data redistribution from a uniquely-owned to a (possibly) multiply-owned distr...
::Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > map_type
The specialization of Map used by this class.
Namespace Tpetra contains the class and methods constituting the Tpetra library.
Teuchos::ArrayView< const int > getExportPIDs() const
List of processes to which entries will be sent.
Teuchos::ArrayView< const LocalOrdinal > getExportLIDs() const
List of entries in the source Map that will be sent to other processes.
Common base class of Import and Export.
Teuchos::RCP< const map_type > getSourceMap() const
The Source Map used to construct this Import object.
KokkosClassic::DefaultNode::DefaultNodeType node_type
Default value of Node template parameter.
Teuchos::ArrayView< const LocalOrdinal > getPermuteToLIDs() const
List of local IDs in the target Map that are permuted.
virtual ~Import()
Destructor.
int local_ordinal_type
Default value of LocalOrdinal template parameter.
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > setUnion() const
Return the union of this Import this->getSourceMap()
bool isLocallyComplete() const
Do all target Map indices on the calling process exist on at least one process (not necessarily this ...
Import(const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target)
Construct an Import from the source and target Maps.
Teuchos::ArrayView< const LocalOrdinal > getPermuteFromLIDs() const
List of local IDs in the source Map that are permuted.
size_t getNumPermuteIDs() const
Number of IDs to permute but not to communicate.
Teuchos::ArrayView< const LocalOrdinal > getRemoteLIDs() const
List of entries in the target Map to receive from other processes.
Communication plan for data redistribution from a (possibly) multiply-owned to a uniquely-owned distr...
Teuchos::RCP< const map_type > getTargetMap() const
The Target Map used to construct this Import object.
Import< LocalOrdinal, GlobalOrdinal, Node > & operator=(const Import< LocalOrdinal, GlobalOrdinal, Node > &Source)
Assignment operator.
Sets up and executes a communication plan for a Tpetra DistObject.
size_t getNumRemoteIDs() const
Number of entries not on the calling process.
void setParameterList(const Teuchos::RCP< Teuchos::ParameterList > &plist)
Set parameters.
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.
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.
size_t getNumExportIDs() const
Number of entries that must be sent by the calling process to other processes.
virtual void print(std::ostream &os) const
Print the Import's data to the given output stream.
Describes a parallel distribution of objects over processes.
size_t getNumSameIDs() const
Number of initial identical IDs.
Distributor & getDistributor() const
The Distributor that this Import object uses to move data.
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.