Provides access for Zoltan2 to Xpetra::CrsMatrix data. More...

#include <Zoltan2_XpetraCrsMatrixAdapter.hpp>

Inheritance diagram for Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >:

Collaboration diagram for Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >:

Public Member Functions
	~XpetraCrsMatrixAdapter ()
	Destructor. More...

	XpetraCrsMatrixAdapter (const RCP< const User > &inmatrix, int nWeightsPerRow=0)
	Constructor. More...

void	setWeights (const scalar_t *weightVal, int stride, int idx=0)
	Specify a weight for each entity of the primaryEntityType. More...

void	setRowWeights (const scalar_t *weightVal, int stride, int idx=0)
	Specify a weight for each row. More...

void	setWeightIsDegree (int idx)
	Specify an index for which the weight should be the degree of the entity. More...

void	setRowWeightIsNumberOfNonZeros (int idx)
	Specify an index for which the row weight should be the global number of nonzeros in the row. More...

size_t	getLocalNumRows () const
	Returns the number of rows on this process. More...

size_t	getLocalNumColumns () const
	Returns the number of columns on this process. More...

size_t	getLocalNumEntries () const
	Returns the number of nonzeros on this process. More...

bool	CRSViewAvailable () const
	Indicates whether the MatrixAdapter implements a view of the matrix in compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...

void	getRowIDsView (const gno_t *&rowIds) const

void	getCRSView (const offset_t &offsets, const gno_t &colIds) const

void	getCRSView (const offset_t &offsets, const gno_t &colIds, const scalar_t *&values) const

int	getNumWeightsPerRow () const
	Returns the number of weights per row (0 or greater). Row weights may be used when partitioning matrix rows. More...

void	getRowWeightsView (const scalar_t *&weights, int &stride, int idx=0) const

bool	useNumNonzerosAsRowWeight (int idx) const
	Indicate whether row weight with index idx should be the global number of nonzeros in the row. More...

template<typename Adapter >
void	applyPartitioningSolution (const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const

template<typename Adapter >
void	applyPartitioningSolution (const User &in, RCP< User > &out, const PartitioningSolution< Adapter > &solution) const

Public Member Functions inherited from Zoltan2::MatrixAdapter< User, UserCoord >
enum BaseAdapterType	adapterType () const
	Returns the type of adapter. More...

	MatrixAdapter ()

virtual	~MatrixAdapter ()
	Destructor. More...

virtual void	getRowIDsView (const gno_t *&rowIds) const
	Sets pointer to this process' rows' global IDs. More...

virtual void	getCRSView (const offset_t &offsets, const gno_t &colIds) const
	Sets pointers to this process' matrix entries using compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...

virtual void	getCRSView (const offset_t &offsets, const gno_t &colIds, const scalar_t *&values) const
	Sets pointers to this process' matrix entries and their values using compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...

virtual void	getRowWeightsView (const scalar_t *&weights, int &stride, int idx=0) const
	Provide a pointer to the row weights, if any. More...

virtual bool	CCSViewAvailable () const
	Indicates whether the MatrixAdapter implements a view of the matrix in compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...

virtual void	getColumnIDsView (const gno_t *&colIds) const
	Sets pointer to this process' columns' global IDs. More...

virtual void	getCCSView (const offset_t &offsets, const gno_t &rowIds) const
	Sets pointers to this process' matrix entries using compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...

virtual void	getCCSView (const offset_t &offsets, const gno_t &rowIds, const scalar_t *&values) const
	Sets pointers to this process' matrix entries and their values using compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...

virtual int	getNumWeightsPerColumn () const
	Returns the number of weights per column (0 or greater). Column weights may be used when partitioning matrix columns. More...

virtual void	getColumnWeightsView (const scalar_t *&weights, int &stride, int idx=0) const
	Provide a pointer to the column weights, if any. More...

virtual bool	useNumNonzerosAsColumnWeight (int idx) const
	Indicate whether column weight with index idx should be the global number of nonzeros in the column. More...

void	setCoordinateInput (VectorAdapter< UserCoord > *coordData)
	Allow user to provide additional data that contains coordinate info associated with the MatrixAdapter's primaryEntityType. Associated data must have the same parallel distribution and ordering of entries as the primaryEntityType. More...

bool	coordinatesAvailable () const
	Indicate whether coordinate information has been set for this MatrixAdapter. More...

VectorAdapter< UserCoord > *	getCoordinateInput () const
	Obtain the coordinate data registered by the user. More...

enum MatrixEntityType	getPrimaryEntityType () const
	Returns the entity to be partitioned, ordered, colored, etc. Valid values are MATRIX_ROW, MATRIX_COLUMN, MATRIX_NONZERO. More...

void	setPrimaryEntityType (std::string typestr)
	Sets the primary entity type. Called by algorithm based on parameter value in parameter list from application. Also sets to adjacencyEntityType to something reasonable: opposite of primaryEntityType. More...

size_t	getLocalNumIDs () const
	Returns the number of objects on this process. More...

void	getIDsView (const gno_t *&Ids) const
	Provide a pointer to this process' identifiers. More...

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. Default is zero weights per ID. More...

void	getWeightsView (const scalar_t *&wgt, int &stride, int idx=0) const
	Provide pointer to a weight array with stride. More...

bool	useDegreeAsWeight (int idx) const

Public Member Functions inherited from Zoltan2::BaseAdapter< User >
virtual	~BaseAdapter ()
	Destructor. More...

virtual void	getIDsKokkosView (Kokkos::View< gno_t * > &) const
	Provide a pointer to this process' identifiers. More...

virtual void	getWeightsKokkosView (Kokkos::View< scalar_t * > &, int=0) const
	Provide pointer to a weight View. More...

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. More...

template<typename Adapter >
void	applyPartitioningSolution (const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const
	Apply a PartitioningSolution to an input. More...

Public Member Functions inherited from Zoltan2::BaseAdapterRoot
virtual	~BaseAdapterRoot ()

Additional Inherited Members
Public Types inherited from Zoltan2::BaseAdapter< User >
typedef InputTraits< User >::lno_t	lno_t

typedef InputTraits< User >::gno_t	gno_t

typedef InputTraits< User > ::scalar_t	scalar_t

typedef InputTraits< User >::part_t	part_t

typedef InputTraits< User > ::offset_t	offset_t

Protected Member Functions inherited from Zoltan2::BaseAdapter< User >
void	generateWeightFileOnly (const char *fileprefix, const Teuchos::Comm< int > &comm) const

Detailed Description

template<typename User, typename UserCoord = User>
class Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >

Provides access for Zoltan2 to Xpetra::CrsMatrix data.

Todo:

we assume FillComplete has been called. We should support objects that are not FillCompleted.

add RowMatrix

The template parameter is the user's input object:

Tpetra::CrsMatrix
Xpetra::CrsMatrix
Epetra_CrsMatrix

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 86 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

Constructor & Destructor Documentation

template<typename User, typename UserCoord = User>

Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::~XpetraCrsMatrixAdapter ( )

inline

Destructor.

Definition at line 103 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User , typename UserCoord >

Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::XpetraCrsMatrixAdapter	(	const RCP< const User > &	inmatrix,
		int	nWeightsPerRow = `0`
	)

Constructor.

Parameters

inmatrix	The users Epetra, Tpetra, or Xpetra CrsMatrix object
nWeightsPerRow	If row weights will be provided in setRowWeights(), the set `nWeightsPerRow` to the number of weights per row.

Definition at line 248 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

Member Function Documentation

template<typename User , typename UserCoord >

void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::setWeights	(	const scalar_t *	weightVal,
		int	stride,
		int	idx = `0`
	)

Specify a weight for each entity of the primaryEntityType.

Parameters

weightVal	A pointer to the weights for this index. A stride to be used in reading the values. The index `idx` weight for entity should be found at `weightVal[k*stride]`.
idx	A value between zero and one less that the `nWeightsPerRow` argument to the constructor.

The order of weights should correspond to the order of the primary entity type; see, e.g., setRowWeights below.

Definition at line 286 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User , typename UserCoord >

void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::setRowWeights	(	const scalar_t *	weightVal,
		int	stride,
		int	idx = `0`
	)

Specify a weight for each row.

Parameters

weightVal	A pointer to the weights for this index. A stride to be used in reading the values. The index `idx` weight for row should be found at `weightVal[k*stride]`.
idx	A value between zero and one less that the `nWeightsPerRow` argument to the constructor.

The order of weights should correspond to the order of rows returned by

theMatrix->getRowMap()->getNodeElementList();

Definition at line 304 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User , typename UserCoord >

void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::setWeightIsDegree ( int idx )

Specify an index for which the weight should be the degree of the entity.

Parameters

idx	Zoltan2 will use the entity's degree as the entity weight for index `idx`.

Definition at line 323 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User , typename UserCoord >

void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::setRowWeightIsNumberOfNonZeros ( int idx )

Specify an index for which the row weight should be the global number of nonzeros in the row.

Parameters

idx	Zoltan2 will use the global number of nonzeros in a row as the row weight for index `idx`.

Definition at line 340 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

size_t Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getLocalNumRows ( ) const

inlinevirtual

Returns the number of rows on this process.

Implements Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 162 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

size_t Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getLocalNumColumns ( ) const

inlinevirtual

Returns the number of columns on this process.

Implements Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 166 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

size_t Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getLocalNumEntries ( ) const

inlinevirtual

Returns the number of nonzeros on this process.

Implements Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 170 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

bool Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::CRSViewAvailable ( ) const

inlinevirtual

Indicates whether the MatrixAdapter implements a view of the matrix in compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.

Reimplemented from Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 174 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getRowIDsView ( const gno_t *& rowIds ) const

inline

Definition at line 176 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getCRSView	(	const offset_t *&	offsets,
		const gno_t *&	colIds
	)		const

inline

Definition at line 182 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getCRSView	(	const offset_t *&	offsets,
		const gno_t *&	colIds,
		const scalar_t *&	values
	)		const

inline

Definition at line 188 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

int Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getNumWeightsPerRow ( ) const

inlinevirtual

Returns the number of weights per row (0 or greater). Row weights may be used when partitioning matrix rows.

Reimplemented from Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 197 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getRowWeightsView	(	const scalar_t *&	weights,
		int &	stride,
		int	idx = `0`
	)		const

inline

Definition at line 199 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>

bool Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::useNumNonzerosAsRowWeight ( int idx ) const

inlinevirtual

Indicate whether row weight with index idx should be the global number of nonzeros in the row.

Reimplemented from Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 214 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User , typename UserCoord >

template<typename Adapter >

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

Definition at line 358 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User , typename UserCoord >

template<typename Adapter >

void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::applyPartitioningSolution	(	const User &	in,
		RCP< User > &	out,
		const PartitioningSolution< Adapter > &	solution
	)		const

Definition at line 382 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

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

Zoltan2_XpetraCrsMatrixAdapter.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename User, typename UserCoord = User> class Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >

Constructor & Destructor Documentation

Member Function Documentation

template<typename User, typename UserCoord = User>
class Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >