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

#include <Zoltan2_XpetraMultiVectorAdapter.hpp>

Inheritance diagram for Zoltan2::XpetraMultiVectorAdapter< User >:

[legend]

Collaboration diagram for Zoltan2::XpetraMultiVectorAdapter< User >:

[legend]

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

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

	XpetraMultiVectorAdapter (const RCP< const User > &invector)
	Constructor for case when weights are not being used. 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 *&weights, int &stride, int idx) const

int	getNumEntriesPerID () const
	Return the number of vectors. More...

void	getEntriesView (const scalar_t *&elements, int &stride, int idx=0) const
	Provide a pointer to the elements of the specified vector. 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::VectorAdapter< User >
virtual	~VectorAdapter ()
	Destructor. More...

enum BaseAdapterType	adapterType () const
	Returns the type of adapter. More...

void	generateFiles (const char *fileprefix, const Teuchos::Comm< int > &comm) const
	Write files that can be used as input to Zoltan or Zoltan2 driver Creates chaco-formatted input files for coordinates and weights that can be used as input for Zoltan or Zoltan2 drivers. This routine is SERIAL and can be quite slow. It is meant as a debugging tool only, to allow Zoltan developers to replicate performance that applications are seeing using the applicatios' input. More...

int	getDimension () const

void	getCoordinatesView (const scalar_t *&elements, int &stride, int idx=0) 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...

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

Public Attributes inherited from Zoltan2::BaseAdapter< User >
	int

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 vector 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 83 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

Constructor & Destructor Documentation

◆ ~XpetraMultiVectorAdapter()

template<typename User >

Zoltan2::XpetraMultiVectorAdapter< User >::~XpetraMultiVectorAdapter ( )

inline

Destructor.

Definition at line 102 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ XpetraMultiVectorAdapter() [1/2]

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 188 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ XpetraMultiVectorAdapter() [2/2]

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 221 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

Member Function Documentation

◆ getLocalNumIDs()

template<typename User >

size_t Zoltan2::XpetraMultiVectorAdapter< User >::getLocalNumIDs ( ) const

inlinevirtual

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::BaseAdapterRoot.

Definition at line 134 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getIDsView()

template<typename User >

void Zoltan2::XpetraMultiVectorAdapter< User >::getIDsView ( const gno_t *& ids ) const

inlinevirtual

Provide a pointer to this process' identifiers.

Parameters

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

Reimplemented from Zoltan2::BaseAdapter< User >.

Definition at line 136 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getNumWeightsPerID()

template<typename User >

int Zoltan2::XpetraMultiVectorAdapter< User >::getNumWeightsPerID ( ) const

inlinevirtual

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.

Reimplemented from Zoltan2::BaseAdapterRoot.

Definition at line 141 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getWeightsView()

template<typename User >

void Zoltan2::XpetraMultiVectorAdapter< User >::getWeightsView	(	const scalar_t *&	weights,
		int &	stride,
		int	idx
	)		const

inline

Definition at line 143 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getNumEntriesPerID()

template<typename User >

int Zoltan2::XpetraMultiVectorAdapter< User >::getNumEntriesPerID ( ) const

inlinevirtual

Return the number of vectors.

Implements Zoltan2::VectorAdapter< User >.

Definition at line 161 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getEntriesView()

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 getNumEntriesPerID(), and represents the vector for which data is being requested.

Implements Zoltan2::VectorAdapter< User >.

Definition at line 238 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ applyPartitioningSolution() [1/2]

template<typename User >

template<typename Adapter >

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

Definition at line 281 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ applyPartitioningSolution() [2/2]

template<typename User >

template<typename Adapter >

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

Definition at line 305 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

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

Zoltan2_XpetraMultiVectorAdapter.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ ~XpetraMultiVectorAdapter()

◆ XpetraMultiVectorAdapter() [1/2]

◆ XpetraMultiVectorAdapter() [2/2]

Member Function Documentation

◆ getLocalNumIDs()

◆ getIDsView()

◆ getNumWeightsPerID()

◆ getWeightsView()

◆ getNumEntriesPerID()

◆ getEntriesView()

◆ applyPartitioningSolution() [1/2]

◆ applyPartitioningSolution() [2/2]

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