Epetra_Distributor Class Reference

Epetra_Distributor: The Epetra Gather/Scatter Setup Base Class. More...

#include <Epetra_Distributor.h>

Inheritance diagram for Epetra_Distributor:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Constructor and Destructor

virtual Epetra_DistributorClone ()=0
 Epetra_Distributor clone constructor.
virtual ~Epetra_Distributor ()
 Epetra_Distributor Destructor.
Gather/Scatter Constructors

virtual int CreateFromSends (const int &NumExportIDs, const int *ExportPIDs, bool Deterministic, int &NumRemoteIDs)=0
 Create Distributor object using list of process IDs to which we export.
virtual int CreateFromRecvs (const int &NumRemoteIDs, const int *RemoteGIDs, const int *RemotePIDs, bool Deterministic, int &NumExportIDs, int *&ExportGIDs, int *&ExportPIDs)=0
 Create Distributor object using list of Remote global IDs and corresponding PIDs.
Execute Gather/Scatter Operations (Constant size objects)

virtual int Do (char *export_objs, int obj_size, int &len_import_objs, char *&import_objs)=0
 Execute plan on buffer of export objects in a single step.
virtual int DoReverse (char *export_objs, int obj_size, int &len_import_objs, char *&import_objs)=0
 Execute reverse of plan on buffer of export objects in a single step.
virtual int DoPosts (char *export_objs, int obj_size, int &len_import_objs, char *&import_objs)=0
 Post buffer of export objects (can do other local work before executing Waits).
virtual int DoWaits ()=0
 Wait on a set of posts.
virtual int DoReversePosts (char *export_objs, int obj_size, int &len_import_objs, char *&import_objs)=0
 Do reverse post of buffer of export objects (can do other local work before executing Waits).
virtual int DoReverseWaits ()=0
 Wait on a reverse set of posts.
Execute Gather/Scatter Operations (Non-constant size objects)

virtual int Do (char *export_objs, int obj_size, int *&sizes, int &len_import_objs, char *&import_objs)=0
 Execute plan on buffer of export objects in a single step (object size may vary).
virtual int DoReverse (char *export_objs, int obj_size, int *&sizes, int &len_import_objs, char *&import_objs)=0
 Execute reverse of plan on buffer of export objects in a single step (object size may vary).
virtual int DoPosts (char *export_objs, int obj_size, int *&sizes, int &len_import_objs, char *&import_objs)=0
 Post buffer of export objects (can do other local work before executing Waits).
virtual int DoReversePosts (char *export_objs, int obj_size, int *&sizes, int &len_import_objs, char *&import_objs)=0
 Do reverse post of buffer of export objects (can do other local work before executing Waits).
Print object to an output stream

virtual void Print (ostream &os) const =0

Detailed Description

Epetra_Distributor: The Epetra Gather/Scatter Setup Base Class.

The Epetra_Distributor class is an interface that encapsulates the general information and services needed for other Epetra classes to perform gather/scatter operations on a parallel computer. An Epetra_Distributor object is actually produced by calling a method in the Epetra_Comm class.

Epetra_Distributor has default implementations, via Epetra_SerialDistributor and Epetra_MpiDistributor, for both serial execution and MPI distributed memory execution. It is meant to insulate the user from the specifics of communication that are not required for normal manipulation of linear algebra objects..


Member Function Documentation

virtual int Epetra_Distributor::CreateFromRecvs ( const int &  NumRemoteIDs,
const int *  RemoteGIDs,
const int *  RemotePIDs,
bool  Deterministic,
int &  NumExportIDs,
int *&  ExportGIDs,
int *&  ExportPIDs 
) [pure virtual]

Create Distributor object using list of Remote global IDs and corresponding PIDs.

Take a list of global IDs and construct a plan for efficiently scattering to these processes. Return the number and list of IDs being sent by me.

Parameters:
NumRemoteIDs In Number of IDs this processor will be receiving.
RemoteGIDs In List of IDs that this processor wants.
RemotePIDs In List of processors that will send the remote IDs.
Deterministic In No op.
NumExportIDs Out Number of IDs that need to be sent from this processor.
ExportPIDs Out List of processors that will get the exported IDs.

Implemented in Epetra_MpiDistributor, and Epetra_SerialDistributor.

virtual int Epetra_Distributor::CreateFromSends ( const int &  NumExportIDs,
const int *  ExportPIDs,
bool  Deterministic,
int &  NumRemoteIDs 
) [pure virtual]

Create Distributor object using list of process IDs to which we export.

Take a list of Process IDs and construct a plan for efficiently scattering to these processes. Return the number of IDs being sent to me.

Parameters:
NumExportIDs In Number of IDs that need to be sent from this processor.
ExportPIDs In List of processors that will get the exported IDs.
Deterministic In No op.
NumRemoteIDs Out Number of IDs this processor will be receiving.

Implemented in Epetra_MpiDistributor, and Epetra_SerialDistributor.


The documentation for this class was generated from the following file:
 All Classes Files Functions Enumerations Enumerator
Generated on Wed Apr 13 09:58:33 2011 for Epetra by  doxygen 1.6.3