EpetraExt::ZoltanMpiComm Class Reference

EpetraExt::ZoltanMpiComm: The Epetra MPI Communication Class. More...

#include <EpetraExt_ZoltanMpiComm.h>

Inheritance diagram for EpetraExt::ZoltanMpiComm:

[legend]Collaboration diagram for EpetraExt::ZoltanMpiComm:[legend]List of all members.

Public Member Functions
ZoltanMpiComm &	operator= (const ZoltanMpiComm &Comm)
	Assignment Operator.
Constructor/Destructor Methods
	ZoltanMpiComm (MPI_Comm comm)
	ZoltanMpiComm MPI Constructor.
	ZoltanMpiComm (const ZoltanMpiComm &Comm)
	ZoltanMpiComm Copy Constructor.
Epetra_Comm *	Clone () const
	Clone method.
virtual	~ZoltanMpiComm ()
	ZoltanMpiComm Destructor.
Barrier Methods
void	Barrier () const
	ZoltanMpiComm Barrier function.
Broadcast Methods
int	Broadcast (double *MyVals, int Count, int Root) const
	ZoltanMpiComm Broadcast function.
int	Broadcast (int *MyVals, int Count, int Root) const
	ZoltanMpiComm Broadcast function.
Gather Methods
int	GatherAll (double *MyVals, double *AllVals, int Count) const
	ZoltanMpiComm All Gather function.
int	GatherAll (int *MyVals, int *AllVals, int Count) const
	ZoltanMpiComm All Gather function.
Sum Methods
int	SumAll (double *PartialSums, double *GlobalSums, int Count) const
	ZoltanMpiComm Global Sum function.
int	SumAll (int *PartialSums, int *GlobalSums, int Count) const
	ZoltanMpiComm Global Sum function.
Max/Min Methods
int	MaxAll (double *PartialMaxs, double *GlobalMaxs, int Count) const
	ZoltanMpiComm Global Max function.
int	MaxAll (int *PartialMaxs, int *GlobalMaxs, int Count) const
	ZoltanMpiComm Global Max function.
int	MinAll (double *PartialMins, double *GlobalMins, int Count) const
	ZoltanMpiComm Global Min function.
int	MinAll (int *PartialMins, int *GlobalMins, int Count) const
	ZoltanMpiComm Global Min function.
Parallel Prefix Methods
int	ScanSum (double *MyVals, double *ScanSums, int Count) const
	ZoltanMpiComm Scan Sum function.
int	ScanSum (int *MyVals, int *ScanSums, int Count) const
	ZoltanMpiComm Scan Sum function.
Attribute Accessor Methods
MPI_Comm	Comm () const
	Extract MPI Communicator from a Epetra_MpiComm object.
int	MyPID () const
	Return my process ID.
int	NumProc () const
	Returns total number of processes.
Gather/Scatter and Directory Constructors
Epetra_Distributor *	CreateDistributor () const
	Create a distributor object.
Epetra_Directory *	CreateDirectory (const Epetra_BlockMap &Map) const
	Create a directory object for the given Epetra_BlockMap.
MPI-specific Methods
int	GetMpiTag () const
	Acquire an MPI tag from the Epetra range of 24050-24099, increment tag.
MPI_Comm	GetMpiComm () const
	Get the MPI Communicator (identical to Comm() method; used when we know we are MPI.
Print object to an output stream
void	Print (ostream &os) const
	Print method that implements Epetra_Object virtual Print method.
void	PrintInfo (ostream &os) const
	Print method that implements Epetra_Comm virtual PrintInfo method.
Expert Users and Developers Only
int	ReferenceCount () const
	Returns the reference count of MpiCommData.
const ZoltanMpiCommData *	DataPtr () const
	Returns a pointer to the MpiCommData instance this MpiComm uses.

---

Detailed Description

EpetraExt::ZoltanMpiComm: The Epetra MPI Communication Class.

The ZoltanMpiComm class is an implementation of Epetra_Comm that encapsulates the general information and services needed for other Epetra classes to run on a parallel computer using MPI and using Zoltan comm library.

---

Constructor & Destructor Documentation

EpetraExt::ZoltanMpiComm::ZoltanMpiComm (  MPI_Comm  comm  )

ZoltanMpiComm MPI Constructor. Creates a ZoltanMpiComm instance for use with MPI. If no specialized MPI communicator is needed, this constuctor can be called with the argument MPI_COMM_WORLD.

EpetraExt::ZoltanMpiComm::ZoltanMpiComm (  const ZoltanMpiComm &  Comm  )

ZoltanMpiComm Copy Constructor. Makes an exact copy of an existing ZoltanMpiComm instance.

EpetraExt::ZoltanMpiComm::~ZoltanMpiComm (   )  [virtual]

ZoltanMpiComm Destructor. Completely deletes a ZoltanMpiComm object. Warning: Note: All objects that depend on a ZoltanMpiComm instance should be destroyed prior to calling this function.

---

Member Function Documentation

void EpetraExt::ZoltanMpiComm::Barrier (   )  const [virtual]

ZoltanMpiComm Barrier function. Causes each processor in the communicator to wait until all processors have arrived. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::Broadcast (  int *  MyVals, int  Count, int  Root )  const [virtual]

ZoltanMpiComm Broadcast function. Take list of input values from the root processor and sends to all other processors. Parameters: Values  InOut On entry, the root processor contains the list of values. On exit, all processors will have the same list of values. Note that values must be allocated on all processor before the broadcast. Count  In On entry, contains the length of the list of Values. Root  In On entry, contains the processor from which all processors will receive a copy of Values. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::Broadcast (  double *  MyVals, int  Count, int  Root )  const [virtual]

ZoltanMpiComm Broadcast function. Takes list of input values from the root processor and sends to all other processors. Parameters: Values  InOut On entry, the root processor contains the list of values. On exit, all processors will have the same list of values. Note that values must be allocated on all processor before the broadcast. Count  In On entry, contains the length of the list of Values. Root  In On entry, contains the processor from which all processors will receive a copy of Values. Implements Epetra_Comm.

const ZoltanMpiCommData* EpetraExt::ZoltanMpiComm::DataPtr (   )  const [inline]

Returns a pointer to the MpiCommData instance this MpiComm uses. (Intended for developer use only for testing purposes.)

int EpetraExt::ZoltanMpiComm::GatherAll (  int *  MyVals, int *  AllVals, int  Count )  const [virtual]

ZoltanMpiComm All Gather function. Take list of input values from all processors in the communicator and creates an ordered contiguous list of those values on each processor. Parameters: MyVals  In On entry, contains the list of values, to be sent to all processors. AllVals  Out On exit, contains the list of values from all processors. Must by of size NumProc*Count. Count  In On entry, contains the length of the list of MyVals. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::GatherAll (  double *  MyVals, double *  AllVals, int  Count )  const [virtual]

ZoltanMpiComm All Gather function. Take list of input values from all processors in the communicator and creates an ordered contiguous list of those values on each processor. Parameters: MyVals  In On entry, contains the list of values, to be sent to all processors. AllVals  Out On exit, contains the list of values from all processors. Must by of size NumProc*Count. Count  In On entry, contains the length of the list of MyVals. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::MaxAll (  int *  PartialMaxs, int *  GlobalMaxs, int  Count )  const [virtual]

ZoltanMpiComm Global Max function. Take list of input values from all processors in the communicator, computes the max and returns the max to all processors. Parameters: PartialMaxs  In On entry, contains the list of values, usually partial maxs computed locally; using these Partial Maxs, the max across all processors will be computed. GlobalMaxs  Out On exit, contains the list of maxs computed across all processors. Count  In On entry, contains the length of the list of values. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::MaxAll (  double *  PartialMaxs, double *  GlobalMaxs, int  Count )  const [virtual]

ZoltanMpiComm Global Max function. Take list of input values from all processors in the communicator, computes the max and returns the max to all processors. Parameters: PartialMaxs  In On entry, contains the list of values, usually partial maxs computed locally; using these Partial Maxs, the max across all processors will be computed. GlobalMaxs  Out On exit, contains the list of maxs computed across all processors. Count  In On entry, contains the length of the list of values. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::MinAll (  int *  PartialMins, int *  GlobalMins, int  Count )  const [virtual]

ZoltanMpiComm Global Min function. Take list of input values from all processors in the communicator, computes the min and returns the min to all processors. Parameters: PartialMins  In On entry, contains the list of values, usually partial mins computed locally; using these Partial Mins, the min across all processors will be computed. GlobalMins  Out On exit, contains the list of mins computed across all processors. Count  In On entry, contains the length of the list of values. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::MinAll (  double *  PartialMins, double *  GlobalMins, int  Count )  const [virtual]

ZoltanMpiComm Global Min function. Take list of input values from all processors in the communicator, computes the min and returns the min to all processors. Parameters: PartialMins  In On entry, contains the list of values, usually partial mins computed locally; using these Partial Mins, the min across all processors will be computed. GlobalMins  Out On exit, contains the list of mins computed across all processors. Count  In On entry, contains the length of the list of values. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::MyPID (   )  const [inline, virtual]

Return my process ID. In MPI mode returns the rank of the calling process. In serial mode returns 0. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::NumProc (   )  const [inline, virtual]

Returns total number of processes. In MPI mode returns the size of the MPI communicator. In serial mode returns 1. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::ReferenceCount (   )  const [inline]

Returns the reference count of MpiCommData. (Intended for testing purposes.)

int EpetraExt::ZoltanMpiComm::ScanSum (  int *  MyVals, int *  ScanSums, int  Count )  const [virtual]

ZoltanMpiComm Scan Sum function. Take list of input values from all processors in the communicator, computes the scan sum and returns it to all processors such that processor i contains the sum of values from processor 0 up to and including processor i. Parameters: MyVals  In On entry, contains the list of values to be summed across all processors. ScanSums  Out On exit, contains the list of values summed across processors 0 through i. Count  In On entry, contains the length of the list of values. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::ScanSum (  double *  MyVals, double *  ScanSums, int  Count )  const [virtual]

ZoltanMpiComm Scan Sum function. Take list of input values from all processors in the communicator, computes the scan sum and returns it to all processors such that processor i contains the sum of values from processor 0 up to and including processor i. Parameters: MyVals  In On entry, contains the list of values to be summed across all processors. ScanSums  Out On exit, contains the list of values summed across processors 0 through i. Count  In On entry, contains the length of the list of values. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::SumAll (  int *  PartialSums, int *  GlobalSums, int  Count )  const [virtual]

ZoltanMpiComm Global Sum function. Take list of input values from all processors in the communicator, computes the sum and returns the sum to all processors. Parameters: PartialSums  In On entry, contains the list of values, usually partial sums computed locally, to be summed across all processors. GlobalSums  Out On exit, contains the list of values summed across all processors. Count  In On entry, contains the length of the list of values. Implements Epetra_Comm.

int EpetraExt::ZoltanMpiComm::SumAll (  double *  PartialSums, double *  GlobalSums, int  Count )  const [virtual]

ZoltanMpiComm Global Sum function. Take list of input values from all processors in the communicator, computes the sum and returns the sum to all processors. Parameters: PartialSums  In On entry, contains the list of values, usually partial sums computed locally, to be summed across all processors. GlobalSums  Out On exit, contains the list of values summed across all processors. Count  In On entry, contains the length of the list of values. Implements Epetra_Comm.

---

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

• EpetraExt_ZoltanMpiComm.h
• EpetraExt_ZoltanMpiComm.cpp

---