Tpetra::Details::OptColMap< MapType > Class Template Reference

Implementation detail of makeOptimizedColMap, and makeOptimizedColMapAndImport. More...

#include <Tpetra_Details_makeOptimizedColMap.hpp>

List of all members.

Static Public Member Functions
static std::pair< map_type, Teuchos::RCP< import_type > >	make (std::ostream &errStream, bool &lclErr, const map_type &domMap, const map_type &colMap, const import_type *oldImport, const bool makeImport)
	Return an optimized reordering of the given column Map. Optionally, recompute an Import from the input domain Map to the new column Map.

---

Detailed Description

template<class MapType>
class Tpetra::Details::OptColMap< MapType >

Implementation detail of makeOptimizedColMap, and makeOptimizedColMapAndImport.

Warning:

Please use the free functions (not part of a class) makeOptimizedColMap or makeOptimizedColMapAndImport.

Definition at line 76 of file Tpetra_Details_makeOptimizedColMap.hpp.

---

Member Function Documentation

template<class MapType >

static std::pair<map_type, Teuchos::RCP<import_type> > Tpetra::Details::OptColMap< MapType >::make	(	std::ostream &	errStream,
		bool &	lclErr,
		const map_type &	domMap,
		const map_type &	colMap,
		const import_type *	oldImport,
		const bool	makeImport
	)		[inline, static]

Return an optimized reordering of the given column Map. Optionally, recompute an Import from the input domain Map to the new column Map.

Template Parameters:

MapType

A specialization of Map.

See the documentation of the free function makeOptimizedColMapAndImport().

Parameters:

errStream	[out] Output stream for human-readable error reporting. This is local to the calling process and may differ on different processes.
lclErr	[out] On output: true if anything went wrong on the calling process. This value is local to the calling process and may differ on different processes.
domMap	[in] Domain Map of a CrsGraph or CrsMatrix.
colMap	[in] Original column Map of the same CrsGraph or CrsMatrix as domMap.
oldImport	[in] Optional pointer to the "original Import: an Import from domMap to colMap. This is not required, but if you supply this, this function may use it to avoid some communication and/or work when setting up the new Import object. This function will only look at this pointer if makeImport is true.
makeImport	[in] Whether to make and return an Import from the input domain Map to the new column Map.

Returns:

The possibly reordered column Map newColMap, and the corresponding Import from domMap to newColMap. The latter is nonnull if and only if makeImport is true.

Precondition:

domMap and colMap must have the same or congruent communicators.

On all calling processes, the indices in colMap must be a subset of the indices in domMap.

Definition at line 121 of file Tpetra_Details_makeOptimizedColMap.hpp.

---

The documentation for this class was generated from the following file:

• Tpetra_Details_makeOptimizedColMap.hpp