Zoltan2
Public Member Functions | List of all members
Zoltan2::XpetraMultiVectorAdapter< User > Class Template Reference

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

#include <Zoltan2_XpetraMultiVectorAdapter.hpp>

Inheritance diagram for Zoltan2::XpetraMultiVectorAdapter< User >:
Inheritance graph
[legend]
Collaboration diagram for Zoltan2::XpetraMultiVectorAdapter< User >:
Collaboration graph
[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
 
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. More...
 
void getWeightsView (const scalar_t *&weights, int &stride, int idx) const
 Provide pointer to a weight array with stride. More...
 
int getNumEntriesPerID () const
 Return the number of vectors (typically one). 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...
 
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 getIDsView (const gno_t *&Ids) const =0
 Provide a pointer to this process' identifiers. 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 >::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::XpetraMultiVectorAdapter< User >

An adapter for Xpetra::MultiVector.

The template parameter is the user's input object:

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

template<typename User>
Zoltan2::XpetraMultiVectorAdapter< User >::~XpetraMultiVectorAdapter ( )
inline

Destructor.

Definition at line 103 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User >
Zoltan2::XpetraMultiVectorAdapter< User >::XpetraMultiVectorAdapter ( const RCP< const User > &  invector,
std::vector< const scalar_t * > &  weights,
std::vector< int > &  weightStrides 
)

Constructor.

Parameters
invectorthe user's Xpetra, Tpetra or Epetra MultiVector object
weightsa list of pointers to arrays of weights. The number of weights per multivector element is assumed to be weights.size().
weightStridesa 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 185 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User >
Zoltan2::XpetraMultiVectorAdapter< User >::XpetraMultiVectorAdapter ( const RCP< const User > &  invector)

Constructor for case when weights are not being used.

Parameters
invectorthe user's Xpetra, Tpetra or Epetra MultiVector object

Definition at line 216 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

Member Function Documentation

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::BaseAdapter< User >.

Definition at line 135 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

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

Definition at line 137 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

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.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 142 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User>
void Zoltan2::XpetraMultiVectorAdapter< User >::getWeightsView ( const scalar_t *&  wgt,
int &  stride,
int  idx 
) const
inlinevirtual

Provide pointer to a weight array with stride.

Parameters
wgton return a pointer to the weights for this idx
strideon return, the value such that the nth weight should be found at wgt[n*stride] .
idxthe weight index, zero or greater

Implements Zoltan2::BaseAdapter< User >.

Definition at line 144 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

template<typename User>
int Zoltan2::XpetraMultiVectorAdapter< User >::getNumEntriesPerID ( ) const
inlinevirtual

Return the number of vectors (typically one).

Implements Zoltan2::VectorAdapter< User >.

Definition at line 156 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

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

Implements Zoltan2::VectorAdapter< User >.

Definition at line 231 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

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

Definition at line 274 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

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


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