Epetra_Comm: The Epetra Communication Abstract Base Class. More...

#include <Epetra_Comm.h>

Inheritance diagram for Epetra_Comm:

Constructor / Destructor
virtual Epetra_Comm *	Clone () const =0
	Epetra_Comm clone constructor. More...

virtual	~Epetra_Comm ()
	Epetra_Comm Destructor. More...

Barrier Methods
virtual void	Barrier () const =0
	Epetra_Comm Barrier function. More...

Broadcast Methods
virtual int	Broadcast (double *MyVals, int Count, int Root) const =0
	Epetra_Comm Broadcast function. More...

virtual int	Broadcast (int *MyVals, int Count, int Root) const =0
	Epetra_Comm Broadcast function. More...

virtual int	Broadcast (long *MyVals, int Count, int Root) const =0
	Epetra_Comm Broadcast function. More...

virtual int	Broadcast (long long *MyVals, int Count, int Root) const =0
	Epetra_Comm Broadcast function. More...

virtual int	Broadcast (char *MyVals, int Count, int Root) const =0
	Epetra_Comm Broadcast function. More...

Gather Methods
virtual int	GatherAll (double MyVals, double AllVals, int Count) const =0
	Epetra_Comm All Gather function. More...

virtual int	GatherAll (int MyVals, int AllVals, int Count) const =0
	Epetra_Comm All Gather function. More...

virtual int	GatherAll (long MyVals, long AllVals, int Count) const =0
	Epetra_Comm All Gather function. More...

virtual int	GatherAll (long long MyVals, long long AllVals, int Count) const =0
	Epetra_Comm All Gather function. More...

Sum Methods
virtual int	SumAll (double PartialSums, double GlobalSums, int Count) const =0
	Epetra_Comm Global Sum function. More...

virtual int	SumAll (int PartialSums, int GlobalSums, int Count) const =0
	Epetra_Comm Global Sum function. More...

virtual int	SumAll (long PartialSums, long GlobalSums, int Count) const =0
	Epetra_Comm Global Sum function. More...

virtual int	SumAll (long long PartialSums, long long GlobalSums, int Count) const =0
	Epetra_Comm Global Sum function. More...

Max/Min Methods
virtual int	MaxAll (double PartialMaxs, double GlobalMaxs, int Count) const =0
	Epetra_Comm Global Max function. More...

virtual int	MaxAll (int PartialMaxs, int GlobalMaxs, int Count) const =0
	Epetra_Comm Global Max function. More...

virtual int	MaxAll (long PartialMaxs, long GlobalMaxs, int Count) const =0
	Epetra_Comm Global Max function. More...

virtual int	MaxAll (long long PartialMaxs, long long GlobalMaxs, int Count) const =0
	Epetra_Comm Global Max function. More...

virtual int	MinAll (double PartialMins, double GlobalMins, int Count) const =0
	Epetra_Comm Global Min function. More...

virtual int	MinAll (int PartialMins, int GlobalMins, int Count) const =0
	Epetra_Comm Global Min function. More...

virtual int	MinAll (long PartialMins, long GlobalMins, int Count) const =0
	Epetra_Comm Global Min function. More...

virtual int	MinAll (long long PartialMins, long long GlobalMins, int Count) const =0

Parallel Prefix Methods
virtual int	ScanSum (double MyVals, double ScanSums, int Count) const =0
	Epetra_Comm Scan Sum function. More...

virtual int	ScanSum (int MyVals, int ScanSums, int Count) const =0
	Epetra_Comm Scan Sum function. More...

virtual int	ScanSum (long MyVals, long ScanSums, int Count) const =0
	Epetra_Comm Scan Sum function. More...

virtual int	ScanSum (long long MyVals, long long ScanSums, int Count) const =0
	Epetra_Comm Scan Sum function. More...

Attribute Accessor Methods
virtual int	MyPID () const =0
	Return my process ID. More...

virtual int	NumProc () const =0
	Returns total number of processes. More...

Gather/Scatter and Directory Constructors
virtual Epetra_Distributor *	CreateDistributor () const =0
	Create a distributor object. More...

virtual Epetra_Directory *	CreateDirectory (const Epetra_BlockMap &Map) const =0
	Create a directory object for the given Epetra_BlockMap. More...

I/O methods
virtual void	PrintInfo (std::ostream &os) const =0
	Print object to an output stream. More...

Detailed Description

Epetra_Comm: The Epetra Communication Abstract Base Class.

The Epetra_Comm class is an interface that encapsulates the general information and services needed for other Epetra classes to run on a parallel computer. An Epetra_Comm object is required for building all Epetra Map objects, which in turn are required for all other Epetra classes.

Epetra_Comm has default implementations, via Epetra_SerialComm and Epetra_MpiComm, 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. Most Epetra_Comm interfaces are similar to MPI interfaces, except that the type of data is not required as an argument since C++ can bind to the appropriate interface based on argument typing.

Any implementation of the Epetra_Comm interface is also responsible for generating an Epetra_Distributor and Epetra_Directory object.

Definition at line 73 of file Epetra_Comm.h.

Constructor & Destructor Documentation

virtual Epetra_Comm::~Epetra_Comm ( )

inlinevirtual

Epetra_Comm Destructor.

Definition at line 85 of file Epetra_Comm.h.

Member Function Documentation

virtual Epetra_Comm* Epetra_Comm::Clone ( ) const

pure virtual

Epetra_Comm clone constructor.

The clone function will return a new heap-allocated Comm instance. It is the responsibility of the caller to ensure that this new instance is properly destroyed.

Implemented in Epetra_MpiComm, Epetra_MpiSmpComm, and Epetra_SerialComm.

virtual void Epetra_Comm::Barrier ( ) const

pure virtual

Epetra_Comm Barrier function.

Each processor must wait at the point the barrier is called until all processors have arrived.

Implemented in Epetra_MpiComm, Epetra_MpiSmpComm, and Epetra_SerialComm.

virtual int Epetra_Comm::Broadcast	(	double *	MyVals,
		int	Count,
		int	Root
	)		const

pure virtual

Epetra_Comm Broadcast function.

Take list of input values from the root processor and sends to all other processors.

Parameters

MyVals	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.

Implemented in Epetra_MpiComm, Epetra_MpiSmpComm, and Epetra_SerialComm.

virtual int Epetra_Comm::Broadcast	(	int *	MyVals,
		int	Count,
		int	Root
	)		const

pure virtual

Epetra_Comm Broadcast function.

Take list of input values from the root processor and sends to all other processors.

Parameters

MyVals	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.

Implemented in Epetra_MpiComm, Epetra_MpiSmpComm, and Epetra_SerialComm.

virtual int Epetra_Comm::Broadcast	(	long *	MyVals,
		int	Count,
		int	Root
	)		const

pure virtual

Epetra_Comm Broadcast function.

Take list of input values from the root processor and sends to all other processors.

Parameters

MyVals	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.

Implemented in Epetra_MpiComm, Epetra_MpiSmpComm, and Epetra_SerialComm.

virtual int Epetra_Comm::Broadcast	(	long long *	MyVals,
		int	Count,
		int	Root
	)		const

pure virtual

Epetra_Comm Broadcast function.

Take list of input values from the root processor and sends to all other processors.

Parameters

MyVals	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.

Implemented in Epetra_MpiComm, and Epetra_SerialComm.

virtual int Epetra_Comm::Broadcast	(	char *	MyVals,
		int	Count,
		int	Root
	)		const

pure virtual

Epetra_Comm Broadcast function.

Take list of input values from the root processor and sends to all other processors.

Parameters

MyVals	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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::GatherAll	(	double *	MyVals,
		double *	AllVals,
		int	Count
	)		const

pure virtual

Epetra_Comm 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 be of size NumProc*Count.
Count	In On entry, contains the length of the list of MyVals.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::GatherAll	(	int *	MyVals,
		int *	AllVals,
		int	Count
	)		const

pure virtual

Epetra_Comm 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 be of size NumProc*Count.
Count	In On entry, contains the length of the list of MyVals.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::GatherAll	(	long *	MyVals,
		long *	AllVals,
		int	Count
	)		const

pure virtual

Epetra_Comm 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 be of size NumProc*Count.
Count	In On entry, contains the length of the list of MyVals.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::GatherAll	(	long long *	MyVals,
		long long *	AllVals,
		int	Count
	)		const

pure virtual

Epetra_Comm 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 be of size NumProc*Count.
Count	In On entry, contains the length of the list of MyVals.

Implemented in Epetra_MpiComm, and Epetra_SerialComm.

virtual int Epetra_Comm::SumAll	(	double *	PartialSums,
		double *	GlobalSums,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::SumAll	(	int *	PartialSums,
		int *	GlobalSums,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::SumAll	(	long *	PartialSums,
		long *	GlobalSums,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::SumAll	(	long long *	PartialSums,
		long long *	GlobalSums,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, and Epetra_SerialComm.

virtual int Epetra_Comm::MaxAll	(	double *	PartialMaxs,
		double *	GlobalMaxs,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::MaxAll	(	int *	PartialMaxs,
		int *	GlobalMaxs,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::MaxAll	(	long *	PartialMaxs,
		long *	GlobalMaxs,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::MaxAll	(	long long *	PartialMaxs,
		long long *	GlobalMaxs,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, and Epetra_SerialComm.

virtual int Epetra_Comm::MinAll	(	double *	PartialMins,
		double *	GlobalMins,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::MinAll	(	int *	PartialMins,
		int *	GlobalMins,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::MinAll	(	long *	PartialMins,
		long *	GlobalMins,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::MinAll	(	long long *	PartialMins,
		long long *	GlobalMins,
		int	Count
	)		const

pure virtual

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.

Implemented in Epetra_MpiComm, and Epetra_SerialComm.

virtual int Epetra_Comm::ScanSum	(	double *	MyVals,
		double *	ScanSums,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::ScanSum	(	int *	MyVals,
		int *	ScanSums,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::ScanSum	(	long *	MyVals,
		long *	ScanSums,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::ScanSum	(	long long *	MyVals,
		long long *	ScanSums,
		int	Count
	)		const

pure virtual

Epetra_Comm 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.

Implemented in Epetra_MpiComm, and Epetra_SerialComm.

virtual int Epetra_Comm::MyPID ( ) const

pure virtual

Return my process ID.

In MPI mode returns the rank of the calling process. In serial mode returns 0.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual int Epetra_Comm::NumProc ( ) const

pure virtual

Returns total number of processes.

In MPI mode returns the size of the MPI communicator. In serial mode returns 1.

Implemented in Epetra_MpiComm, Epetra_SerialComm, and Epetra_MpiSmpComm.

virtual Epetra_Distributor* Epetra_Comm::CreateDistributor ( ) const