Zoltan2
Loading...
Searching...
No Matches
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.
 
 XpetraMultiVectorAdapter (const RCP< const User > &invector, std::vector< const scalar_t * > &weights, std::vector< int > &weightStrides)
 Constructor.
 
 XpetraMultiVectorAdapter (const RCP< const User > &invector)
 Constructor for case when weights are not being used.
 
size_t getLocalNumIDs () const
 Returns the number of objects on this process.
 
void getIDsView (const gno_t *&ids) const
 
void getIDsKokkosView (Kokkos::View< const gno_t *, typename node_t::device_type > &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. Default is zero weights per ID.
 
void getWeightsView (const scalar_t *&weights, int &stride, int idx) const
 
void getWeightsKokkos2dView (Kokkos::View< scalar_t **, typename node_t::device_type > &wgt) const
 
int getNumEntriesPerID () const
 Return the number of vectors.
 
void getEntriesView (const scalar_t *&elements, int &stride, int idx=0) const
 Provide a pointer to the elements of the specified vector.
 
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.
 
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.
 
enum BaseAdapterType adapterType () const override
 Returns the type of adapter.
 
virtual int getNumEntriesPerID () const =0
 Return the number of vectors.
 
virtual void getEntriesView (const scalar_t *&elements, int &stride, int idx=0) const
 Provide a pointer to the elements of the specified vector.
 
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.
 
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.
 
int getDimension () const
 
void getCoordinatesView (const scalar_t *&elements, int &stride, int idx=0) const override
 
void getCoordinatesKokkosView (Kokkos::View< scalar_t **, Kokkos::LayoutLeft, typename node_t::device_type > &elements) const override
 
- Public Member Functions inherited from Zoltan2::AdapterWithCoords< User >
virtual void getCoordinatesView (const typename BaseAdapter< User >::scalar_t *&coords, int &stride, int coordDim) const =0
 
virtual void getCoordinatesKokkosView (Kokkos::View< typename BaseAdapter< User >::scalar_t **, Kokkos::LayoutLeft, typename BaseAdapter< User >::node_t::device_type > &elements) const =0
 
- Public Member Functions inherited from Zoltan2::BaseAdapter< User >
virtual enum BaseAdapterType adapterType () const =0
 Returns the type of adapter.
 
virtual ~BaseAdapter ()
 Destructor.
 
virtual void getIDsView (const gno_t *&ids) const
 Provide a pointer to this process' identifiers.
 
virtual void getIDsKokkosView (Kokkos::View< const gno_t *, typename node_t::device_type > &ids) const
 Provide a Kokkos view to this process' identifiers.
 
void getPartsView (const part_t *&inputPart) const
 Provide pointer to a weight array with stride.
 
template<typename Adapter >
void applyPartitioningSolution (const User &in, User *&out, const PartitioningSolution< Adapter > &solution) const
 Apply a PartitioningSolution to an input.
 
- Public Member Functions inherited from Zoltan2::BaseAdapterRoot
virtual ~BaseAdapterRoot ()
 
virtual size_t getLocalNumIDs () const =0
 Returns the number of objects on this process.
 
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.
 

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

◆ ~XpetraMultiVectorAdapter()

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

Destructor.

Definition at line 102 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ XpetraMultiVectorAdapter() [1/2]

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

◆ XpetraMultiVectorAdapter() [2/2]

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

Member Function Documentation

◆ getLocalNumIDs()

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

Definition at line 134 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getIDsView()

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

Definition at line 136 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getIDsKokkosView()

template<typename User >
void Zoltan2::XpetraMultiVectorAdapter< User >::getIDsKokkosView ( Kokkos::View< const gno_t *, typename node_t::device_type > &  ids) const
inline

Definition at line 141 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getNumWeightsPerID()

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. Default is zero weights per ID.

Reimplemented from Zoltan2::BaseAdapterRoot.

Definition at line 171 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getWeightsView()

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

Definition at line 173 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getWeightsKokkos2dView()

template<typename User >
void Zoltan2::XpetraMultiVectorAdapter< User >::getWeightsKokkos2dView ( Kokkos::View< scalar_t **, typename node_t::device_type > &  wgt) const
inline

Definition at line 187 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getNumEntriesPerID()

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

Return the number of vectors.

Implements Zoltan2::VectorAdapter< User >.

Definition at line 209 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getEntriesView()

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 getNumEntriesPerID(), and represents the vector for which data is being requested.

Reimplemented from Zoltan2::VectorAdapter< User >.

Definition at line 291 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ getEntriesKokkosView()

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

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

Parameters
elementswill on return point to the vector values corresponding to the global Ids.

Reimplemented from Zoltan2::VectorAdapter< User >.

Definition at line 333 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ applyPartitioningSolution() [1/2]

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

Definition at line 379 of file Zoltan2_XpetraMultiVectorAdapter.hpp.

◆ applyPartitioningSolution() [2/2]

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


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