Zoltan2
Public Member Functions | List of all members
Zoltan2::VectorAdapter< User > Class Template Referenceabstract

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

#include <Zoltan2_VectorAdapter.hpp>

Inheritance diagram for Zoltan2::VectorAdapter< User >:
Inheritance graph
[legend]
Collaboration diagram for Zoltan2::VectorAdapter< User >:
Collaboration graph
[legend]

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 (typically one). More...
 
virtual void getEntriesView (const scalar_t *&elements, int &stride, int idx=0) const =0
 Provide a pointer to the elements of the specified vector. 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 size_t getLocalNumIDs () const =0
 Returns the number of objects on this process. More...
 
virtual void getIDsView (const gno_t *&Ids) const =0
 Provide a pointer to this process' identifiers. 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...
 
virtual void getWeightsView (const scalar_t *&wgt, int &stride, int idx=0) const
 Provide pointer to a weight array with stride. 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...
 

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
 

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:

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

◆ getNumEntriesPerID()

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

Return the number of vectors (typically one).

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

◆ getEntriesView()

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

Provide a pointer to the elements of the specified vector.

Parameters
elementswill on return point to the vector values corresponding to the global Ids.
stridethe k'th element is located at elements[stride*k]
idxranges from zero to one less than getNumVectors(), and represents the vector for which data is being requested.

◆ getDimension()

template<typename User>
int Zoltan2::VectorAdapter< User >::getDimension ( ) const
inline

Definition at line 150 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 152 of file Zoltan2_VectorAdapter.hpp.


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