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

#include <Zoltan2_VectorAdapter.hpp>

Inheritance diagram for Zoltan2::VectorAdapter< User >:

[legend]

Collaboration diagram for Zoltan2::VectorAdapter< User >:

Public Member Functions
virtual	~VectorAdapter ()
	Destructor. More...

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

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

virtual void	getEntriesView (const scalar_t *&elements, int &stride, int idx=0) const
	Provide a pointer to the elements of the specified vector. More...

virtual void	getEntriesKokkosView (Kokkos::View< scalar_t **, Kokkos::LayoutLeft, typename node_t::device_type > &elements) const
	Provide a Kokkos view to the elements of the specified vector. 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

void	getCoordinatesKokkosView (Kokkos::View< scalar_t **, Kokkos::LayoutLeft, typename node_t::device_type > &elements) const

Public Member Functions inherited from Zoltan2::BaseAdapter< User >
virtual enum BaseAdapterType	adapterType () const =0
	Returns the type of adapter. More...

virtual	~BaseAdapter ()
	Destructor. More...

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

virtual void	getIDsKokkosView (Kokkos::View< const gno_t *, typename node_t::device_type > &ids) const
	Provide a Kokkos view to this process' identifiers. More...

void	getPartsView (const part_t *&inputPart) const
	Provide pointer to a weight array with stride. 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 ()

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

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

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 >::node_t	node_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>
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
node_t is a Kokkos Node type

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 98 of file Zoltan2_VectorAdapter.hpp.

Constructor & Destructor Documentation

◆ ~VectorAdapter()

template<typename User >

virtual Zoltan2::VectorAdapter< User >::~VectorAdapter ( )

inlinevirtual

Destructor.

Definition at line 115 of file Zoltan2_VectorAdapter.hpp.

Member Function Documentation

◆ adapterType()

template<typename User >

enum BaseAdapterType Zoltan2::VectorAdapter< User >::adapterType ( ) const

inlinevirtual

Returns the type of adapter.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 121 of file Zoltan2_VectorAdapter.hpp.

◆ getNumEntriesPerID()

template<typename User >

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

pure virtual

Return the number of vectors.

Implemented in Zoltan2::BasicVectorAdapter< User >, Zoltan2::XpetraMultiVectorAdapter< User >, OldSchoolVectorAdapterContig< User >, OldSchoolVectorAdapterStrided< User >, KokkosVectorAdapter< User >, and VerySimpleVectorAdapter< User >.

◆ getEntriesView()

template<typename User >

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

inlinevirtual

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.

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

Definition at line 139 of file Zoltan2_VectorAdapter.hpp.

◆ getEntriesKokkosView()

template<typename User >

virtual void Zoltan2::VectorAdapter< User >::getEntriesKokkosView ( Kokkos::View< scalar_t **, Kokkos::LayoutLeft, typename node_t::device_type > & elements ) const

inlinevirtual

Provide a Kokkos view to the elements of the specified vector.

Parameters

elements will on return point to the vector values corresponding to the global Ids.

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

Definition at line 156 of file Zoltan2_VectorAdapter.hpp.

◆ generateFiles()

template<typename User >

void Zoltan2::VectorAdapter< User >::generateFiles	(	const char *	fileprefix,
		const Teuchos::Comm< int > &	comm
	)		const

inline

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.

Definition at line 190 of file Zoltan2_VectorAdapter.hpp.

◆ getDimension()

template<typename User >

int Zoltan2::VectorAdapter< User >::getDimension ( ) const

inline

Definition at line 207 of file Zoltan2_VectorAdapter.hpp.

◆ getCoordinatesView()

template<typename User >

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

inline

Definition at line 209 of file Zoltan2_VectorAdapter.hpp.

◆ getCoordinatesKokkosView()

template<typename User >

void Zoltan2::VectorAdapter< User >::getCoordinatesKokkosView ( Kokkos::View< scalar_t **, Kokkos::LayoutLeft, typename node_t::device_type > & elements ) const

inline

Definition at line 215 of file Zoltan2_VectorAdapter.hpp.

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

Zoltan2_VectorAdapter.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~VectorAdapter()

Member Function Documentation

◆ adapterType()

◆ getNumEntriesPerID()

◆ getEntriesView()

◆ getEntriesKokkosView()

◆ generateFiles()

◆ getDimension()

◆ getCoordinatesView()

◆ getCoordinatesKokkosView()