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

IdentifierModel defines the interface for all identifier models. More...

#include <Zoltan2_IdentifierModel.hpp>

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

Public Member Functions

 IdentifierModel (const RCP< const Adapter > &ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &modelFlags)
 Constructor. More...
 
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. More...
 
size_t getGlobalNumObjects () const
 Return the global number of objects. More...
 
- Public Member Functions inherited from Zoltan2::Model< Adapter >
virtual ~Model ()
 
 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

template<typename Adapter >
Zoltan2::IdentifierModel< Adapter >::IdentifierModel ( const RCP< const Adapter > &  ia,
const RCP< const Environment > &  env,
const RCP< const Comm< int > > &  comm,
modelFlag_t modelFlags 
)

Constructor.

Parameters
iathe input adapter from which to build the model
envthe application environment (including problem parameters)
commthe problem communicator
modelFlagsbit map of Zoltan2::IdentifierModelFlags

Definition at line 142 of file Zoltan2_IdentifierModel.hpp.

Member Function Documentation

template<typename Adapter>
size_t Zoltan2::IdentifierModel< Adapter >::getLocalNumIdentifiers ( ) const
inline

Returns the number of identifiers on this process.

Definition at line 94 of file Zoltan2_IdentifierModel.hpp.

template<typename Adapter>
global_size_t Zoltan2::IdentifierModel< Adapter >::getGlobalNumIdentifiers ( ) const
inline

Returns the global number identifiers.

Definition at line 98 of file Zoltan2_IdentifierModel.hpp.

template<typename Adapter>
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
Idswill on return point to the list of the global Ids for each identifier on this process.
wgtswill 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 110 of file Zoltan2_IdentifierModel.hpp.

template<typename Adapter>
size_t Zoltan2::IdentifierModel< Adapter >::getLocalNumObjects ( ) const
inlinevirtual

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 127 of file Zoltan2_IdentifierModel.hpp.

template<typename Adapter>
size_t Zoltan2::IdentifierModel< Adapter >::getGlobalNumObjects ( ) const
inlinevirtual

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 129 of file Zoltan2_IdentifierModel.hpp.


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