Zoltan2 Version of the Day
Public Member Functions | Protected Member Functions | Static Protected Member Functions
Zoltan2::GraphModel< Adapter > Class Template Reference

GraphModel defines the interface required for graph models. More...

#include <Zoltan2_GraphModel.hpp>

Inheritance diagram for Zoltan2::GraphModel< Adapter >:
Inheritance graph
[legend]
Collaboration diagram for Zoltan2::GraphModel< Adapter >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 GraphModel (const Adapter *ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &modelFlags)
 Constructor.
size_t getLocalNumVertices () const
 Returns the number vertices on this process.
size_t getGlobalNumVertices () const
 Returns the global number vertices.
size_t getLocalNumGlobalEdges () const
 Returns the number of global edges on this process. Includes remote edges.
size_t getLocalNumLocalEdges () const
 Returns the number of local edges on this process. Does not include edges to off-process vertices.
size_t getGlobalNumEdges () const
 Returns the global number edges.
int getVertexWeightDim () const
 Returns the dimension (0 or greater) of vertex weights.
int getEdgeWeightDim () const
 Returns the dimension (0 or greater) of edge weights.
int getCoordinateDim () const
 Returns the dimension (0 to 3) of vertex coordinates.
size_t getVertexList (ArrayView< const gno_t > &Ids, ArrayView< input_t > &xyz, ArrayView< input_t > &wgts) const
 Sets pointers to this process' vertex Ids and their weights.
size_t getEdgeList (ArrayView< const gno_t > &edgeIds, ArrayView< const int > &procIds, ArrayView< const lno_t > &offsets, ArrayView< input_t > &wgts) const
 Sets pointers to this process' edge (neighbor) global Ids, including off-process edges.
size_t getLocalEdgeList (ArrayView< const lno_t > &edgeIds, ArrayView< const lno_t > &offsets, ArrayView< input_t > &wgts)
 Sets pointers to this process' local-only edge (neighbor) LNOs, using the same implied vertex LNOs returned in getVertexList.
size_t getLocalNumObjects () const
 Return the local number of objects.
size_t getGlobalNumObjects () const
 Return the global number of objects.
void getGlobalObjectIds (ArrayView< const gno_t > &gnos) const
 Get a list of the global Ids for the local objects.
RCP< const idmap_t > getIdentifierMap () const
 Return the map from user global identifiers to internal Zoltan2 global numbers.
int getNumWeights () const
 Return the number of weights supplied for each object. If the user supplied no weights, dimension one is returned, because one dimension of uniform weights is implied.
bool uniformWeight (int weightDim) const
 Return whether the weights are uniform or not.

Protected Member Functions

void setIdentifierMap (RCP< const idmap_t > &map)
 Set the IdentifierMap used by the model.
void setWeightArrayLengths (const Array< lno_t > &len, const Teuchos::Comm< int > &comm)
 Set the length of each weight array. The Model calls this in the constructor so we know which weights are uniform. If lengths for a given weight dimension are zero on all processes, then we know that uniform weights are implied.

Static Protected Member Functions

template<typename T >
static void maxCount (const Comm< int > &comm, Array< T > &countValues)
 Get the global maximum for each of an array of values.
template<typename T >
static void maxCount (const Comm< int > &comm, T &value1)
 Get the global maximum for a value.
template<typename T >
static void maxCount (const Comm< int > &comm, T &value1, T &value2)
 Get the global maximums for each of two values.

Detailed Description

template<typename Adapter>
class Zoltan2::GraphModel< Adapter >

GraphModel defines the interface required for graph models.

The constructor of the GraphModel can be a global call, requiring all processes in the application to call it. The rest of the methods should be local methods.

The template parameter is an InputAdapter, which is an object that provides a uniform interface for models to the user's input data.

Definition at line 404 of file Zoltan2_GraphModel.hpp.


Constructor & Destructor Documentation

template<typename Adapter>
Zoltan2::GraphModel< Adapter >::GraphModel ( const Adapter *  ia,
const RCP< const Environment > &  env,
const RCP< const Comm< int > > &  comm,
modelFlag_t modelFlags 
) [inline]

Constructor.

Parameters:
inputAdaptera pointer to the user's data
envobject containing the parameters
commcommunicator for the problem
modelFlagsa bit map of Zoltan2::GraphModelFlags

All processes in the communicator must call the constructor.

Todo:
document the model flags that might be set

Definition at line 426 of file Zoltan2_GraphModel.hpp.


Member Function Documentation

template<typename Adapter>
size_t Zoltan2::GraphModel< Adapter >::getLocalNumVertices ( ) const [inline]

Returns the number vertices on this process.

Definition at line 435 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
size_t Zoltan2::GraphModel< Adapter >::getGlobalNumVertices ( ) const [inline]

Returns the global number vertices.

Definition at line 439 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
size_t Zoltan2::GraphModel< Adapter >::getLocalNumGlobalEdges ( ) const [inline]

Returns the number of global edges on this process. Includes remote edges.

Definition at line 444 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
size_t Zoltan2::GraphModel< Adapter >::getLocalNumLocalEdges ( ) const [inline]

Returns the number of local edges on this process. Does not include edges to off-process vertices.

Definition at line 449 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
size_t Zoltan2::GraphModel< Adapter >::getGlobalNumEdges ( ) const [inline]

Returns the global number edges.

Definition at line 453 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
int Zoltan2::GraphModel< Adapter >::getVertexWeightDim ( ) const [inline]

Returns the dimension (0 or greater) of vertex weights.

Definition at line 457 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
int Zoltan2::GraphModel< Adapter >::getEdgeWeightDim ( ) const [inline]

Returns the dimension (0 or greater) of edge weights.

Definition at line 461 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
int Zoltan2::GraphModel< Adapter >::getCoordinateDim ( ) const [inline]

Returns the dimension (0 to 3) of vertex coordinates.

Definition at line 465 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
size_t Zoltan2::GraphModel< Adapter >::getVertexList ( ArrayView< const gno_t > &  Ids,
ArrayView< input_t > &  xyz,
ArrayView< input_t > &  wgts 
) const [inline]

Sets pointers to this process' vertex Ids and their weights.

Parameters:
Idswill on return point to the list of the global Ids for each vertex on this process.
xyzIf vertex coordinate data is available, xyz will on return point to a StridedData object of coordinates.
wgtsIf vertex weights is available, wgts will on return point to a StridedData object of weights.

Definition at line 477 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
size_t Zoltan2::GraphModel< Adapter >::getEdgeList ( ArrayView< const gno_t > &  edgeIds,
ArrayView< const int > &  procIds,
ArrayView< const lno_t > &  offsets,
ArrayView< input_t > &  wgts 
) const [inline]

Sets pointers to this process' edge (neighbor) global Ids, including off-process edges.

Parameters:
edgeIdsThis is the list of global neighbor Ids corresponding to the vertices listed in getVertexList.
procIdslists the process owning each neighbor in the edgeIds list.
offsetsoffsets[i] is the offset into edgeIds to the start of neighbors for ith vertex.
wgtsIf edge weights is available, wgts will on return point to a StridedData object of weights.
Returns:
The number of ids in the edgeIds list.

Definition at line 498 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
size_t Zoltan2::GraphModel< Adapter >::getLocalEdgeList ( ArrayView< const lno_t > &  edgeIds,
ArrayView< const lno_t > &  offsets,
ArrayView< input_t > &  wgts 
) [inline]

Sets pointers to this process' local-only edge (neighbor) LNOs, using the same implied vertex LNOs returned in getVertexList.

Local only means the neighbor vertex is owned by this process.

Parameters:
edgeIdslists the only neighbors of the vertices in getVertexList which are on this process. The Id returned is not the neighbor's global Id, but rather the index of the neighbor in the list returned by getVertexList.
offsetsoffsets[i] is the offset into edgeIds to the start of neighbors for ith vertex returned in getVertexList.
wgtsIf edge weights is available, wgts will on return point to a StridedData object of weights.
Returns:
The number of ids in the edgeIds list.

This method is not const, because a local edge list is not created unless this method is called.

Note that if there are no local edges, the edgeIds, offsets and wgts are returned as empty arrays.

Definition at line 525 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
size_t Zoltan2::GraphModel< Adapter >::getLocalNumObjects ( ) const [inline, virtual]

Return the local number of objects.

Return the local number of objects, which may be vertices, matrix rows, identifiers, coordinates, or mesh nodes or elements.

Implements Zoltan2::Model< Adapter >.

Definition at line 533 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
size_t Zoltan2::GraphModel< Adapter >::getGlobalNumObjects ( ) const [inline, virtual]

Return the global number of objects.

Return the global number of objects, which may be vertices, matrix rows, identifiers, coordinates, or mesh nodes or elements.

Implements Zoltan2::Model< Adapter >.

Definition at line 535 of file Zoltan2_GraphModel.hpp.

template<typename Adapter>
void Zoltan2::GraphModel< Adapter >::getGlobalObjectIds ( ArrayView< const gno_t > &  gnos) const [inline, virtual]

Get a list of the global Ids for the local objects.

Set a view to the list of object global numbers, which may be vertex IDs, matrix row IDs, identifiers, coordinate IDs, or mesh node or element IDs.

Implements Zoltan2::Model< Adapter >.

Definition at line 537 of file Zoltan2_GraphModel.hpp.

template<typename Adapter >
RCP<const idmap_t > Zoltan2::Model< Adapter >::getIdentifierMap ( ) const [inline, inherited]

Return the map from user global identifiers to internal Zoltan2 global numbers.

Every model must have an IdentifierMap, whether it needs for mapping or not. The Map can simply indicate that Zoltan2 global numbers are identical to the application's global IDs.

Definition at line 135 of file Zoltan2_Model.hpp.

template<typename Adapter >
int Zoltan2::Model< Adapter >::getNumWeights ( ) const [inline, inherited]

Return the number of weights supplied for each object. If the user supplied no weights, dimension one is returned, because one dimension of uniform weights is implied.

The concrete subclasses, however, return the number of weights supplied by the user.

Definition at line 144 of file Zoltan2_Model.hpp.

template<typename Adapter >
bool Zoltan2::Model< Adapter >::uniformWeight ( int  weightDim) const [inline, inherited]

Return whether the weights are uniform or not.

Parameters:
weightDima value from 0 to one less than the number of weights.
Returns:
1 if the weights for that dimension are uniform, 0 if there is a list of differing weights for that dimension.

Definition at line 151 of file Zoltan2_Model.hpp.

template<typename Adapter >
void Zoltan2::Model< Adapter >::setIdentifierMap ( RCP< const idmap_t > &  map) [inline, protected, inherited]

Set the IdentifierMap used by the model.

The Model should set the identifier map with this call during the constructor.

Definition at line 184 of file Zoltan2_Model.hpp.

template<typename Adapter >
void Zoltan2::Model< Adapter >::setWeightArrayLengths ( const Array< lno_t > &  len,
const Teuchos::Comm< int > &  comm 
) [inline, protected, inherited]

Set the length of each weight array. The Model calls this in the constructor so we know which weights are uniform. If lengths for a given weight dimension are zero on all processes, then we know that uniform weights are implied.

This must be called by all processes.

Definition at line 193 of file Zoltan2_Model.hpp.

template<typename Adapter >
template<typename T >
static void Zoltan2::Model< Adapter >::maxCount ( const Comm< int > &  comm,
Array< T > &  countValues 
) [inline, static, protected, inherited]

Get the global maximum for each of an array of values.

Certain counts may not be available from processes that have no data. Models should find the maximum value of the count across all processes to get the correct count. (Examples are coordinate dimension and weight dimension.)

Definition at line 241 of file Zoltan2_Model.hpp.

template<typename Adapter >
template<typename T >
static void Zoltan2::Model< Adapter >::maxCount ( const Comm< int > &  comm,
T &  value1 
) [inline, static, protected, inherited]

Get the global maximum for a value.

Certain counts may not be available from processes that have no data. Models should find the maximum value of the count across all processes to get the correct count. (Examples are coordinate dimension and weight dimension.)

Definition at line 261 of file Zoltan2_Model.hpp.

template<typename Adapter >
template<typename T >
static void Zoltan2::Model< Adapter >::maxCount ( const Comm< int > &  comm,
T &  value1,
T &  value2 
) [inline, static, protected, inherited]

Get the global maximums for each of two values.

Certain counts may not be available from processes that have no data. Models should find the maximum value of the count across all processes to get the correct count. (Examples are coordinate dimension and weight dimension.)

Definition at line 276 of file Zoltan2_Model.hpp.


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