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

IdentifierAdapter defines the interface for identifiers. More...

#include <Zoltan2_IdentifierAdapter.hpp>

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

Public Member Functions

virtual ~IdentifierAdapter ()
 Destructor. More...
 
enum BaseAdapterType adapterType () const
 Returns the type of adapter. More...
 
- Public Member Functions inherited from Zoltan2::BaseAdapter< User >
virtual ~BaseAdapter ()
 Destructor. More...
 
virtual void getIDsView (const gno_t *&ids) const
 Provide a pointer to this process' identifiers. More...
 
virtual void getIDsKokkosView (Kokkos::View< gno_t * > &) const
 Provide a pointer to this process' identifiers. More...
 
virtual void getWeightsView (const scalar_t *&wgt, int &stride, int idx=0) const
 Provide pointer to a weight array with stride. More...
 
virtual void getWeightsKokkosView (Kokkos::View< scalar_t * > &, int=0) const
 Provide pointer to a weight View. 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...
 
- Public Member Functions inherited from Zoltan2::BaseAdapterRoot
virtual ~BaseAdapterRoot ()
 
virtual size_t getLocalNumIDs () const =0
 Returns the number of objects on this process. 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...
 

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

IdentifierAdapter defines the interface for identifiers.

Zoltan2 can partition a simple list of weighted identifiers with no geometry or topology provided. IdentifierAdapter defines the interface for adapters of this type.

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.

Definition at line 96 of file Zoltan2_IdentifierAdapter.hpp.

Constructor & Destructor Documentation

template<typename User >
virtual Zoltan2::IdentifierAdapter< User >::~IdentifierAdapter ( )
inlinevirtual

Destructor.

Definition at line 113 of file Zoltan2_IdentifierAdapter.hpp.

Member Function Documentation

template<typename User >
enum BaseAdapterType Zoltan2::IdentifierAdapter< User >::adapterType ( ) const
inlinevirtual

Returns the type of adapter.

Implements Zoltan2::BaseAdapter< User >.

Definition at line 115 of file Zoltan2_IdentifierAdapter.hpp.


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