VectorAdapter defines the interface for vector input. More...

#include <Zoltan2_VectorAdapter.hpp>

Inheritance diagram for Zoltan2::VectorAdapter< User >:

Collaboration diagram for Zoltan2::VectorAdapter< 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
virtual	~VectorAdapter ()
	Destructor.
enum BaseAdapterType	adapterType () const
	Returns the type of adapter.
virtual int	getNumEntriesPerID () const =0
	Return the number of vectors (typically one).
virtual void	getEntriesView (const scalar_t *&elements, int &stride, int idx=0) const =0
	Provide a pointer to the elements of the specified vector.
int	getDimension () const
void	getCoordinatesView (const scalar_t *&elements, int &stride, int idx=0) const
virtual size_t	getLocalNumIDs () const =0
	Returns the number of objects on this process.
virtual void	getIDsView (const zgid_t *&Ids) const =0
	Provide a pointer to this process' identifiers.
virtual int	getNumWeightsPerID () const =0
	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.
virtual void	getWeightsView (const scalar_t *&wgt, int &stride, int idx=0) const =0
	Provide pointer to a weight array with stride.
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.
template<typename Adapter >
void	applyPartitioningSolution (const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const
	Apply a PartitioningSolution to an input.

Detailed Description

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

VectorAdapter defines the interface for vector input.

Adapter objects provide access for Zoltan2 to the user's data. Many built-in adapters are already defined for common data structures, such as Tpetra and Epetra objects and C-language pointers to arrays.

Data types:

scalar_t weights and vector element values
lno_t local indices and local counts
gno_t global indices and global counts
zgid_t application global Ids
node_t is a sub class of KokkosClassic::StandardNodeMemoryModel

See IdentifierTraits to understand why the user's global ID type (zgid_t) may differ from that used by Zoltan2 (gno_t).

The Kokkos node type can be safely ignored.

The template parameter User is a user-defined data type which, through a traits mechanism, provides the actual data types with which the Zoltan2 library will be compiled. User may be the actual class or structure used by application to represent a vector, or it may be the helper class BasicUserTypes. See InputTraits for more information.

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.

VectorAdapter may be a single vector or a set of corresponding vectors which have with the same global identifiers and the same distribution across processes.

Todo:: We can make global Ids optional. We don't need them.

Definition at line 102 of file Zoltan2_VectorAdapter.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>

virtual Zoltan2::VectorAdapter< User >::~VectorAdapter ( ) [inline, virtual]

Destructor.

Definition at line 120 of file Zoltan2_VectorAdapter.hpp.

Member Function Documentation

template<typename User>

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

Returns the type of adapter.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 126 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

virtual int Zoltan2::VectorAdapter< User >::getNumEntriesPerID ( ) const [pure virtual]

Return the number of vectors (typically one).

Implemented in Zoltan2::BasicVectorAdapter< User >, and Zoltan2::XpetraMultiVectorAdapter< User >.

template<typename User>

virtual void Zoltan2::VectorAdapter< User >::getEntriesView	(	const scalar_t *&	elements,
		int &	stride,
		int	idx = `0`
	)		const `[pure 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.

Implemented in Zoltan2::BasicVectorAdapter< User >, and Zoltan2::XpetraMultiVectorAdapter< User >.

template<typename User>

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

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]`

Definition at line 156 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

virtual size_t Zoltan2::BaseAdapter< User >::getLocalNumIDs ( ) const [pure virtual, inherited]

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.

Implemented in Zoltan2::MeshAdapter< User >, Zoltan2::MatrixAdapter< User, UserCoord >, Zoltan2::GraphAdapter< User, UserCoord >, Zoltan2::BasicVectorAdapter< User >, Zoltan2::XpetraMultiVectorAdapter< User >, and Zoltan2::BasicIdentifierAdapter< User >.

template<typename User>

virtual void Zoltan2::BaseAdapter< User >::getIDsView ( const zgid_t *& Ids ) const [pure virtual, inherited]

Provide a pointer to this process' identifiers.

Parameters:

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

Implemented in Zoltan2::MeshAdapter< User >, Zoltan2::MatrixAdapter< User, UserCoord >, Zoltan2::GraphAdapter< User, UserCoord >, Zoltan2::XpetraMultiVectorAdapter< User >, and Zoltan2::BasicIdentifierAdapter< User >.

template<typename User>

virtual int Zoltan2::BaseAdapter< User >::getNumWeightsPerID ( ) const [pure virtual, inherited]

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.

Implemented in Zoltan2::MatrixAdapter< User, UserCoord >, Zoltan2::MeshAdapter< User >, Zoltan2::GraphAdapter< User, UserCoord >, Zoltan2::BasicVectorAdapter< User >, Zoltan2::XpetraMultiVectorAdapter< User >, and Zoltan2::BasicIdentifierAdapter< User >.

template<typename User>

virtual void Zoltan2::BaseAdapter< User >::getWeightsView	(	const scalar_t *&	wgt,
		int &	stride,
		int	idx = `0`
	)		const `[pure virtual, inherited]`

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

Implemented in Zoltan2::MatrixAdapter< User, UserCoord >, Zoltan2::MeshAdapter< User >, Zoltan2::GraphAdapter< User, UserCoord >, Zoltan2::BasicVectorAdapter< User >, Zoltan2::XpetraMultiVectorAdapter< User >, and Zoltan2::BasicIdentifierAdapter< User >.

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.

template<typename User>

template<typename Adapter >

void Zoltan2::BaseAdapter< User >::applyPartitioningSolution	(	const User &	in,
		User *&	out,
		const PartitioningSolution< Adapter > &	solution
	)		const `[inline, inherited]`

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 in Zoltan2::XpetraCrsGraphAdapter< User, UserCoord >, Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >, Zoltan2::XpetraRowMatrixAdapter< User, UserCoord >, and Zoltan2::XpetraMultiVectorAdapter< User >.

Definition at line 174 of file Zoltan2_Adapter.hpp.

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

Zoltan2_VectorAdapter.hpp

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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