An adapter for Xpetra::MultiVector. More...

#include <Zoltan2_XpetraMultiVectorAdapter.hpp>

Inheritance diagram for Zoltan2::XpetraMultiVectorAdapter< User >:

Collaboration diagram for Zoltan2::XpetraMultiVectorAdapter< User >:

Public Types
typedef InputTraits< User >::zgid_t	zgid_t
typedef InputTraits< User > ::scalar_t	scalar_t
typedef InputTraits< User >::part_t	part_t
Public Member Functions
	~XpetraMultiVectorAdapter ()
	Destructor.
	XpetraMultiVectorAdapter (const RCP< const User > &invector, std::vector< const scalar_t * > &weights, std::vector< int > &weightStrides)
	Constructor.
	XpetraMultiVectorAdapter (const RCP< const User > &invector)
	Constructor for case when weights are not being used.
size_t	getLocalNumIDs () const
	Returns the number of objects on this process.
void	getIDsView (const zgid_t *&ids) const
	Provide a pointer to this process' identifiers.
int	getNumWeightsPerID () const
	Returns the number of weights per object. Number of weights per object should be zero or greater. If zero, then it is assumed that all objects are equally weighted.
void	getWeightsView (const scalar_t *&weights, int &stride, int idx) const
	Provide pointer to a weight array with stride.
int	getNumEntriesPerID () const
	Return the number of vectors (typically one).
void	getEntriesView (const scalar_t *&elements, int &stride, int idx=0) const
	Provide a pointer to the elements of the specified vector.
template<typename Adapter >
void	applyPartitioningSolution (const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const
	Apply a PartitioningSolution to an input.
enum BaseAdapterType	adapterType () const
	Returns the type of adapter.
int	getDimension () const
void	getCoordinatesView (const scalar_t *&elements, int &stride, int idx=0) const
void	getPartsView (const part_t *&inputPart) const
	Provide pointer to an array containing the input part assignment for each ID. The input part information may be used for re-partitioning to reduce data movement, or for mapping parts to processes. Adapters may return NULL for this pointer (the default behavior); if NULL is returned, algorithms will assume the rank.

Detailed Description

template<typename User>
class Zoltan2::XpetraMultiVectorAdapter< User >

An adapter for Xpetra::MultiVector.

The template parameter is the user's input object:

Epetra_MultiVector
Tpetra::MultiVector
Xpetra::MultiVector

The scalar_t type, representing use data such as matrix values, is used by Zoltan2 for weights, coordinates, part sizes and quality metrics. Some User types (like Tpetra::CrsMatrix) have an inherent scalar type, and some (like Tpetra::CrsGraph) do not. For such objects, the scalar type is set by Zoltan2 to float. If you wish to change it to double, set the second template parameter to double.

Definition at line 81 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

Member Typedef Documentation

template<typename User>

typedef InputTraits<User>::zgid_t Zoltan2::BaseAdapter< User >::zgid_t [inherited]

Reimplemented in Zoltan2::PamgenMeshAdapter< User >, and Zoltan2::BasicIdentifierAdapter< User >.

Definition at line 97 of file Zoltan2_Adapter.hpp.

template<typename User>

typedef InputTraits<User>::scalar_t Zoltan2::BaseAdapter< User >::scalar_t [inherited]

Reimplemented in Zoltan2::PamgenMeshAdapter< User >, and Zoltan2::BasicIdentifierAdapter< User >.

Definition at line 98 of file Zoltan2_Adapter.hpp.

template<typename User>

typedef InputTraits<User>::part_t Zoltan2::BaseAdapter< User >::part_t [inherited]

Reimplemented in Zoltan2::PamgenMeshAdapter< User >, and Zoltan2::BasicIdentifierAdapter< User >.

Definition at line 100 of file Zoltan2_Adapter.hpp.

Constructor & Destructor Documentation

template<typename User>

Zoltan2::XpetraMultiVectorAdapter< User >::~XpetraMultiVectorAdapter ( ) [inline]

Destructor.

Definition at line 103 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User >

Zoltan2::XpetraMultiVectorAdapter< User >::XpetraMultiVectorAdapter	(	const RCP< const User > &	invector,
		std::vector< const scalar_t * > &	weights,
		std::vector< int > &	weightStrides
	)

Constructor.

Parameters:

invector	the user's Xpetra, Tpetra or Epetra MultiVector object
weights	a list of pointers to arrays of weights. The number of weights per multivector element is assumed to be `weights.size()`.
weightStrides	a list of strides for the `weights`. The weight for weight index `n` for multivector element `k` should be found at `weights[n][weightStrides[n] * k]`. If `weightStrides.size()` is zero, it is assumed all strides are one.

The values pointed to the arguments must remain valid for the lifetime of this Adapter.

Definition at line 181 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User >

Zoltan2::XpetraMultiVectorAdapter< User >::XpetraMultiVectorAdapter ( const RCP< const User > & invector )

Constructor for case when weights are not being used.

Parameters:

invector the user's Xpetra, Tpetra or Epetra MultiVector object

Definition at line 209 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

Member Function Documentation

template<typename User>

size_t Zoltan2::XpetraMultiVectorAdapter< User >::getLocalNumIDs ( ) const [inline, virtual]

Returns the number of objects on this process.

Objects may be coordinates, graph vertices, matrix rows, etc. They are the objects to be partitioned, ordered, or colored.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 135 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User>

void Zoltan2::XpetraMultiVectorAdapter< User >::getIDsView ( const zgid_t *& Ids ) const [inline, virtual]

Provide a pointer to this process' identifiers.

Parameters:

Ids	will on return point to the list of the global Ids for this process.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 137 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User>

int Zoltan2::XpetraMultiVectorAdapter< User >::getNumWeightsPerID ( ) const [inline, virtual]

Returns the number of weights per object. Number of weights per object should be zero or greater. If zero, then it is assumed that all objects are equally weighted.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 142 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User>

void Zoltan2::XpetraMultiVectorAdapter< User >::getWeightsView	(	const scalar_t *&	wgt,
		int &	stride,
		int	idx
	)		const `[inline, virtual]`

Provide pointer to a weight array with stride.

Parameters:

wgt	on return a pointer to the weights for this idx
stride	on return, the value such that the nth weight should be found at `wgt[n*stride]` .
idx	the weight index, zero or greater

Implements Zoltan2::BaseAdapter< User >.

Definition at line 144 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User>

int Zoltan2::XpetraMultiVectorAdapter< User >::getNumEntriesPerID ( ) const [inline, virtual]

Return the number of vectors (typically one).

Implements Zoltan2::VectorAdapter< User >.

Definition at line 156 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User >

void Zoltan2::XpetraMultiVectorAdapter< User >::getEntriesView	(	const scalar_t *&	elements,
		int &	stride,
		int	idx = `0`
	)		const `[virtual]`

Provide a pointer to the elements of the specified vector.

Parameters:

elements	will on return point to the vector values corresponding to the global Ids.
stride	the k'th element is located at elements[stride*k]
idx	ranges from zero to one less than getNumVectors(), and represents the vector for which data is being requested.

Implements Zoltan2::VectorAdapter< User >.

Definition at line 221 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User >

template<typename Adapter >

void Zoltan2::XpetraMultiVectorAdapter< User >::applyPartitioningSolution	(	const User &	in,
		User *&	out,
		const PartitioningSolution< Adapter > &	solution
	)		const

Apply a PartitioningSolution to an input.

This is not a required part of the InputAdapter interface. However if the Caller calls a Problem method to redistribute data, it needs this method to perform the redistribution.

Parameters:

in	An input object with a structure and assignment of of global Ids to processes that matches that of the input data that instantiated this Adapter.
out	On return this should point to a newly created object with the specified partitioning.
solution	The Solution object created by a Problem should be supplied as the third argument. It must have been templated on user data that has the same global ID distribution as this user data.

Returns:: Returns the number of local Ids in the new partition.

Reimplemented from Zoltan2::BaseAdapter< User >.

Definition at line 257 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User>

enum BaseAdapterType Zoltan2::VectorAdapter< User >::adapterType ( ) const [inline, virtual, inherited]

Returns the type of adapter.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 126 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

int Zoltan2::VectorAdapter< User >::getDimension ( ) const [inline, inherited]

Definition at line 154 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

void Zoltan2::VectorAdapter< User >::getCoordinatesView	(	const scalar_t *&	elements,
		int &	stride,
		int	idx = `0`
	)		const `[inline, inherited]`

Definition at line 156 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

void Zoltan2::BaseAdapter< User >::getPartsView ( const part_t *& inputPart ) const [inline, inherited]

Provide pointer to an array containing the input part assignment for each ID. The input part information may be used for re-partitioning to reduce data movement, or for mapping parts to processes. Adapters may return NULL for this pointer (the default behavior); if NULL is returned, algorithms will assume the rank.

Parameters:

inputPart on return a pointer to input part numbers

Definition at line 148 of file Zoltan2_Adapter.hpp.

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

Zoltan2_XpetraMultiVectorAdapter.hpp

Public Types

Public Member Functions

Detailed Description

template<typename User> class Zoltan2::XpetraMultiVectorAdapter< User >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename User>
class Zoltan2::XpetraMultiVectorAdapter< User >