Zoltan2 Version of the Day
Public Member Functions | Static Public Member Functions
Zoltan2::CoordinateInput< User > Class Template Reference

CoordinateInput defines the interface for input geometric coordinates. More...

#include <Zoltan2_CoordinateInput.hpp>

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

List of all members.

Public Member Functions

virtual ~CoordinateInput ()
 Destructor.
enum InputAdapterType inputAdapterType () const
 Returns the type of adapter.
virtual int getCoordinateDimension () const =0
 Return dimension of the coordinates.
virtual int getNumberOfWeights () const =0
 Return the number of weights per coordinate.
virtual size_t getLocalNumberOfCoordinates () const =0
 Return the number of coordinates on this process.
virtual size_t getCoordinates (int coordDim, const gid_t *&gids, const scalar_t *&coords, int &stride) const =0
 Provide a pointer to one dimension of this process' coordinates.
virtual size_t getCoordinateWeights (int weightDim, const scalar_t *&weights, int &stride) const =0
 Provide a pointer to the weights, if any, corresponding to the coordinates returned in getCoordinates().
template<typename Adapter >
size_t applyPartitioningSolution (User &in, User *&out, const PartitioningSolution< Adapter > &solution) const
 Apply a PartitioningSolution to an input.
virtual string inputAdapterName () const =0
 Returns a descriptive name that identifies the concrete adapter.
virtual size_t getLocalNumberOfObjects () const =0
 Returns the number of objects in the input.
virtual int getNumberOfWeightsPerObject () const =0
 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.
virtual size_t getObjectWeights (int dim, const scalar_t *&wgt, int &stride) const =0
 Provide pointer to a weight array with stride.

Static Public Member Functions

static string inputAdapterTypeName (InputAdapterType iaType)
 Returns the name of the input adapter.

Detailed Description

template<typename User>
class Zoltan2::CoordinateInput< User >

CoordinateInput defines the interface for input geometric coordinates.

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

See IdentifierTraits to understand why the user's global ID type (gid_t) may differ from that used by Zoltan2 (gno_t).

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

Input adapters provide access for Zoltan2 to the user's data. The methods in the interface must be defined by users. Many built-in adapters are already defined for common data structures, such as Tpetra and Epetra objects and C-language pointers to arrays.

Todo:

We don't really need global Ids. They should be optional

Migration doesn't move weights. Should it?

Definition at line 106 of file Zoltan2_CoordinateInput.hpp.


Constructor & Destructor Documentation

template<typename User >
virtual Zoltan2::CoordinateInput< User >::~CoordinateInput ( ) [inline, virtual]

Destructor.

Definition at line 121 of file Zoltan2_CoordinateInput.hpp.


Member Function Documentation

template<typename User >
enum InputAdapterType Zoltan2::CoordinateInput< User >::inputAdapterType ( ) const [inline, virtual]

Returns the type of adapter.

Implements Zoltan2::InputAdapter< User >.

Definition at line 127 of file Zoltan2_CoordinateInput.hpp.

template<typename User >
virtual int Zoltan2::CoordinateInput< User >::getCoordinateDimension ( ) const [pure virtual]

Return dimension of the coordinates.

Implemented in Zoltan2::BasicCoordinateInput< User >.

template<typename User >
virtual int Zoltan2::CoordinateInput< User >::getNumberOfWeights ( ) const [pure virtual]

Return the number of weights per coordinate.

Returns:
the count of weights, zero or more per coordinate.

Implemented in Zoltan2::BasicCoordinateInput< User >.

template<typename User >
virtual size_t Zoltan2::CoordinateInput< User >::getLocalNumberOfCoordinates ( ) const [pure virtual]

Return the number of coordinates on this process.

Returns:
the count of coordinates on the local process.

Implemented in Zoltan2::BasicCoordinateInput< User >.

template<typename User >
virtual size_t Zoltan2::CoordinateInput< User >::getCoordinates ( int  coordDim,
const gid_t *&  gids,
const scalar_t *&  coords,
int &  stride 
) const [pure virtual]

Provide a pointer to one dimension of this process' coordinates.

Parameters:
coordDimis a value from 0 to one less than getLocalNumberOfCoordinates() specifying which dimension is being provided in the coords list.
coordspoints to a list of coordinate values for the dimension.
stridedescribes the layout of the coordinate values in the coords list. If stride is one, then the ith coordinate value is coords[i], but if stride is two, then the ith coordinate value is coords[2*i].
Returns:
The length of the coords list. This may be more than getLocalNumberOfCoordinates() because the stride may be more than one.

Zoltan2 does not copy your data. The data pointed to coords must remain valid for the lifetime of this InputAdapter.

Implemented in Zoltan2::BasicCoordinateInput< User >.

template<typename User >
virtual size_t Zoltan2::CoordinateInput< User >::getCoordinateWeights ( int  weightDim,
const scalar_t *&  weights,
int &  stride 
) const [pure virtual]

Provide a pointer to the weights, if any, corresponding to the coordinates returned in getCoordinates().

Parameters:
weightDimranges from zero to one less than getNumberOfWeights()
weightsis the list of weights of the given dimension for the coordinates listed in getCoordinates(). If weights for this dimension are to be uniform for all coordinates in the global problem, the weights should be a NULL pointer.
strideThe k'th weight is located at weights[stride*k]
Returns:
The number of weights listed, which should be at least the local number of coordinates times the stride for non-uniform weights, zero otherwise.

Implemented in Zoltan2::BasicCoordinateInput< User >.

template<typename User >
template<typename Adapter >
size_t Zoltan2::CoordinateInput< User >::applyPartitioningSolution ( User &  in,
User *&  out,
const PartitioningSolution< Adapter > &  solution 
) const [inline]

Apply a PartitioningSolution to an input.

This is not a required part of the CoordinateInput interface. However if the Caller calls a Problem method to redistribute data, it needs this method to perform the redistribution.

Parameters:
inAn input object with a structure and assignment of of global Ids to processes that matches that of the input data that instantiated this InputAdapter.
outOn return this should point to a newly created object with the specified partitioning.
solutionThe Solution object created by a Problem should be supplied as the third argument. It must have been templated on user data that has the same global ID distribution as this user data.
Returns:
Returns the number of local Ids in the new partitioning.

Definition at line 204 of file Zoltan2_CoordinateInput.hpp.

template<typename User >
virtual string Zoltan2::InputAdapter< User >::inputAdapterName ( ) const [pure virtual, inherited]
template<typename User >
virtual size_t Zoltan2::InputAdapter< User >::getLocalNumberOfObjects ( ) const [pure virtual, inherited]

Returns the number of objects in the input.

Objects may be coordinates, graph vertices, matrix rows, etc. They are the objects to be partitioned, ordered, or colored.

Implemented in Zoltan2::BasicCoordinateInput< User >, Zoltan2::BasicIdentifierInput< User >, Zoltan2::BasicVectorInput< User >, Zoltan2::XpetraCrsGraphInput< User >, Zoltan2::XpetraCrsMatrixInput< User >, Zoltan2::XpetraMultiVectorInput< User >, Zoltan2::XpetraRowMatrixInput< User >, and Zoltan2::XpetraVectorInput< User >.

template<typename User >
virtual int Zoltan2::InputAdapter< User >::getNumberOfWeightsPerObject ( ) const [pure virtual, inherited]

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.

Implemented in Zoltan2::BasicCoordinateInput< User >, Zoltan2::BasicIdentifierInput< User >, Zoltan2::BasicVectorInput< User >, Zoltan2::XpetraCrsGraphInput< User >, Zoltan2::XpetraCrsMatrixInput< User >, Zoltan2::XpetraMultiVectorInput< User >, Zoltan2::XpetraRowMatrixInput< User >, and Zoltan2::XpetraVectorInput< User >.

template<typename User >
virtual size_t Zoltan2::InputAdapter< User >::getObjectWeights ( int  dim,
const scalar_t *&  wgt,
int &  stride 
) const [pure virtual, inherited]

Provide pointer to a weight array with stride.

Parameters:
dimthe weight dimension, zero or greater
wgton return a pointer to the weights for this dimension
strideon return, the value such that the nth weight should be found at wgt[n*stride] .
Returns:
the length of the wgt array, which should be at least equal to getLocalNumberOfObjects() * stride .

Implemented in Zoltan2::BasicCoordinateInput< User >, Zoltan2::BasicIdentifierInput< User >, Zoltan2::BasicVectorInput< User >, Zoltan2::XpetraCrsGraphInput< User >, Zoltan2::XpetraCrsMatrixInput< User >, Zoltan2::XpetraMultiVectorInput< User >, Zoltan2::XpetraRowMatrixInput< User >, and Zoltan2::XpetraVectorInput< User >.

template<typename User >
string Zoltan2::InputAdapter< User >::inputAdapterTypeName ( InputAdapterType  iaType) [static, inherited]

Returns the name of the input adapter.

Definition at line 134 of file Zoltan2_InputAdapter.hpp.


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