|
Tpetra parallel linear algebra
Version of the Day
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
|
Tpetra parallel linear algebra
Version of the Day
|
Communication plan for data redistribution from a uniquely-owned to a (possibly) multiply-owned distribution. More...
#include <Tpetra_Import_decl.hpp>
Public Types | |
| typedef ::Tpetra::Map < LocalOrdinal, GlobalOrdinal, Node > | map_type |
| The specialization of Map used by this class. More... | |
Public Member Functions | |
Constructor/Destructor Methods | |
| Import (const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target) | |
| Construct an Import from the source and target Maps. More... | |
| 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. More... | |
| 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) More... | |
| 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) More... | |
| Import (const Teuchos::RCP< const map_type > &source, const Teuchos::RCP< const map_type > &target, Teuchos::Array< int > &remotePIDs) | |
| Construct an Import from the source and target Maps. More... | |
| Import (const Import< LocalOrdinal, GlobalOrdinal, Node > &importer) | |
| Copy constructor. More... | |
| Import (const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter) | |
| "Copy" constructor from an Export object. More... | |
| 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. More... | |
| Import (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &source, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &target, Teuchos::Array< int > &userRemotePIDs, Teuchos::Array< GlobalOrdinal > &remoteGIDs, const Teuchos::ArrayView< const LocalOrdinal > &userExportLIDs, const Teuchos::ArrayView< const int > &userExportPIDs, const bool useRemotePIDs, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::null, const Teuchos::RCP< Teuchos::FancyOStream > &out=Teuchos::null) | |
| Expert constructor. More... | |
| virtual | ~Import () |
| Destructor. More... | |
| void | setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &plist) |
| Set parameters. More... | |
Import Attribute Methods | |
| size_t | getNumSameIDs () const |
| Number of initial identical IDs. More... | |
| size_t | getNumPermuteIDs () const |
| Number of IDs to permute but not to communicate. More... | |
| Teuchos::ArrayView< const LocalOrdinal > | getPermuteFromLIDs () const |
| List of local IDs in the source Map that are permuted. More... | |
| Teuchos::ArrayView< const LocalOrdinal > | getPermuteToLIDs () const |
| List of local IDs in the target Map that are permuted. More... | |
| size_t | getNumRemoteIDs () const |
| Number of entries not on the calling process. More... | |
| Teuchos::ArrayView< const LocalOrdinal > | getRemoteLIDs () const |
| List of entries in the target Map to receive from other processes. More... | |
| size_t | getNumExportIDs () const |
| Number of entries that must be sent by the calling process to other processes. More... | |
| Teuchos::ArrayView< const LocalOrdinal > | getExportLIDs () const |
| List of entries in the source Map that will be sent to other processes. More... | |
| Teuchos::ArrayView< const int > | getExportPIDs () const |
| List of processes to which entries will be sent. More... | |
| Teuchos::RCP< const map_type > | getSourceMap () const |
| The Source Map used to construct this Import object. More... | |
| Teuchos::RCP< const map_type > | getTargetMap () const |
| The Target Map used to construct this Import object. More... | |
| Distributor & | getDistributor () const |
| The Distributor that this Import object uses to move data. More... | |
| bool | isLocallyComplete () const |
| Do all target Map indices on the calling process exist on at least one process (not necessarily this one) in the source Map? More... | |
| Import< LocalOrdinal, GlobalOrdinal, Node > & | operator= (const Import< LocalOrdinal, GlobalOrdinal, Node > &Source) |
| Assignment operator. More... | |
| 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. More... | |
| Teuchos::RCP< const Import < LocalOrdinal, GlobalOrdinal, Node > > | setUnion (const Import< LocalOrdinal, GlobalOrdinal, Node > &rhs) const |
Return the union of this Import and rhs. More... | |
| Teuchos::RCP< const Import < LocalOrdinal, GlobalOrdinal, Node > > | setUnion () const |
| Return the union of this Import this->getSourceMap() More... | |
| 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. More... | |
I/O Methods | |
| 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. More... | |
| virtual void | print (std::ostream &os) const |
| Print the Import's data to the given output stream. More... | |
Protected Member Functions | |
| void | describeImpl (Teuchos::FancyOStream &out, const std::string &className, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const |
| Implementation of describe() for subclasses (Tpetra::Import and Tpetra::Export). More... | |
Communication plan for data redistribution from a uniquely-owned to a (possibly) multiply-owned distribution.
| LocalOrdinal | The type of local indices. See the documentation of Map for requirements. |
| GlobalOrdinal | The type of global indices. See the documentation of Map for requirements. |
| Node | The Kokkos Node type. See the documentation of Map for requirements. |
Tpetra users should use this class to construct a communication plan between two data distributions (i.e., two Map objects). The plan can be called repeatedly by computational classes to perform communication according to the same pattern. Constructing the plan may be expensive, both in terms of communication and computation. However, it can be reused inexpensively.
Tpetra has two classes for data redistribution: Import and Export. Import is for redistributing data from a uniquely-owned distribution to a possibly multiply-owned distribution. Export is for redistributing data from a possibly multiply-owned distribution to a uniquely-owned distribution.
The names "Import" and "Export" have nothing to do with the direction in which data moves relative to the calling process; any process may do both receives and sends in an Import or Export. Rather, the names suggest what happens in their most common use case, the communication pattern for sparse matrix-vector multiply. Import "brings in" remote source vector data (from the domain Map to the column Map) for local computation, and Export "pushes" the result back (from the row Map to the range Map). Import and Export have other uses as well.
As mentioned above, one use case of Import is bringing in remote source vector data for a distributed sparse matrix-vector multiply. The source vector itself is uniquely owned, but must be brought in into an overlapping distribution so that each process can compute its part of the target vector without further communication.
Epetra separated Import and Export for performance reasons. The implementation is different, depending on which direction is the uniquely-owned Map. Tpetra retains this convention.
This class is templated on the same template arguments as Map: the local ordinal type LocalOrdinal, the global ordinal type GlobalOrdinal, and the Kokkos Node type.
This method accepts an optional list of parameters, either through the constructor or through the setParameterList() method. Most users do not need to worry about these parameters; the default values are fine. However, for expert users, we expose the following parameter:
bool): Whether to execute a barrier between receives and sends, when executing the Import (i.e., when calling DistObject's doImport() (forward mode) or doExport() (reverse mode)). Definition at line 115 of file Tpetra_Import_decl.hpp.
| typedef ::Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node> Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::map_type |
The specialization of Map used by this class.
Definition at line 123 of file Tpetra_Import_decl.hpp.
| Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::Import | ( | const Teuchos::RCP< const map_type > & | source, |
| const Teuchos::RCP< const map_type > & | target | ||
| ) |
Construct an Import from the source and target Maps.
| source | [in] The source distribution. This must be a uniquely owned (nonoverlapping) distribution. |
| target | [in] The target distribution. This may be a multiply owned (overlapping) distribution. |
Definition at line 177 of file Tpetra_Import_def.hpp.
| Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::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.
| source | [in] The source distribution. This must be a uniquely owned (nonoverlapping) distribution. |
| target | [in] The target distribution. This may be a multiply owned (overlapping) distribution. |
| out | [in/out] Output stream for debugging output. |
Definition at line 188 of file Tpetra_Import_def.hpp.
| Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::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)
| source | [in] The source distribution. This must be a uniquely owned (nonoverlapping) distribution. |
| target | [in] The target distribution. This may be a multiply owned (overlapping) distribution. |
| plist | [in/out] List of parameters. Currently passed directly to the Distributor that implements communication. If you don't know what this should be, you should use the two-argument constructor, listed above. |
Definition at line 200 of file Tpetra_Import_def.hpp.
| Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::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)
| source | [in] The source distribution. This must be a uniquely owned (nonoverlapping) distribution. |
| target | [in] The target distribution. This may be a multiply owned (overlapping) distribution. |
| out | [in/out] Output stream (for printing copious debug output on all processes, if that option is enabled). |
| plist | [in/out] List of parameters. Currently passed directly to the Distributor that implements communication. If you don't know what this should be, you should use the two-argument constructor, listed above. |
Definition at line 212 of file Tpetra_Import_def.hpp.
| Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::Import | ( | const Teuchos::RCP< const map_type > & | source, |
| const Teuchos::RCP< const map_type > & | target, | ||
| Teuchos::Array< int > & | remotePIDs | ||
| ) |
Construct an Import from the source and target Maps.
| source | [in] The source distribution. This must be a uniquely owned (nonoverlapping) distribution. |
| target | [in] The target distribution. This may be a multiply owned (overlapping) distribution. |
| remotePIDs | [in] Owning PIDs corresponding to the remoteGIDs. If this information is available one can reduce the cost of the Import constructor. |
Definition at line 225 of file Tpetra_Import_def.hpp.
| Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::Import | ( | const Import< LocalOrdinal, GlobalOrdinal, Node > & | importer | ) |
Copy constructor.
Definition at line 236 of file Tpetra_Import_def.hpp.
| Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::Import | ( | const Export< LocalOrdinal, GlobalOrdinal, Node > & | exporter | ) |
"Copy" constructor from an Export object.
This constructor creates an Import object from the "reverse" of the given Export object. This method is mainly useful for Tpetra developers, for example when building the explicit transpose of a sparse matrix.
Definition at line 244 of file Tpetra_Import_def.hpp.
| Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::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.
Like every other Import constructor, this must be called collectively on all processes in the input Map's communicator.
sourceMap->isOneToOne() | sourceMap | [in] Source Map of the Import. |
| targetMapRemoteOrPermuteGlobalIndices | [in] On the calling process, the global indices that will go into the target Map. May differ on each process, just like Map's noncontiguous constructor. No index in here on this process may also appear in sourceMap on this process. |
| targetMapRemoteOrPermuteProcessRanks | [in] For k in 0, ..., numTargetMapRemoteOrPermuteGlobalIndices-1, targetMapRemoteOrPermuteProcessRanks[k] is the rank of the MPI process from which to receive data for global index targetMapRemoteOrPermuteGlobalIndices[k]. |
| numTargetMapRemoteOrPermuteGlobalIndices | [in] Number of valid entries in the two input arrays above. May differ on different processes. May be zero on some or even all processes. |
| mayReorderTargetMapIndicesLocally | [in] If true, then this constructor reserves the right to reorder the target Map indices on each process, for better communication performance. |
Definition at line 741 of file Tpetra_Import_def.hpp.
| Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::Import | ( | const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > & | source, |
| const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > & | target, | ||
| Teuchos::Array< int > & | userRemotePIDs, | ||
| Teuchos::Array< GlobalOrdinal > & | remoteGIDs, | ||
| const Teuchos::ArrayView< const LocalOrdinal > & | userExportLIDs, | ||
| const Teuchos::ArrayView< const int > & | userExportPIDs, | ||
| const bool | useRemotePIDs, | ||
| const Teuchos::RCP< Teuchos::ParameterList > & | plist = Teuchos::null, |
||
| const Teuchos::RCP< Teuchos::FancyOStream > & | out = Teuchos::null |
||
| ) |
Expert constructor.
Definition at line 257 of file Tpetra_Import_def.hpp.
|
virtual |
Destructor.
Definition at line 871 of file Tpetra_Import_def.hpp.
| void Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::setParameterList | ( | const Teuchos::RCP< Teuchos::ParameterList > & | plist | ) |
Set parameters.
Please see the class documentation for a list of all accepted parameters and their default values.
Definition at line 111 of file Tpetra_Import_def.hpp.
|
virtual |
Number of initial identical IDs.
The number of IDs that are identical between the source and target Maps, up to the first different ID.
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 875 of file Tpetra_Import_def.hpp.
|
virtual |
Number of IDs to permute but not to communicate.
The number of IDs that are local to the calling process, but not part of the first getNumSameIDs() entries. The Import will permute these entries locally (without distributed-memory communication).
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 880 of file Tpetra_Import_def.hpp.
|
virtual |
List of local IDs in the source Map that are permuted.
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 886 of file Tpetra_Import_def.hpp.
|
virtual |
List of local IDs in the target Map that are permuted.
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 892 of file Tpetra_Import_def.hpp.
|
virtual |
Number of entries not on the calling process.
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 897 of file Tpetra_Import_def.hpp.
|
virtual |
List of entries in the target Map to receive from other processes.
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 903 of file Tpetra_Import_def.hpp.
|
virtual |
Number of entries that must be sent by the calling process to other processes.
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 908 of file Tpetra_Import_def.hpp.
|
virtual |
List of entries in the source Map that will be sent to other processes.
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 914 of file Tpetra_Import_def.hpp.
|
virtual |
List of processes to which entries will be sent.
The entry with Local ID getExportLIDs()[i] will be sent to process getExportPIDs()[i].
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 920 of file Tpetra_Import_def.hpp.
|
virtual |
The Source Map used to construct this Import object.
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 926 of file Tpetra_Import_def.hpp.
|
virtual |
The Target Map used to construct this Import object.
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 932 of file Tpetra_Import_def.hpp.
|
virtual |
The Distributor that this Import object uses to move data.
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 938 of file Tpetra_Import_def.hpp.
|
virtual |
Do all target Map indices on the calling process exist on at least one process (not necessarily this one) in the source Map?
It's not necessarily an error for an Import not to be locally complete on one or more processes. For example, this may happen in the common use case of "restriction" – that is, taking a subset of a large object. Nevertheless, you may find this predicate useful for figuring out whether you set up your Maps in the way that you expect.
Implements Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 944 of file Tpetra_Import_def.hpp.
| Import< LocalOrdinal, GlobalOrdinal, Node > & Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::operator= | ( | const Import< LocalOrdinal, GlobalOrdinal, Node > & | Source | ) |
Assignment operator.
Definition at line 951 of file Tpetra_Import_def.hpp.
| void Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::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.
On return, the input arrays permuteGIDs[1,2] and remotePGIDs[1,2] will be ordered. unionTgtGIDs are ordered as [{same}, {permute}, {remote}]. {same} is ordered identically to the target map with most "same" indices. {permute} is ordered from smallest ID to largest. {remote} is ordered by remote process ID and ID, respectively. remotePGIDs are ordered the same as {remote}.
Definition at line 1270 of file Tpetra_Import_def.hpp.
| Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::setUnion | ( | const Import< LocalOrdinal, GlobalOrdinal, Node > & | rhs | ) | const |
Return the union of this Import and rhs.
The "union" of two Import objects is the Import whose source Map is the same as the input Imports' source Maps, and whose target Map is the union of the two input Imports' target Maps. The two input Import objects must have the same source Map. The union operation is symmetric in its two inputs.
The communicator of rhs must be the same as (MPI_EQUAL) or congruent with (MPI_CONGRUENT) this Import's communicator. (That is, the two communicators must have the same number of processes, and each process must have the same rank in both communicators.) This method must be called collectively over that communicator.
The Map that results from this operation does not preserve the original order of global indices in either of the two input Maps. Instead, it sorts global indices on each process so that owned indices occur first, in the same order as in the source Map, and so that remote indices are sorted in order of their sending process rank. This makes communication operations faster.
This primitive is useful for adding two sparse matrices (CrsMatrix), since its can skip over many of the steps of creating the result matrix's column Map from scratch.
We have to call this method "setUnion" rather than "union," because union is a reserved keyword in C++ (and C). It would also be reasonable to call this operator+, though it would be a bit confusing for operator+ to return a pointer but take a reference (or to take a pointer, but have the left-hand side of the + expression be a reference).
Definition at line 1375 of file Tpetra_Import_def.hpp.
| Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::setUnion | ( | ) | const |
Return the union of this Import this->getSourceMap()
This special case of setUnion creates a new Import object such that the targetMap of the new object contains all local unknowns in the sourceMap (plus whatever remotes were contained in this->getSourceMap()).
The Map that results from this operation does not preserve the input order of global indices. All local global indices are ordered in the order of the sourceMap, all remotes are ordered as implied by the Importer for *this.
This primitive is useful for adding or multipyling two sparse matrices (CrsMatrix), since its can skip over many of the steps of creating the result matrix's column Map from scratch.
Definition at line 1631 of file Tpetra_Import_def.hpp.
| Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > Tpetra::Classes::Import< LocalOrdinal, GlobalOrdinal, Node >::createRemoteOnlyImport | ( | const Teuchos::RCP< const map_type > & | remoteTarget | ) | const |
Returns an importer that contains only the remote entries of this.
Returns an importer that contains only the remote entries of this importer. It is expected that remoteTarget represents such a map.
Definition at line 1703 of file Tpetra_Import_def.hpp.
|
virtual |
Describe this object in a human-readable way to the given output stream.
You must call this method as a collective over all processes in the communicator of the source and target Map of this object.
| out | [out] Output stream to which to write. Only Process 0 in this object's communicator may write to the output stream. |
| verbLevel | [in] Verbosity level. This also controls whether this method does any communication. At verbosity levels higher (greater) than Teuchos::VERB_LOW, this method behaves as a collective over the object's communicator. |
Teuchos::FancyOStream wraps std::ostream. It adds features like tab levels. If you just want to wrap std::cout, try this:
Reimplemented from Tpetra::Details::Classes::Transfer< LO, GO, NT >.
Definition at line 961 of file Tpetra_Import_def.hpp.
|
virtual |
Print the Import's data to the given output stream.
This method assumes that the given output stream can be written on all process(es) in the Import's communicator. The resulting output is useful mainly for debugging.
Definition at line 970 of file Tpetra_Import_def.hpp.
|
protectedinherited |
Implementation of describe() for subclasses (Tpetra::Import and Tpetra::Export).
| out | [out] Output stream to which to write. Only Process 0 in this object's communicator may write to the output stream. |
| className | [in] Name of the subclass of Transfer calling this method. |
| verbLevel | [in] Verbosity level. This also controls whether this method does any communication. At verbosity levels higher (greater) than Teuchos::VERB_LOW, this method behaves as a collective over the object's communicator. |
Definition at line 68 of file Tpetra_Details_Transfer_def.hpp.
1.8.6