Zoltan2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord > Class Template Reference

Provides access for Zoltan2 to Xpetra::CrsMatrix data. More...

#include <Zoltan2_XpetraCrsMatrixAdapter.hpp>

Inheritance diagram for Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >:
Inheritance graph
[legend]
Collaboration diagram for Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >:
Collaboration graph
[legend]

Public Member Functions

 XpetraCrsMatrixAdapter (const RCP< const User > &inmatrix, int nWeightsPerRow=0)
 Constructor. More...
 
void setWeights (const scalar_t *weightVal, int stride, int idx=0)
 Specify a weight for each entity of the primaryEntityType. More...
 
void setRowWeights (const scalar_t *weightVal, int stride, int idx=0)
 Specify a weight for each row. More...
 
void setWeightIsDegree (int idx)
 Specify an index for which the weight should be the degree of the entity. More...
 
void setRowWeightIsNumberOfNonZeros (int idx)
 Specify an index for which the row weight should be the global number of nonzeros in the row. More...
 
size_t getLocalNumRows () const
 Returns the number of rows on this process. More...
 
size_t getLocalNumColumns () const
 Returns the number of columns on this process. More...
 
size_t getLocalNumEntries () const
 Returns the number of nonzeros on this process. More...
 
bool CRSViewAvailable () const
 Indicates whether the MatrixAdapter implements a view of the matrix in compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...
 
void getRowIDsView (const gno_t *&rowIds) const
 
void getCRSView (ArrayRCP< const offset_t > &offsets, ArrayRCP< const gno_t > &colIds) const
 
void getCRSView (ArrayRCP< const offset_t > &offsets, ArrayRCP< const gno_t > &colIds, ArrayRCP< const scalar_t > &values) const
 
int getNumWeightsPerRow () const
 Returns the number of weights per row (0 or greater). Row weights may be used when partitioning matrix rows. More...
 
void getRowWeightsView (const scalar_t *&weights, int &stride, int idx=0) const
 Provide a pointer to the row weights, if any. More...
 
bool useNumNonzerosAsRowWeight (int idx) const
 Indicate whether row weight with index idx should be the global number of nonzeros in the row. 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::MatrixAdapter< User, UserCoord >
enum BaseAdapterType adapterType () const override
 Returns the type of adapter. More...
 
 MatrixAdapter ()
 
virtual void getRowIDsView (const gno_t *&rowIds) const
 Sets pointer to this process' rows' global IDs. More...
 
virtual void getRowIDsHostView (typename BaseAdapter< User >::ConstIdsHostView &rowIds) const
 
virtual void getRowIDsDeviceView (typename BaseAdapter< User >::ConstIdsDeviceView &rowIds) const
 
virtual void getCRSView (ArrayRCP< const offset_t > &offsets, ArrayRCP< const gno_t > &colIds) const
 Sets pointers to this process' matrix entries using compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...
 
virtual void getCRSHostView (typename BaseAdapter< User >::ConstOffsetsHostView &offsets, typename BaseAdapter< User >::ConstIdsHostView &colIds) const
 
virtual void getCRSDeviceView (typename BaseAdapter< User >::ConstOffsetsDeviceView &offsets, typename BaseAdapter< User >::ConstIdsDeviceView &colIds) const
 
virtual void getCRSView (ArrayRCP< const offset_t > &offsets, ArrayRCP< const gno_t > &colIds, ArrayRCP< const scalar_t > &values) const
 Sets pointers to this process' matrix entries and their values using compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...
 
virtual void getCRSHostView (typename BaseAdapter< User >::ConstOffsetsHostView &offsets, typename BaseAdapter< User >::ConstIdsHostView &colIds, typename BaseAdapter< User >::ConstScalarsHostView &values) const
 
virtual void getCRSDeviceView (typename BaseAdapter< User >::ConstOffsetsDeviceView &offsets, typename BaseAdapter< User >::ConstIdsDeviceView &colIds, typename BaseAdapter< User >::ConstScalarsDeviceView &values) const
 
virtual void getRowWeightsHostView (typename BaseAdapter< User >::WeightsHostView1D &weights, int=0) const
 
virtual void getRowWeightsHostView (typename BaseAdapter< User >::WeightsHostView &weights) const
 
virtual void getRowWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView1D &weights, int=0) const
 
virtual void getRowWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView &weights) const
 
virtual bool CCSViewAvailable () const
 Indicates whether the MatrixAdapter implements a view of the matrix in compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...
 
virtual void getColumnIDsView (const gno_t *&colIds) const
 Sets pointer to this process' columns' global IDs. More...
 
virtual void getColumnIDsHostView (typename BaseAdapter< User >::ConstIdsHostView &colIds) const
 
virtual void getColumnIDsDeviceView (typename BaseAdapter< User >::ConstIdsDeviceView &colIds) const
 
virtual void getCCSView (ArrayRCP< const offset_t > &offsets, ArrayRCP< const gno_t > &rowIds) const
 Sets pointers to this process' matrix entries using compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...
 
virtual void getCCSView (ArrayRCP< const offset_t > &offsets, ArrayRCP< const gno_t > &rowIds, ArrayRCP< const scalar_t > &values) const
 Sets pointers to this process' matrix entries and their values using compressed sparse column (CCS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required. More...
 
virtual int getNumWeightsPerColumn () const
 Returns the number of weights per column (0 or greater). Column weights may be used when partitioning matrix columns. More...
 
virtual void getColumnWeightsView (const scalar_t *&weights, int &stride, int idx=0) const
 Provide a pointer to the column weights, if any. More...
 
virtual void getColumnWeightsHostView (typename BaseAdapter< User >::WeightsHostView1D &weights, int=0) const
 
virtual void getColumnWeightsHostView (typename BaseAdapter< User >::WeightsHostView &weights) const
 
virtual void getColumnWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView1D &weights, int=0) const
 
virtual void getColumnWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView &weights) const
 
virtual bool useNumNonzerosAsColumnWeight (int idx) const
 Indicate whether column weight with index idx should be the global number of nonzeros in the column. More...
 
void setCoordinateInput (VectorAdapter< UserCoord > *coordData) override
 Allow user to provide additional data that contains coordinate info associated with the MatrixAdapter's primaryEntityType. Associated data must have the same parallel distribution and ordering of entries as the primaryEntityType. More...
 
bool coordinatesAvailable () const
 Indicate whether coordinate information has been set for this MatrixAdapter. More...
 
VectorAdapter< UserCoord > * getCoordinateInput () const override
 Obtain the coordinate data registered by the user. More...
 
enum MatrixEntityType getPrimaryEntityType () const
 Returns the entity to be partitioned, ordered, colored, etc. Valid values are MATRIX_ROW, MATRIX_COLUMN, MATRIX_NONZERO. More...
 
void setPrimaryEntityType (std::string typestr)
 Sets the primary entity type. Called by algorithm based on parameter value in parameter list from application. Also sets to adjacencyEntityType to something reasonable: opposite of primaryEntityType. More...
 
size_t getLocalNumIDs () const override
 Returns the number of objects on this process. More...
 
void getIDsView (const gno_t *&Ids) const override
 Provide a pointer to this process' identifiers. More...
 
void getIDsHostView (typename BaseAdapter< User >::ConstIdsHostView &ids) const override
 
void getIDsDeviceView (typename BaseAdapter< User >::ConstIdsDeviceView &ids) const override
 
int getNumWeightsPerID () const override
 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...
 
void getWeightsView (const scalar_t *&wgt, int &stride, int idx=0) const override
 Provide pointer to a weight array with stride. More...
 
void getWeightsHostView (typename BaseAdapter< User >::WeightsHostView &hostWgts) const override
 
void getWeightsHostView (typename BaseAdapter< User >::WeightsHostView1D &hostWgts, int idx=0) const override
 
void getWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView &deviceWgts) const override
 
void getWeightsDeviceView (typename BaseAdapter< User >::WeightsDeviceView1D &deviceWgts, int idx=0) const override
 
bool useDegreeAsWeight (int idx) const
 
- Public Member Functions inherited from Zoltan2::BaseAdapter< User >
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 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
 

Additional Inherited Members

- 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, typename UserCoord = User>
class Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >

Provides access for Zoltan2 to Xpetra::CrsMatrix data.

Todo:

we assume FillComplete has been called. We should support objects that are not FillCompleted.

add RowMatrix

The template parameter is the user's input object:

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.

Definition at line 89 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

Constructor & Destructor Documentation

template<typename User , typename UserCoord >
Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::XpetraCrsMatrixAdapter ( const RCP< const User > &  inmatrix,
int  nWeightsPerRow = 0 
)

Constructor.

Parameters
inmatrixThe user's Epetra, Tpetra, or Xpetra CrsMatrix object
nWeightsPerRowIf row weights will be provided in setRowWeights(), then set nWeightsPerRow to the number of weights per row.

Definition at line 248 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

Member Function Documentation

template<typename User , typename UserCoord >
void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::setWeights ( const scalar_t weightVal,
int  stride,
int  idx = 0 
)

Specify a weight for each entity of the primaryEntityType.

Parameters
weightValA pointer to the weights for this index. A stride to be used in reading the values. The index idx weight for entity should be found at weightVal[k*stride].
idxA value between zero and one less that the nWeightsPerRow argument to the constructor.

The order of weights should correspond to the order of the primary entity type; see, e.g., setRowWeights below.

Definition at line 289 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User , typename UserCoord >
void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::setRowWeights ( const scalar_t weightVal,
int  stride,
int  idx = 0 
)

Specify a weight for each row.

Parameters
weightValA pointer to the weights for this index. A stride to be used in reading the values. The index idx weight for row should be found at weightVal[k*stride].
idxA value between zero and one less that the nWeightsPerRow argument to the constructor.

The order of weights should correspond to the order of rows returned by

theMatrix->getRowMap()->getLocalElementList();

Definition at line 307 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User , typename UserCoord >
void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::setWeightIsDegree ( int  idx)

Specify an index for which the weight should be the degree of the entity.

Parameters
idxZoltan2 will use the entity's degree as the entity weight for index idx.

Definition at line 326 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User , typename UserCoord >
void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::setRowWeightIsNumberOfNonZeros ( int  idx)

Specify an index for which the row weight should be the global number of nonzeros in the row.

Parameters
idxZoltan2 will use the global number of nonzeros in a row as the row weight for index idx.

Definition at line 343 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>
size_t Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getLocalNumRows ( ) const
inlinevirtual

Returns the number of rows on this process.

Implements Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 162 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>
size_t Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getLocalNumColumns ( ) const
inlinevirtual

Returns the number of columns on this process.

Implements Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 166 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>
size_t Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getLocalNumEntries ( ) const
inlinevirtual

Returns the number of nonzeros on this process.

Implements Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 170 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>
bool Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::CRSViewAvailable ( ) const
inlinevirtual

Indicates whether the MatrixAdapter implements a view of the matrix in compressed sparse row (CRS) format. All matrix adapters must implement either getCRSView or getCCSView, but implementation of both is not required.

Reimplemented from Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 174 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>
void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getRowIDsView ( const gno_t *&  rowIds) const
inline

Definition at line 176 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>
void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getCRSView ( ArrayRCP< const offset_t > &  offsets,
ArrayRCP< const gno_t > &  colIds 
) const
inline

Definition at line 182 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>
void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getCRSView ( ArrayRCP< const offset_t > &  offsets,
ArrayRCP< const gno_t > &  colIds,
ArrayRCP< const scalar_t > &  values 
) const
inline

Definition at line 191 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>
int Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getNumWeightsPerRow ( ) const
inlinevirtual

Returns the number of weights per row (0 or greater). Row weights may be used when partitioning matrix rows.

Reimplemented from Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 200 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>
void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::getRowWeightsView ( const scalar_t *&  weights,
int &  stride,
int  idx = 0 
) const
inlinevirtual

Provide a pointer to the row weights, if any.

Parameters
weightsis the list of weights with a given index for the rows returned in getRowIDsView().
strideThe k'th weight is located at weights[stride*k]
idxranges from zero to one less than getNumWeightsPerRow().

Reimplemented from Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 202 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User, typename UserCoord = User>
bool Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::useNumNonzerosAsRowWeight ( int  idx) const
inlinevirtual

Indicate whether row weight with index idx should be the global number of nonzeros in the row.

Reimplemented from Zoltan2::MatrixAdapter< User, UserCoord >.

Definition at line 217 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

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

Definition at line 361 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.

template<typename User , typename UserCoord >
template<typename Adapter >
void Zoltan2::XpetraCrsMatrixAdapter< User, UserCoord >::applyPartitioningSolution ( const User &  in,
RCP< User > &  out,
const PartitioningSolution< Adapter > &  solution 
) const

Definition at line 385 of file Zoltan2_XpetraCrsMatrixAdapter.hpp.


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