Epetra_SerialDistributor Class Reference

Epetra_SerialDistributor: The Epetra Serial implementation of the Epetra_Distributor Gather/Scatter Setup Class. More...

#include <Epetra_SerialDistributor.h>

Inheritance diagram for Epetra_SerialDistributor:

Public Member Functions
int	CreateFromSends (const int &NumExportIDs, const int *ExportPIDs, bool Deterministic, int &NumRemoteIDs)
	Create Distributor object using list of process IDs to which we export. More...
int	CreateFromRecvs (const int &NumRemoteIDs, const int *RemoteGIDs, const int *RemotePIDs, bool Deterministic, int &NumExportIDs, int *&ExportGIDs, int *&ExportPIDs)
	Create Distributor object using list of Remote global IDs and corresponding PIDs. More...
int	CreateFromRecvs (const int &NumRemoteIDs, const long long *RemoteGIDs, const int *RemotePIDs, bool Deterministic, int &NumExportIDs, long long *&ExportGIDs, int *&ExportPIDs)
int	Do (char *export_objs, int obj_size, int &len_import_objs, char *&import_objs)
	Execute plan on buffer of export objects in a single step. More...
int	DoReverse (char *export_objs, int obj_size, int &len_import_objs, char *&import_objs)
	Execute reverse of plan on buffer of export objects in a single step. More...
int	DoPosts (char *export_objs, int obj_size, int &len_import_objs, char *&import_objs)
	Post buffer of export objects (can do other local work before executing Waits) More...
int	DoWaits ()
	Wait on a set of posts. More...
int	DoReversePosts (char *export_objs, int obj_size, int &len_import_objs, char *&import_objs)
	Do reverse post of buffer of export objects (can do other local work before executing Waits) More...
int	DoReverseWaits ()
	Wait on a reverse set of posts. More...
int	Do (char *export_objs, int obj_size, int *&sizes, int &len_import_objs, char *&import_objs)
	Execute plan on buffer of export objects in a single step (object size may vary) More...
int	DoReverse (char *export_objs, int obj_size, int *&sizes, int &len_import_objs, char *&import_objs)
	Execute reverse of plan on buffer of export objects in a single step (object size may vary) More...
int	DoPosts (char *export_objs, int obj_size, int *&sizes, int &len_import_objs, char *&import_objs)
	Post buffer of export objects (can do other local work before executing Waits) More...
int	DoReversePosts (char *export_objs, int obj_size, int *&sizes, int &len_import_objs, char *&import_objs)
	Do reverse post of buffer of export objects (can do other local work before executing Waits) More...
virtual void	Print (std::ostream &os) const
Public Member Functions inherited from Epetra_Object
	Epetra_Object (int TracebackModeIn=-1, bool set_label=true)
	Epetra_Object Constructor. More...
	Epetra_Object (const char *const Label, int TracebackModeIn=-1)
	Epetra_Object Constructor. More...
	Epetra_Object (const Epetra_Object &Object)
	Epetra_Object Copy Constructor. More...
virtual	~Epetra_Object ()
	Epetra_Object Destructor. More...
virtual void	SetLabel (const char *const Label)
	Epetra_Object Label definition using char *. More...
virtual const char *	Label () const
	Epetra_Object Label access funtion. More...
virtual int	ReportError (const std::string Message, int ErrorCode) const
	Error reporting method. More...
Public Member Functions inherited from Epetra_Distributor
virtual	~Epetra_Distributor ()
	Epetra_Distributor Destructor. More...

Private Attributes
int	nrecvs_
int	nsends_

Constructor/Destructor
	Epetra_SerialDistributor (const Epetra_SerialComm &Comm)
	Constructor. More...
	Epetra_SerialDistributor (const Epetra_SerialDistributor &Plan)
	Epetra_SerialDistributor Copy Constructor. More...
Epetra_Distributor *	Clone ()
	Clone method. More...
Epetra_Distributor *	ReverseClone ()
	Create and extract the reverse version of the distributor. More...
virtual	~Epetra_SerialDistributor ()
	Epetra_Comm Destructor. More...

Additional Inherited Members
Static Public Member Functions inherited from Epetra_Object
static void	SetTracebackMode (int TracebackModeValue)
	Set the value of the Epetra_Object error traceback report mode. More...
static int	GetTracebackMode ()
	Get the value of the Epetra_Object error report mode. More...
static std::ostream &	GetTracebackStream ()
	Get the output stream for error reporting. More...
Static Public Attributes inherited from Epetra_Object
static int	TracebackMode
Protected Member Functions inherited from Epetra_Object
std::string	toString (const int &x) const
std::string	toString (const long long &x) const
std::string	toString (const double &x) const

Detailed Description

Epetra_SerialDistributor: The Epetra Serial implementation of the Epetra_Distributor Gather/Scatter Setup Class.

The Epetra_SerialDistributor class is an Serial implement of Epetra_Distributor that is essentially a trivial class since a serial machine is a trivial parallel machine. An Epetra_SerialDistributor object is actually produced by calling a method in the Epetra_SerialComm class.

Definition at line 58 of file Epetra_SerialDistributor.h.

Constructor & Destructor Documentation

Epetra_SerialDistributor::Epetra_SerialDistributor

(

const Epetra_SerialComm &

Comm

)

Constructor.

Definition at line 49 of file Epetra_SerialDistributor.cpp.

Epetra_SerialDistributor::Epetra_SerialDistributor

(

const Epetra_SerialDistributor &

Plan

)

Epetra_SerialDistributor Copy Constructor.

Definition at line 58 of file Epetra_SerialDistributor.cpp.

Epetra_SerialDistributor::~Epetra_SerialDistributor ( )

virtual

Epetra_Comm Destructor.

Definition at line 67 of file Epetra_SerialDistributor.cpp.

Member Function Documentation

Epetra_Distributor* Epetra_SerialDistributor::Clone ( )

inlinevirtual

Clone method.

Implements Epetra_Distributor.

Definition at line 72 of file Epetra_SerialDistributor.h.

Epetra_Distributor* Epetra_SerialDistributor::ReverseClone ( )

inlinevirtual

Create and extract the reverse version of the distributor.

This is not implemented for SeriaDistributor.

Implements Epetra_Distributor.

Definition at line 77 of file Epetra_SerialDistributor.h.

int Epetra_SerialDistributor::CreateFromSends ( const int &  NumExportIDs, const int *  ExportPIDs, bool  Deterministic, int &  NumRemoteIDs  )

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.

Implements Epetra_Distributor.

Definition at line 76 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::CreateFromRecvs ( const int &  NumRemoteIDs, const int *  RemoteGIDs, const int *  RemotePIDs, bool  Deterministic, int &  NumExportIDs, int *&  ExportGIDs, int *&  ExportPIDs  )

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.

Implements Epetra_Distributor.

Definition at line 107 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::CreateFromRecvs ( const int &  NumRemoteIDs, const long long *  RemoteGIDs, const int *  RemotePIDs, bool  Deterministic, int &  NumExportIDs, long long *&  ExportGIDs, int *&  ExportPIDs  )

virtual

Implements Epetra_Distributor.

Definition at line 132 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::Do ( char *  export_objs, int  obj_size, int &  len_import_objs, char *&  import_objs  )

virtual

Execute plan on buffer of export objects in a single step.

Implements Epetra_Distributor.

Definition at line 154 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::DoReverse ( char *  export_objs, int  obj_size, int &  len_import_objs, char *&  import_objs  )

virtual

Execute reverse of plan on buffer of export objects in a single step.

Implements Epetra_Distributor.

Definition at line 171 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::DoPosts ( char *  export_objs, int  obj_size, int &  len_import_objs, char *&  import_objs  )

virtual

Post buffer of export objects (can do other local work before executing Waits)

Implements Epetra_Distributor.

Definition at line 187 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::DoWaits ( )

virtual

Wait on a set of posts.

Implements Epetra_Distributor.

Definition at line 203 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::DoReversePosts ( char *  export_objs, int  obj_size, int &  len_import_objs, char *&  import_objs  )

virtual

Do reverse post of buffer of export objects (can do other local work before executing Waits)

Implements Epetra_Distributor.

Definition at line 213 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::DoReverseWaits ( )

virtual

Wait on a reverse set of posts.

Implements Epetra_Distributor.

Definition at line 230 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::Do ( char *  export_objs, int  obj_size, int *&  sizes, int &  len_import_objs, char *&  import_objs  )

virtual

Execute plan on buffer of export objects in a single step (object size may vary)

Implements Epetra_Distributor.

Definition at line 238 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::DoReverse ( char *  export_objs, int  obj_size, int *&  sizes, int &  len_import_objs, char *&  import_objs  )

virtual

Execute reverse of plan on buffer of export objects in a single step (object size may vary)

Implements Epetra_Distributor.

Definition at line 255 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::DoPosts ( char *  export_objs, int  obj_size, int *&  sizes, int &  len_import_objs, char *&  import_objs  )

virtual

Post buffer of export objects (can do other local work before executing Waits)

Implements Epetra_Distributor.

Definition at line 273 of file Epetra_SerialDistributor.cpp.

int Epetra_SerialDistributor::DoReversePosts ( char *  export_objs, int  obj_size, int *&  sizes, int &  len_import_objs, char *&  import_objs  )

virtual

Do reverse post of buffer of export objects (can do other local work before executing Waits)

Implements Epetra_Distributor.

Definition at line 292 of file Epetra_SerialDistributor.cpp.

void Epetra_SerialDistributor::Print ( std::ostream &  os ) const

virtual

Implements Epetra_Distributor.

Definition at line 308 of file Epetra_SerialDistributor.cpp.

Member Data Documentation

int Epetra_SerialDistributor::nrecvs_

private

Definition at line 156 of file Epetra_SerialDistributor.h.

int Epetra_SerialDistributor::nsends_

private

Definition at line 157 of file Epetra_SerialDistributor.h.

---

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

• Epetra_SerialDistributor.h
• Epetra_SerialDistributor.cpp