Zoltan2
Public Member Functions | Protected Member Functions
Zoltan2::Model< Adapter > Class Template Reference

The base class for all model classes. More...

#include <Zoltan2_Model.hpp>

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

List of all members.

Public Member Functions

virtual ~Model ()
 Model ()
RCP< const idmap_t > getIdentifierMap () const
 Return the map from user global identifiers to internal Zoltan2 global numbers.
virtual size_t getLocalNumObjects () const =0
 Return the local number of objects.
virtual global_size_t getGlobalNumObjects () const =0
 Return the global number of objects.

Protected Member Functions

void setIdentifierMap (RCP< const idmap_t > &map)
 Set the IdentifierMap used by the model.

Detailed Description

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

The base class for all model classes.

The Model is the computational model created by a Problem based on the user's input data and parameters. Graphs, hypergraph, and collections of geometric coordinates are examples of computational models.

The Problem passes the Model to an algorithm. The algorithm queries the Model for input to its calculation.

Todo:
Add HypergraphModel, CoordinateModel

Definition at line 110 of file Zoltan2_Model.hpp.


Constructor & Destructor Documentation

template<typename Adapter>
virtual Zoltan2::Model< Adapter >::~Model ( ) [inline, virtual]

Destructor

Definition at line 126 of file Zoltan2_Model.hpp.

template<typename Adapter>
Zoltan2::Model< Adapter >::Model ( ) [inline]

Constructor

Definition at line 130 of file Zoltan2_Model.hpp.


Member Function Documentation

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

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 139 of file Zoltan2_Model.hpp.

template<typename Adapter>
virtual size_t Zoltan2::Model< Adapter >::getLocalNumObjects ( ) const [pure 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.

Implemented in Zoltan2::CoordinateModel< Adapter >, Zoltan2::GraphModel< Adapter >, and Zoltan2::IdentifierModel< Adapter >.

template<typename Adapter>
virtual global_size_t Zoltan2::Model< Adapter >::getGlobalNumObjects ( ) const [pure 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.

Implemented in Zoltan2::CoordinateModel< Adapter >, Zoltan2::GraphModel< Adapter >, and Zoltan2::IdentifierModel< Adapter >.

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

Set the IdentifierMap used by the model.

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

Definition at line 165 of file Zoltan2_Model.hpp.


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