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

#include <Zoltan2_Adapter.hpp>

Inheritance diagram for Zoltan2::VectorAdapter< User >:

Collaboration diagram for Zoltan2::VectorAdapter< User >:

Public Member Functions
enum BaseAdapterType	adapterType () const override
	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...

virtual void	getEntriesHostView (typename AdapterWithCoords< User >::CoordsHostView &elements) const
	Provide a Kokkos view (Host side) to the elements of the specified vector. More...

virtual void	getEntriesDeviceView (typename AdapterWithCoords< User >::CoordsDeviceView &elements) const
	Provide a Kokkos view (Device side) 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 override

void	getCoordinatesKokkosView (typename AdapterWithCoords< User >::CoordsDeviceView &elements) const override

void	getCoordinatesHostView (typename AdapterWithCoords< User >::CoordsHostView &elements) const override

void	getCoordinatesDeviceView (typename AdapterWithCoords< User >::CoordsDeviceView &elements) const override

Public Member Functions inherited from Zoltan2::AdapterWithCoords< User >
virtual void	getCoordinatesKokkosView (CoordsDeviceView &elements) const =0

virtual void	getCoordinatesHostView (CoordsHostView &) const

virtual void	getCoordinatesDeviceView (CoordsDeviceView &elements) const

Public Member Functions inherited from Zoltan2::BaseAdapter< User >
virtual void	getIDsView (const gno_t *&ids) const
	Provide a pointer to this process' identifiers. More...

virtual void	getIDsKokkosView (ConstIdsDeviceView &ids) const
	Provide a Kokkos view to this process' identifiers. More...

virtual void	getIDsHostView (ConstIdsHostView &hostIds) const
	Provide a Kokkos view (Host side) to this process' identifiers. More...

virtual void	getIDsDeviceView (ConstIdsDeviceView &deviceIds) const
	Provide a Kokkos view (Device side) to this process' identifiers. More...

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

virtual void	getWeightsKokkosView (Kokkos::View< scalar_t **, device_t > &wgt) const
	Provide kokkos view of weights. More...

virtual void	getWeightsHostView (WeightsHostView1D &hostWgts, int idx=0) const
	Provide a Kokkos view (Host side) of the weights. More...

virtual void	getWeightsHostView (WeightsHostView &hostWgts) const
	Provide a Kokkos view (Host side) of the weights. More...

virtual void	getWeightsDeviceView (WeightsDeviceView1D &deviceWgts, int idx=0) const
	Provide a Kokkos view (Device side) of the weights. More...

virtual void	getWeightsDeviceView (WeightsDeviceView &deviceWgts) const
	Provide a Kokkos view (Device side) of the weights. More...

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

virtual void	getPartsHostView (Kokkos::View< part_t *, host_t > &inputPart) const

virtual void	getPartsDeviceView (Kokkos::View< part_t *, device_t > &inputPart) const

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 ()=default

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::AdapterWithCoords< User >
using	scalar_t = typename BaseAdapter< User >::scalar_t

using	device_t = typename BaseAdapter< User >::node_t::device_type

using	host_t = typename Kokkos::HostSpace::memory_space

using	CoordsDeviceView = Kokkos::View< scalar_t **, Kokkos::LayoutLeft, device_t >

using	CoordsHostView = typename CoordsDeviceView::HostMirror

Public Types inherited from Zoltan2::BaseAdapter< User >
using	lno_t = typename InputTraits< User >::lno_t

using	gno_t = typename InputTraits< User >::gno_t

using	scalar_t = typename InputTraits< User >::scalar_t

using	node_t = typename InputTraits< User >::node_t

using	part_t = typename InputTraits< User >::part_t

using	offset_t = typename InputTraits< User >::offset_t

using	host_t = typename Kokkos::HostSpace::memory_space

using	device_t = typename node_t::device_type

using	ConstIdsDeviceView = Kokkos::View< const gno_t *, device_t >

using	ConstIdsHostView = typename ConstIdsDeviceView::HostMirror

using	IdsDeviceView = Kokkos::View< gno_t *, device_t >

using	IdsHostView = typename IdsDeviceView::HostMirror

using	ConstOffsetsDeviceView = Kokkos::View< const offset_t *, device_t >

using	ConstOffsetsHostView = typename ConstOffsetsDeviceView::HostMirror

using	OffsetsDeviceView = Kokkos::View< offset_t *, device_t >

using	OffsetsHostView = typename OffsetsDeviceView::HostMirror

using	ConstScalarsDeviceView = Kokkos::View< const scalar_t *, device_t >

using	ConstScalarsHostView = typename ConstScalarsDeviceView::HostMirror

using	ScalarsDeviceView = Kokkos::View< scalar_t *, device_t >

using	ScalarsHostView = typename ScalarsDeviceView::HostMirror

using	ConstWeightsDeviceView1D = Kokkos::View< const scalar_t *, device_t >

using	ConstWeightsHostView1D = typename ConstWeightsDeviceView1D::HostMirror

using	WeightsDeviceView1D = Kokkos::View< scalar_t *, device_t >

using	WeightsHostView1D = typename WeightsDeviceView1D::HostMirror

using	ConstWeightsDeviceView = Kokkos::View< const scalar_t **, device_t >

using	ConstWeightsHostView = typename ConstWeightsDeviceView::HostMirror

using	WeightsDeviceView = Kokkos::View< scalar_t **, device_t >

using	WeightsHostView = typename WeightsDeviceView::HostMirror

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 330 of file Zoltan2_Adapter.hpp.

Member Function Documentation

template<typename User>

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

inlineoverridevirtual

Returns the type of adapter.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 81 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

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

pure virtual

Return the number of vectors.

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

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::BasicVectorAdapter< User >, Zoltan2::XpetraMultiVectorAdapter< User >, and VerySimpleVectorAdapter< User >.

Definition at line 99 of file Zoltan2_VectorAdapter.hpp.

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.

Definition at line 116 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

virtual void Zoltan2::VectorAdapter< User >::getEntriesHostView ( typename AdapterWithCoords< User >::CoordsHostView & elements ) const

inlinevirtual

Provide a Kokkos view (Host side) 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::BasicVectorAdapter< User >.

Definition at line 146 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

virtual void Zoltan2::VectorAdapter< User >::getEntriesDeviceView ( typename AdapterWithCoords< User >::CoordsDeviceView & elements ) const

inlinevirtual

Provide a Kokkos view (Device side) 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::BasicVectorAdapter< User >.

Definition at line 155 of file Zoltan2_VectorAdapter.hpp.

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

template<typename User>

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

inline

Definition at line 184 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

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

inlineoverridevirtual

Implements Zoltan2::AdapterWithCoords< User >.

Definition at line 186 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

void Zoltan2::VectorAdapter< User >::getCoordinatesKokkosView ( typename AdapterWithCoords< User >::CoordsDeviceView & elements ) const

inlineoverride

Definition at line 192 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

void Zoltan2::VectorAdapter< User >::getCoordinatesHostView ( typename AdapterWithCoords< User >::CoordsHostView & elements ) const

inlineoverride

Definition at line 199 of file Zoltan2_VectorAdapter.hpp.

template<typename User>

void Zoltan2::VectorAdapter< User >::getCoordinatesDeviceView ( typename AdapterWithCoords< User >::CoordsDeviceView & elements ) const

inlineoverride

Definition at line 203 of file Zoltan2_VectorAdapter.hpp.

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

Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Function Documentation

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