Epetra_MpiComm: The Epetra MPI Communication Class. More...

#include <Epetra_MpiComm.h>

Inheritance diagram for Epetra_MpiComm:

Collaboration diagram for Epetra_MpiComm:

Public Member Functions
Epetra_MpiComm &	operator= (const Epetra_MpiComm &Comm)
	Assignment Operator.

Constructor/Destructor Methods
	Epetra_MpiComm (MPI_Comm comm)
	Epetra_MpiComm MPI Constructor. More...

	Epetra_MpiComm (const Epetra_MpiComm &Comm)
	Epetra_MpiComm Copy Constructor. More...

Epetra_Comm *	Clone () const
	Clone method.

virtual	~Epetra_MpiComm ()
	Epetra_MpiComm Destructor. More...

Barrier Methods
void	Barrier () const
	Epetra_MpiComm Barrier function. More...

Broadcast Methods
int	Broadcast (double *MyVals, int Count, int Root) const
	Epetra_MpiComm Broadcast function. More...

int	Broadcast (int *MyVals, int Count, int Root) const
	Epetra_MpiComm Broadcast function. More...

int	Broadcast (long *MyVals, int Count, int Root) const
	Epetra_MpiComm Broadcast function. More...

int	Broadcast (long long *MyVals, int Count, int Root) const
	Epetra_MpiComm Broadcast function. More...

int	Broadcast (char *MyVals, int Count, int Root) const
	Epetra_MpiComm Broadcast function. More...

Gather Methods
int	GatherAll (double MyVals, double AllVals, int Count) const
	Epetra_MpiComm All Gather function. More...

int	GatherAll (int MyVals, int AllVals, int Count) const
	Epetra_MpiComm All Gather function. More...

int	GatherAll (long MyVals, long AllVals, int Count) const
	Epetra_MpiComm All Gather function. More...

int	GatherAll (long long MyVals, long long AllVals, int Count) const
	Epetra_MpiComm All Gather function. More...

Sum Methods
int	SumAll (double PartialSums, double GlobalSums, int Count) const
	Epetra_MpiComm Global Sum function. More...

int	SumAll (int PartialSums, int GlobalSums, int Count) const
	Epetra_MpiComm Global Sum function. More...

int	SumAll (long PartialSums, long GlobalSums, int Count) const
	Epetra_MpiComm Global Sum function. More...

int	SumAll (long long PartialSums, long long GlobalSums, int Count) const
	Epetra_MpiComm Global Sum function. More...

Max/Min Methods
int	MaxAll (double PartialMaxs, double GlobalMaxs, int Count) const
	Epetra_MpiComm Global Max function. More...

int	MaxAll (int PartialMaxs, int GlobalMaxs, int Count) const
	Epetra_MpiComm Global Max function. More...

int	MaxAll (long PartialMaxs, long GlobalMaxs, int Count) const
	Epetra_MpiComm Global Max function. More...

int	MaxAll (long long PartialMaxs, long long GlobalMaxs, int Count) const
	Epetra_MpiComm Global Max function. More...

int	MinAll (double PartialMins, double GlobalMins, int Count) const
	Epetra_MpiComm Global Min function. More...

int	MinAll (int PartialMins, int GlobalMins, int Count) const
	Epetra_MpiComm Global Min function. More...

int	MinAll (long PartialMins, long GlobalMins, int Count) const
	Epetra_MpiComm Global Min function. More...

int	MinAll (long long PartialMins, long long GlobalMins, int Count) const
	Epetra_MpiComm Global Min function. More...

Parallel Prefix Methods
int	ScanSum (double MyVals, double ScanSums, int Count) const
	Epetra_MpiComm Scan Sum function. More...

int	ScanSum (int MyVals, int ScanSums, int Count) const
	Epetra_MpiComm Scan Sum function. More...

int	ScanSum (long MyVals, long ScanSums, int Count) const
	Epetra_MpiComm Scan Sum function. More...

int	ScanSum (long long MyVals, long long ScanSums, int Count) const
	Epetra_MpiComm Scan Sum function. More...

Attribute Accessor Methods
MPI_Comm	Comm () const
	Extract MPI Communicator from a Epetra_MpiComm object.

int	MyPID () const
	Return my process ID. More...

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

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 (std::ostream &os) const
	Print method that implements Epetra_Object virtual Print method.

void	PrintInfo (std::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. More...

const Epetra_MpiCommData *	DataPtr () const
	Returns a pointer to the MpiCommData instance this MpiComm uses. More...

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 int	ReportError (const std::string Message, int ErrorCode) const
	Error reporting method.

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

Public Member Functions inherited from Epetra_Comm
virtual	~Epetra_Comm ()
	Epetra_Comm Destructor.

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.

static std::ostream &	GetTracebackStream ()
	Get the output stream for error reporting.

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_MpiComm: The Epetra MPI Communication Class.

The Epetra_MpiComm 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.

Constructor & Destructor Documentation

Epetra_MpiComm::Epetra_MpiComm ( MPI_Comm comm )

Epetra_MpiComm MPI Constructor.

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

Epetra_MpiComm::Epetra_MpiComm ( const Epetra_MpiComm & Comm )

Epetra_MpiComm Copy Constructor.

Makes an exact copy of an existing Epetra_MpiComm instance.

virtual Epetra_MpiComm::~Epetra_MpiComm ( )

virtual

Epetra_MpiComm Destructor.

Completely deletes a Epetra_MpiComm object.

Warning: Note: All objects that depend on a Epetra_MpiComm instance should be destroyed prior to calling this function.

Member Function Documentation

void Epetra_MpiComm::Barrier ( ) const

virtual

Epetra_MpiComm Barrier function.

Causes each processor in the communicator to wait until all processors have arrived.

Implements Epetra_Comm.

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

virtual

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

int Epetra_MpiComm::Broadcast	(	int *	MyVals,
		int	Count,
		int	Root
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::Broadcast	(	long *	MyVals,
		int	Count,
		int	Root
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::Broadcast	(	long long *	MyVals,
		int	Count,
		int	Root
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::Broadcast	(	char *	MyVals,
		int	Count,
		int	Root
	)		const

virtual

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

const Epetra_MpiCommData* Epetra_MpiComm::DataPtr ( ) const

inline

Returns a pointer to the MpiCommData instance this MpiComm uses.

(Intended for developer use only for testing purposes.)

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

virtual

Epetra_MpiComm 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 Epetra_MpiComm::GatherAll	(	int *	MyVals,
		int *	AllVals,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::GatherAll	(	long *	MyVals,
		long *	AllVals,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::GatherAll	(	long long *	MyVals,
		long long *	AllVals,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::MaxAll	(	double *	PartialMaxs,
		double *	GlobalMaxs,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::MaxAll	(	int *	PartialMaxs,
		int *	GlobalMaxs,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::MaxAll	(	long *	PartialMaxs,
		long *	GlobalMaxs,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::MaxAll	(	long long *	PartialMaxs,
		long long *	GlobalMaxs,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::MinAll	(	double *	PartialMins,
		double *	GlobalMins,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::MinAll	(	int *	PartialMins,
		int *	GlobalMins,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::MinAll	(	long *	PartialMins,
		long *	GlobalMins,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::MinAll	(	long long *	PartialMins,
		long long *	GlobalMins,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::MyPID ( ) const

inlinevirtual

Return my process ID.

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

Implements Epetra_Comm.

int Epetra_MpiComm::NumProc ( ) const

inlinevirtual

Returns total number of processes.

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

Implements Epetra_Comm.

int Epetra_MpiComm::ReferenceCount ( ) const

inline

Returns the reference count of MpiCommData.

(Intended for testing purposes.)

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

virtual

Epetra_MpiComm 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 Epetra_MpiComm::ScanSum	(	int *	MyVals,
		int *	ScanSums,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::ScanSum	(	long *	MyVals,
		long *	ScanSums,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::ScanSum	(	long long *	MyVals,
		long long *	ScanSums,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::SumAll	(	double *	PartialSums,
		double *	GlobalSums,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::SumAll	(	int *	PartialSums,
		int *	GlobalSums,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::SumAll	(	long *	PartialSums,
		long *	GlobalSums,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 Epetra_MpiComm::SumAll	(	long long *	PartialSums,
		long long *	GlobalSums,
		int	Count
	)		const

virtual

Epetra_MpiComm 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 file:

Epetra_MpiComm.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation