IdentifierModel defines the interface for all identifier models. More...
#include <Zoltan2_IdentifierModel.hpp>
Public Member Functions | |
| IdentifierModel (const Adapter *ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &modelFlags) | |
| Constructor. | |
| size_t | getLocalNumIdentifiers () const |
| global_size_t | getGlobalNumIdentifiers () const |
| size_t | getIdentifierList (ArrayView< const gno_t > &Ids, ArrayView< input_t > &wgts) const |
| size_t | getLocalNumObjects () const |
| Return the local number of objects. | |
| size_t | getGlobalNumObjects () const |
| Return the global number of objects. | |
| RCP< const idmap_t > | getIdentifierMap () const |
| Return the map from user global identifiers to internal Zoltan2 global numbers. | |
Protected Member Functions | |
| void | setIdentifierMap (RCP< const idmap_t > &map) |
| Set the IdentifierMap used by the model. | |
Detailed Description
template<typename Adapter>
class Zoltan2::IdentifierModel< Adapter >
IdentifierModel defines the interface for all identifier models.
The constructor of the IdentifierModel 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 70 of file Zoltan2_IdentifierModel.hpp.
Constructor & Destructor Documentation
| Zoltan2::IdentifierModel< Adapter >::IdentifierModel | ( | const Adapter * | ia, |
| const RCP< const Environment > & | env, | ||
| const RCP< const Comm< int > > & | comm, | ||
| modelFlag_t & | modelFlags | ||
| ) |
Constructor.
- Parameters:
-
ia the input adapter from which to build the model env the application environment (including problem parameters) comm the problem communicator modelFlags bit map of Zoltan2::IdentifierModelFlags
Definition at line 150 of file Zoltan2_IdentifierModel.hpp.
Member Function Documentation
| size_t Zoltan2::IdentifierModel< Adapter >::getLocalNumIdentifiers | ( | ) | const [inline] |
Returns the number of identifiers on this process.
Definition at line 95 of file Zoltan2_IdentifierModel.hpp.
| global_size_t Zoltan2::IdentifierModel< Adapter >::getGlobalNumIdentifiers | ( | ) | const [inline] |
Returns the global number identifiers.
Definition at line 99 of file Zoltan2_IdentifierModel.hpp.
| size_t Zoltan2::IdentifierModel< Adapter >::getIdentifierList | ( | ArrayView< const gno_t > & | Ids, |
| ArrayView< input_t > & | wgts | ||
| ) | const [inline] |
Sets pointers to this process' identifier Ids and their weights.
- Parameters:
-
Ids will on return point to the list of the global Ids for each identifier on this process. wgts will on return point to a list of the weight or weights associated with each identifier in the Ids list. Each weight is represented as a StridedData object.
- Returns:
- The number of ids in the Ids list.
Definition at line 111 of file Zoltan2_IdentifierModel.hpp.
| size_t Zoltan2::IdentifierModel< 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 131 of file Zoltan2_IdentifierModel.hpp.
| size_t Zoltan2::IdentifierModel< 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 133 of file Zoltan2_IdentifierModel.hpp.
| 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 139 of file Zoltan2_Model.hpp.
| 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 165 of file Zoltan2_Model.hpp.
The documentation for this class was generated from the following file:
