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

This class represents a collection of global Identifiers and their associated weights, if any. More...

#include <Zoltan2_BasicKokkosIdentifierAdapter.hpp>

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

Public Types

typedef InputTraits< User >
::scalar_t 
scalar_t
 
typedef InputTraits< User >::lno_t lno_t
 
typedef InputTraits< User >::gno_t gno_t
 
typedef InputTraits< User >::part_t part_t
 
typedef InputTraits< User >::node_t node_t
 
typedef node_t::device_type device_t
 
typedef User user_t
 
- 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
 

Public Member Functions

 BasicKokkosIdentifierAdapter (Kokkos::View< gno_t *, device_t > &ids, Kokkos::View< scalar_t **, device_t > &weights)
 Constructor. 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 getIDsKokkosView (Kokkos::View< const gno_t *, device_t > &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 getWeightsKokkosView (Kokkos::View< scalar_t **, device_t > &wgts) const override
 Provide kokkos view of weights. More...
 
- Public Member Functions inherited from Zoltan2::IdentifierAdapter< User >
enum BaseAdapterType adapterType () const
 Returns the type of adapter. More...
 
- 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 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

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

This class represents a collection of global Identifiers and their associated weights, if any.

The user supplies the identifiers and weights by way of pointers to arrays.

The template parameter (User) is a C++ class type which provides the actual data types with which the Zoltan2 library will be compiled, through a Traits mechanism. User may be the actual class used by application to represent coordinates, or it may be the empty helper class BasicUserTypes with which a Zoltan2 user can easily supply the data types for the library.

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.

Examples:
kokkosBlock.cpp.

Definition at line 84 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

Member Typedef Documentation

template<typename User >
typedef InputTraits<User>::scalar_t Zoltan2::BasicKokkosIdentifierAdapter< User >::scalar_t

Definition at line 87 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

template<typename User >
typedef InputTraits<User>::lno_t Zoltan2::BasicKokkosIdentifierAdapter< User >::lno_t

Definition at line 88 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

template<typename User >
typedef InputTraits<User>::gno_t Zoltan2::BasicKokkosIdentifierAdapter< User >::gno_t

Definition at line 89 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

template<typename User >
typedef InputTraits<User>::part_t Zoltan2::BasicKokkosIdentifierAdapter< User >::part_t

Definition at line 90 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

template<typename User >
typedef InputTraits<User>::node_t Zoltan2::BasicKokkosIdentifierAdapter< User >::node_t

Definition at line 91 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

template<typename User >
typedef node_t::device_type Zoltan2::BasicKokkosIdentifierAdapter< User >::device_t

Definition at line 92 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

template<typename User >
typedef User Zoltan2::BasicKokkosIdentifierAdapter< User >::user_t

Definition at line 93 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

Constructor & Destructor Documentation

template<typename User >
Zoltan2::BasicKokkosIdentifierAdapter< User >::BasicKokkosIdentifierAdapter ( Kokkos::View< gno_t *, device_t > &  ids,
Kokkos::View< scalar_t **, device_t > &  weights 
)

Constructor.

Parameters
idsshould point to a View of identifiers.
weightsa list of pointers to arrays of weights. The number of weights per identifier is assumed to be weights.extent(0).
weightStridesa list of strides for the weights. The weight for weight index n for ids[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 156 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

Member Function Documentation

template<typename User >
size_t Zoltan2::BasicKokkosIdentifierAdapter< User >::getLocalNumIDs ( ) const
inlineoverridevirtual

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

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

Provide a pointer to this process' identifiers.

Deprecated:
Use getIDsHostView instead.
Parameters
idswill on return point to the list of the global Ids for this process.

Reimplemented from Zoltan2::BaseAdapter< User >.

Definition at line 120 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

template<typename User >
void Zoltan2::BasicKokkosIdentifierAdapter< User >::getIDsKokkosView ( Kokkos::View< const gno_t *, device_t > &  ids) const
inlineoverride

Definition at line 125 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

template<typename User >
int Zoltan2::BasicKokkosIdentifierAdapter< User >::getNumWeightsPerID ( ) const
inlineoverridevirtual

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 129 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

template<typename User >
void Zoltan2::BasicKokkosIdentifierAdapter< User >::getWeightsView ( const scalar_t *&  wgt,
int &  stride,
int  idx = 0 
) const
inlineoverridevirtual

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

Reimplemented from Zoltan2::BaseAdapter< User >.

Definition at line 133 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.

template<typename User >
void Zoltan2::BasicKokkosIdentifierAdapter< User >::getWeightsKokkosView ( Kokkos::View< scalar_t **, device_t > &  wgt) const
inlineoverridevirtual

Provide kokkos view of weights.

Parameters
wgton return a Kokkos view of the weights for this idx This function or getWeightsView must be implemented in derived adapter if getNumWeightsPerID > 0. This function should not be called if getNumWeightsPerID is zero.

Reimplemented from Zoltan2::BaseAdapter< User >.

Definition at line 142 of file Zoltan2_BasicKokkosIdentifierAdapter.hpp.


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