|
Tpetra Matrix/Vector Services Version of the Day
|
This class builds an object containing information necesary for efficiently importing off-processor entries. More...
#include <Tpetra_Import.hpp>
Inherits Describable.
Public Member Functions | |
Constructor/Destructor Methods | |
| Import (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &source, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &target) | |
| Constructs a Import object from the source and target Maps. | |
| Import (const Import< LocalOrdinal, GlobalOrdinal, Node > &import) | |
| copy constructor. | |
| ~Import () | |
| destructor. | |
Export Attribute Methods | |
| size_t | getNumSameIDs () const |
| Returns the number of entries that are identical between the source and target maps, up to the first different ID. | |
| size_t | getNumPermuteIDs () const |
| Returns the number of entries that are local to the calling image, but not part of the first getNumSameIDs() entries. | |
| Teuchos::ArrayView< const LocalOrdinal > | getPermuteFromLIDs () const |
| List of entries in the source Map that are permuted. (non-persisting view) | |
| Teuchos::ArrayView< const LocalOrdinal > | getPermuteToLIDs () const |
| List of entries in the target Map that are permuted. (non-persisting view) | |
| size_t | getNumRemoteIDs () const |
| Returns the number of entries that are not on the calling image. | |
| Teuchos::ArrayView< const LocalOrdinal > | getRemoteLIDs () const |
| List of entries in the target Map that are coming from other images. (non-persisting view) | |
| size_t | getNumExportIDs () const |
| Returns the number of entries that must be sent by the calling image to other images. | |
| Teuchos::ArrayView< const LocalOrdinal > | getExportLIDs () const |
| List of entries in the source Map that will be sent to other images. (non-persisting view) | |
| Teuchos::ArrayView< const int > | getExportImageIDs () const |
| List of images to which entries will be sent, getExportLIDs() [i] will be sent to image getExportImageIDs() [i]. (non-persisting view) | |
| const Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > & | getSourceMap () const |
| Returns the Source Map used to construct this importer. | |
| const Teuchos::RCP< const Map < LocalOrdinal, GlobalOrdinal, Node > > & | getTargetMap () const |
| Returns the Target Map used to construct this importer. | |
| Distributor & | getDistributor () const |
| Import< LocalOrdinal, GlobalOrdinal, Node > & | operator= (const Import< LocalOrdinal, GlobalOrdinal, Node > &Source) |
| Assignment operator. | |
I/O Methods | |
| virtual void | print (std::ostream &os) const |
| Print method. | |
This class builds an object containing information necesary for efficiently importing off-processor entries.
Import is used to construct a communication plan that can be called repeatedly by computational classes to efficiently import entries from other nodes. For example, an exporter is used when we start out with a multiple-ownership distribution, and we want to merge that into a uniquely-owned distribution.
This class currently has one constructor, taking two Map objects specifying the distributions of the distributed objects on which the Export class will operate.
This class is templated on LocalOrdinal and GlobalOrdinal. The GlobalOrdinal type, if omitted, defaults to the LocalOrdinal type.
Definition at line 56 of file Tpetra_Import.hpp.
| Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::Import | ( | const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > & | source, |
| const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > & | target | ||
| ) |
Constructs a Import object from the source and target Maps.
Definition at line 141 of file Tpetra_Import.hpp.
| Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::Import | ( | const Import< LocalOrdinal, GlobalOrdinal, Node > & | import | ) |
copy constructor.
Definition at line 154 of file Tpetra_Import.hpp.
| Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::~Import | ( | ) |
destructor.
Definition at line 159 of file Tpetra_Import.hpp.
| size_t Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getNumSameIDs | ( | ) | const |
Returns the number of entries that are identical between the source and target maps, up to the first different ID.
Definition at line 163 of file Tpetra_Import.hpp.
| size_t Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getNumPermuteIDs | ( | ) | const |
Returns the number of entries that are local to the calling image, but not part of the first getNumSameIDs() entries.
Definition at line 168 of file Tpetra_Import.hpp.
| Teuchos::ArrayView< const LocalOrdinal > Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getPermuteFromLIDs | ( | ) | const |
List of entries in the source Map that are permuted. (non-persisting view)
Definition at line 174 of file Tpetra_Import.hpp.
| Teuchos::ArrayView< const LocalOrdinal > Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getPermuteToLIDs | ( | ) | const |
List of entries in the target Map that are permuted. (non-persisting view)
Definition at line 180 of file Tpetra_Import.hpp.
| size_t Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getNumRemoteIDs | ( | ) | const |
Returns the number of entries that are not on the calling image.
Definition at line 185 of file Tpetra_Import.hpp.
| Teuchos::ArrayView< const LocalOrdinal > Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getRemoteLIDs | ( | ) | const |
List of entries in the target Map that are coming from other images. (non-persisting view)
Definition at line 191 of file Tpetra_Import.hpp.
| size_t Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getNumExportIDs | ( | ) | const |
Returns the number of entries that must be sent by the calling image to other images.
Definition at line 196 of file Tpetra_Import.hpp.
| Teuchos::ArrayView< const LocalOrdinal > Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getExportLIDs | ( | ) | const |
List of entries in the source Map that will be sent to other images. (non-persisting view)
Definition at line 202 of file Tpetra_Import.hpp.
| Teuchos::ArrayView< const int > Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getExportImageIDs | ( | ) | const |
List of images to which entries will be sent, getExportLIDs() [i] will be sent to image getExportImageIDs() [i]. (non-persisting view)
Definition at line 208 of file Tpetra_Import.hpp.
| const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > & Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getSourceMap | ( | ) | const |
Returns the Source Map used to construct this importer.
Definition at line 214 of file Tpetra_Import.hpp.
| const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > & Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::getTargetMap | ( | ) | const |
Returns the Target Map used to construct this importer.
Definition at line 220 of file Tpetra_Import.hpp.
| Import< LocalOrdinal, GlobalOrdinal, Node > & Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::operator= | ( | const Import< LocalOrdinal, GlobalOrdinal, Node > & | Source | ) |
Assignment operator.
Definition at line 232 of file Tpetra_Import.hpp.
| void Tpetra::Import< LocalOrdinal, GlobalOrdinal, Node >::print | ( | std::ostream & | os | ) | const [virtual] |
Print method.
Definition at line 238 of file Tpetra_Import.hpp.
1.7.4