#include <Zoltan2_Adapter.hpp>

Inheritance diagram for Zoltan2::BaseAdapter< User >:

Collaboration diagram for Zoltan2::BaseAdapter< User >:

Public Types
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 Member Functions
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< gno_t * > &) const
	Provide a pointer 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 * > &, 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 ()

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

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

Detailed Description

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

Definition at line 101 of file Zoltan2_Adapter.hpp.

Member Typedef Documentation

template<typename User>

typedef InputTraits<User>::lno_t Zoltan2::BaseAdapter< User >::lno_t

Definition at line 104 of file Zoltan2_Adapter.hpp.

template<typename User>

typedef InputTraits<User>::gno_t Zoltan2::BaseAdapter< User >::gno_t

Definition at line 105 of file Zoltan2_Adapter.hpp.

template<typename User>

typedef InputTraits<User>::scalar_t Zoltan2::BaseAdapter< User >::scalar_t

Definition at line 106 of file Zoltan2_Adapter.hpp.

template<typename User>

typedef InputTraits<User>::part_t Zoltan2::BaseAdapter< User >::part_t

Definition at line 107 of file Zoltan2_Adapter.hpp.

template<typename User>

typedef InputTraits<User>::offset_t Zoltan2::BaseAdapter< User >::offset_t

Definition at line 108 of file Zoltan2_Adapter.hpp.

Constructor & Destructor Documentation

template<typename User>

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

inlinevirtual

Destructor.

Definition at line 116 of file Zoltan2_Adapter.hpp.

Member Function Documentation

template<typename User>

virtual enum BaseAdapterType Zoltan2::BaseAdapter< User >::adapterType ( ) const

pure virtual

Returns the type of adapter.

Implemented in Zoltan2::MeshAdapter< User >, Zoltan2::VectorAdapter< User >, Zoltan2::VectorAdapter< UserCoord >, Zoltan2::IdentifierAdapter< User >, Zoltan2::GraphAdapter< User, UserCoord >, and Zoltan2::MatrixAdapter< User, UserCoord >.

template<typename User>

virtual void Zoltan2::BaseAdapter< 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 in Zoltan2::MeshAdapter< User >, Zoltan2::MatrixAdapter< User, UserCoord >, Zoltan2::GraphAdapter< User, UserCoord >, Zoltan2::BasicVectorAdapter< User >, Zoltan2::XpetraMultiVectorAdapter< User >, and Zoltan2::BasicIdentifierAdapter< User >.

Definition at line 123 of file Zoltan2_Adapter.hpp.

template<typename User>

virtual void Zoltan2::BaseAdapter< User >::getIDsKokkosView ( Kokkos::View< gno_t * > & ) 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 in Zoltan2::BasicKokkosIdentifierAdapter< User >.

Definition at line 134 of file Zoltan2_Adapter.hpp.

template<typename User>

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

inlinevirtual

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 This function must be implemented in derived adapter if getNumWeightsPerID > 0. This function should not be called if getNumWeightsPerID is zero.

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

Definition at line 147 of file Zoltan2_Adapter.hpp.

template<typename User>

virtual void Zoltan2::BaseAdapter< User >::getWeightsKokkosView	(	Kokkos::View< scalar_t * > &	,
		int	= `0`
	)		const

inlinevirtual

Provide pointer to a weight View.

Parameters

wgt	on return a pointer to the weights for this idx
idx	the weight index, zero or greater This function must be implemented in derived adapter if getNumWeightsPerID > 0. This function should not be called if getNumWeightsPerID is zero.

Reimplemented in Zoltan2::BasicKokkosIdentifierAdapter< User >.

Definition at line 162 of file Zoltan2_Adapter.hpp.

template<typename User>

void Zoltan2::BaseAdapter< User >::getPartsView ( const part_t *& inputPart ) const

inline

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 176 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

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.

Definition at line 200 of file Zoltan2_Adapter.hpp.

template<typename User >

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

protected

Definition at line 218 of file Zoltan2_Adapter.hpp.

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

Zoltan2_Adapter.hpp

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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