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

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

#include <Zoltan2_Model.hpp>

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

Public Member Functions

virtual ~Model ()
 
 Model ()
 
virtual size_t getLocalNumObjects () const =0
 Return the local number of objects. More...
 
virtual global_size_t getGlobalNumObjects () const =0
 Return the global number of objects. More...
 

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 ( )
inlinevirtual

Destructor

Definition at line 124 of file Zoltan2_Model.hpp.

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

Constructor

Definition at line 128 of file Zoltan2_Model.hpp.

Member Function Documentation

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::HyperGraphModel< Adapter >, Zoltan2::GraphModel< Adapter >, Zoltan2::CoordinateModel< 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::HyperGraphModel< Adapter >, Zoltan2::GraphModel< Adapter >, Zoltan2::CoordinateModel< Adapter >, and Zoltan2::IdentifierModel< Adapter >.


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