Epetra Package Browser (Single Doxygen Collection) Development
Public Member Functions | Private Member Functions | Private Attributes
Epetra_MpiSmpComm Class Reference

Epetra_MpiSmpComm: The Epetra MPI Shared Memory Parallel Communication Class. More...

#include <Epetra_MpiSmpComm.h>

Inheritance diagram for Epetra_MpiSmpComm:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Epetra_MpiSmpCommoperator= (const Epetra_MpiSmpComm &Comm)
 Assignment Operator.

Private Member Functions

void CleanupData ()

Private Attributes

Epetra_MpiSmpCommDataMpiSmpCommData_

Constructor/Destructor Methods

 Epetra_MpiSmpComm (MPI_Comm comm)
 Epetra_MpiSmpComm MPI Constructor.
 Epetra_MpiSmpComm (const Epetra_MpiSmpComm &Comm)
 Epetra_MpiSmpComm Copy Constructor.
Epetra_CommClone () const
 Clone method.
virtual ~Epetra_MpiSmpComm ()
 Epetra_MpiSmpComm Destructor.

Barrier Methods

void Barrier () const
 Epetra_MpiSmpComm Barrier function.

Broadcast Methods

int Broadcast (double *MyVals, int Count, int Root) const
 Epetra_MpiSmpComm Broadcast function.
int Broadcast (int *MyVals, int Count, int Root) const
 Epetra_MpiSmpComm Broadcast function.
int Broadcast (long *MyVals, int Count, int Root) const
 Epetra_MpiSmpComm Broadcast function.
int Broadcast (char *MyVals, int Count, int Root) const
 Epetra_MpiSmpComm Broadcast function.

Gather Methods

int GatherAll (double *MyVals, double *AllVals, int Count) const
 Epetra_MpiSmpComm All Gather function.
int GatherAll (int *MyVals, int *AllVals, int Count) const
 Epetra_MpiSmpComm All Gather function.
int GatherAll (long *MyVals, long *AllVals, int Count) const
 Epetra_MpiSmpComm All Gather function.

Sum Methods

int SumAll (double *PartialSums, double *GlobalSums, int Count) const
 Epetra_MpiSmpComm Global Sum function.
int SumAll (int *PartialSums, int *GlobalSums, int Count) const
 Epetra_MpiSmpComm Global Sum function.
int SumAll (long *PartialSums, long *GlobalSums, int Count) const
 Epetra_MpiSmpComm Global Sum function.

Max/Min Methods

int MaxAll (double *PartialMaxs, double *GlobalMaxs, int Count) const
 Epetra_MpiSmpComm Global Max function.
int MaxAll (int *PartialMaxs, int *GlobalMaxs, int Count) const
 Epetra_MpiSmpComm Global Max function.
int MaxAll (long *PartialMaxs, long *GlobalMaxs, int Count) const
 Epetra_MpiSmpComm Global Max function.
int MinAll (double *PartialMins, double *GlobalMins, int Count) const
 Epetra_MpiSmpComm Global Min function.
int MinAll (int *PartialMins, int *GlobalMins, int Count) const
 Epetra_MpiSmpComm Global Min function.
int MinAll (long *PartialMins, long *GlobalMins, int Count) const
 Epetra_MpiSmpComm Global Min function.

Parallel Prefix Methods

int ScanSum (double *MyVals, double *ScanSums, int Count) const
 Epetra_MpiSmpComm Scan Sum function.
int ScanSum (int *MyVals, int *ScanSums, int Count) const
 Epetra_MpiSmpComm Scan Sum function.
int ScanSum (long *MyVals, long *ScanSums, int Count) const
 Epetra_MpiSmpComm Scan Sum function.

Attribute Accessor Methods

MPI_Comm Comm () const
 Extract MPI Communicator from a Epetra_MpiSmpComm object.
int MyPID () const
 Return my process ID.
int NumProc () const
 Returns total number of processes.

Gather/Scatter and Directory Constructors

Epetra_DistributorCreateDistributor () const
 Create a distributor object.
Epetra_DirectoryCreateDirectory (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
 Acquire an MPI tag from the Epetra range of 24050-24099, increment tag.

Experimental SMP cluster methods (not rigorously implemented)

void NodeBarrier () const
 Epetra_MpiSmpComm Node Barrier function.
int MyThreadID () const
 Return my thread ID.
int MyNodeID () const
 Return my node ID.
int SetNumThreads (int NumThreads)
 Set number of threads on this node.
int NumThreads () const
 Get number of threads on this node.
int SetMyThreadID (int ThreadID)
 Set my thread ID.
int SetMyNodeID (int NodeID)
 Set my node ID.

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.

Detailed Description

Epetra_MpiSmpComm: The Epetra MPI Shared Memory Parallel Communication Class.

The Epetra_MpiSmpComm 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 shared memory threads.

Warning:
This is an experimental class that marginally supported nested share memory parallelism within MPI processes.
This class has been deprecated.

Definition at line 62 of file Epetra_MpiSmpComm.h.


Constructor & Destructor Documentation

Epetra_MpiSmpComm::Epetra_MpiSmpComm ( MPI_Comm  comm)

Epetra_MpiSmpComm MPI Constructor.

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

Definition at line 48 of file Epetra_MpiSmpComm.cpp.

Epetra_MpiSmpComm::Epetra_MpiSmpComm ( const Epetra_MpiSmpComm Comm)

Epetra_MpiSmpComm Copy Constructor.

Makes an exact copy of an existing Epetra_MpiSmpComm instance.

Definition at line 53 of file Epetra_MpiSmpComm.cpp.

Epetra_MpiSmpComm::~Epetra_MpiSmpComm ( ) [virtual]

Epetra_MpiSmpComm Destructor.

Completely deletes a Epetra_MpiSmpComm object.

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

Definition at line 173 of file Epetra_MpiSmpComm.cpp.


Member Function Documentation

Epetra_Comm* Epetra_MpiSmpComm::Clone ( ) const [inline, virtual]

Clone method.

Implements Epetra_Comm.

Definition at line 82 of file Epetra_MpiSmpComm.h.

void Epetra_MpiSmpComm::Barrier ( ) const [virtual]

Epetra_MpiSmpComm Barrier function.

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

Implements Epetra_Comm.

Definition at line 61 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm Broadcast function.

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

Parameters:
ValuesInOut 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.
CountIn On entry, contains the length of the list of Values.
RootIn On entry, contains the processor from which all processors will receive a copy of Values.

Implements Epetra_Comm.

Definition at line 65 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm Broadcast function.

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

Parameters:
ValuesInOut 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.
CountIn On entry, contains the length of the list of Values.
RootIn On entry, contains the processor from which all processors will receive a copy of Values.

Implements Epetra_Comm.

Definition at line 70 of file Epetra_MpiSmpComm.cpp.

int Epetra_MpiSmpComm::Broadcast ( long *  MyVals,
int  Count,
int  Root 
) const [virtual]

Epetra_MpiSmpComm Broadcast function.

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

Parameters:
ValuesInOut 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.
CountIn On entry, contains the length of the list of Values.
RootIn On entry, contains the processor from which all processors will receive a copy of Values.

Implements Epetra_Comm.

Definition at line 75 of file Epetra_MpiSmpComm.cpp.

int Epetra_MpiSmpComm::Broadcast ( char *  MyVals,
int  Count,
int  Root 
) const [virtual]

Epetra_MpiSmpComm Broadcast function.

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

Parameters:
ValuesInOut 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.
CountIn On entry, contains the length of the list of Values.
RootIn On entry, contains the processor from which all processors will receive a copy of Values.

Implements Epetra_Comm.

Definition at line 80 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm 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:
MyValsIn On entry, contains the list of values, to be sent to all processors.
AllValsOut On exit, contains the list of values from all processors. Must by of size NumProc*Count.
CountIn On entry, contains the length of the list of MyVals.

Implements Epetra_Comm.

Definition at line 85 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm 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:
MyValsIn On entry, contains the list of values, to be sent to all processors.
AllValsOut On exit, contains the list of values from all processors. Must by of size NumProc*Count.
CountIn On entry, contains the length of the list of MyVals.

Implements Epetra_Comm.

Definition at line 90 of file Epetra_MpiSmpComm.cpp.

int Epetra_MpiSmpComm::GatherAll ( long *  MyVals,
long *  AllVals,
int  Count 
) const [virtual]

Epetra_MpiSmpComm 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:
MyValsIn On entry, contains the list of values, to be sent to all processors.
AllValsOut On exit, contains the list of values from all processors. Must by of size NumProc*Count.
CountIn On entry, contains the length of the list of MyVals.

Implements Epetra_Comm.

Definition at line 95 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm 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:
PartialSumsIn On entry, contains the list of values, usually partial sums computed locally, to be summed across all processors.
GlobalSumsOut On exit, contains the list of values summed across all processors.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 100 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm 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:
PartialSumsIn On entry, contains the list of values, usually partial sums computed locally, to be summed across all processors.
GlobalSumsOut On exit, contains the list of values summed across all processors.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 105 of file Epetra_MpiSmpComm.cpp.

int Epetra_MpiSmpComm::SumAll ( long *  PartialSums,
long *  GlobalSums,
int  Count 
) const [virtual]

Epetra_MpiSmpComm 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:
PartialSumsIn On entry, contains the list of values, usually partial sums computed locally, to be summed across all processors.
GlobalSumsOut On exit, contains the list of values summed across all processors.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 110 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm 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:
PartialMaxsIn On entry, contains the list of values, usually partial maxs computed locally; using these Partial Maxs, the max across all processors will be computed.
GlobalMaxsOut On exit, contains the list of maxs computed across all processors.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 115 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm 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:
PartialMaxsIn On entry, contains the list of values, usually partial maxs computed locally; using these Partial Maxs, the max across all processors will be computed.
GlobalMaxsOut On exit, contains the list of maxs computed across all processors.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 120 of file Epetra_MpiSmpComm.cpp.

int Epetra_MpiSmpComm::MaxAll ( long *  PartialMaxs,
long *  GlobalMaxs,
int  Count 
) const [virtual]

Epetra_MpiSmpComm 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:
PartialMaxsIn On entry, contains the list of values, usually partial maxs computed locally; using these Partial Maxs, the max across all processors will be computed.
GlobalMaxsOut On exit, contains the list of maxs computed across all processors.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 125 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm 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:
PartialMinsIn On entry, contains the list of values, usually partial mins computed locally; using these Partial Mins, the min across all processors will be computed.
GlobalMinsOut On exit, contains the list of mins computed across all processors.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 130 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm Global Min function.

Take list of input values from all processors in the communicator, computes the max and returns the max to all processors.

Parameters:
PartialMinsIn On entry, contains the list of values, usually partial mins computed locally; using these Partial Mins, the min across all processors will be computed.
GlobalMinsOut On exit, contains the list of mins computed across all processors.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 135 of file Epetra_MpiSmpComm.cpp.

int Epetra_MpiSmpComm::MinAll ( long *  PartialMins,
long *  GlobalMins,
int  Count 
) const [virtual]

Epetra_MpiSmpComm Global Min function.

Take list of input values from all processors in the communicator, computes the max and returns the max to all processors.

Parameters:
PartialMinsIn On entry, contains the list of values, usually partial mins computed locally; using these Partial Mins, the min across all processors will be computed.
GlobalMinsOut On exit, contains the list of mins computed across all processors.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 140 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm 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:
MyValsIn On entry, contains the list of values to be summed across all processors.
ScanSumsOut On exit, contains the list of values summed across processors 0 through i.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 145 of file Epetra_MpiSmpComm.cpp.

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

Epetra_MpiSmpComm 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:
MyValsIn On entry, contains the list of values to be summed across all processors.
ScanSumsOut On exit, contains the list of values summed across processors 0 through i.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 150 of file Epetra_MpiSmpComm.cpp.

int Epetra_MpiSmpComm::ScanSum ( long *  MyVals,
long *  ScanSums,
int  Count 
) const [virtual]

Epetra_MpiSmpComm 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:
MyValsIn On entry, contains the list of values to be summed across all processors.
ScanSumsOut On exit, contains the list of values summed across processors 0 through i.
CountIn On entry, contains the length of the list of values.

Implements Epetra_Comm.

Definition at line 155 of file Epetra_MpiSmpComm.cpp.

MPI_Comm Epetra_MpiSmpComm::Comm ( ) const [inline]

Extract MPI Communicator from a Epetra_MpiSmpComm object.

Definition at line 377 of file Epetra_MpiSmpComm.h.

int Epetra_MpiSmpComm::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.

Definition at line 383 of file Epetra_MpiSmpComm.h.

int Epetra_MpiSmpComm::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.

Definition at line 389 of file Epetra_MpiSmpComm.h.

Epetra_Distributor * Epetra_MpiSmpComm::CreateDistributor ( ) const [virtual]

Create a distributor object.

Implements Epetra_Comm.

Definition at line 160 of file Epetra_MpiSmpComm.cpp.

Epetra_Directory* Epetra_MpiSmpComm::CreateDirectory ( const Epetra_BlockMap Map) const [virtual]

Create a directory object for the given Epetra_BlockMap.

Implements Epetra_Comm.

int Epetra_MpiSmpComm::GetMpiTag ( ) const [inline]

Acquire an MPI tag from the Epetra range of 24050-24099, increment tag.

Definition at line 403 of file Epetra_MpiSmpComm.h.

MPI_Comm Epetra_MpiSmpComm::GetMpiComm ( ) const [inline]

Acquire an MPI tag from the Epetra range of 24050-24099, increment tag.

Definition at line 405 of file Epetra_MpiSmpComm.h.

void Epetra_MpiSmpComm::NodeBarrier ( ) const

Epetra_MpiSmpComm Node Barrier function.

A no-op for a serial communicator. For MPI, it causes each process on a given node in the communicator to wait until all processes on that node have arrived.

This function can be used to select a subset of MPI processes that are associated with a group of threaded processes and synchronize only with this subset.

int Epetra_MpiSmpComm::MyThreadID ( ) const [inline]

Return my thread ID.

If SetMyThreadID was called to set a thread value, this function returns the thread ID of the calling process. Otherwise returns 0.

Definition at line 423 of file Epetra_MpiSmpComm.h.

int Epetra_MpiSmpComm::MyNodeID ( ) const [inline]

Return my node ID.

If SetMyNodeD was called to set a node value, this function returns the thread ID of the calling process. Otherwise returns the same value as MyPID().

Definition at line 429 of file Epetra_MpiSmpComm.h.

int Epetra_MpiSmpComm::SetNumThreads ( int  NumThreads) [inline]

Set number of threads on this node.

Sets the number of threads on the node that owns the calling process. By default the number of threads is 1.

Definition at line 434 of file Epetra_MpiSmpComm.h.

int Epetra_MpiSmpComm::NumThreads ( ) const [inline]

Get number of threads on this node.

Sets the number of threads on the node that owns the calling process. By default the number of threads is 1.

Definition at line 439 of file Epetra_MpiSmpComm.h.

int Epetra_MpiSmpComm::SetMyThreadID ( int  ThreadID) [inline]

Set my thread ID.

Sets the thread ID for the calling process. Can be used to facilitate threaded programming across an MPI application by allowing multiple MPI processes to be considered threads of a virtual shared memory process. Threads and nodes should be used together. By default the thread ID is zero.

Definition at line 446 of file Epetra_MpiSmpComm.h.

int Epetra_MpiSmpComm::SetMyNodeID ( int  NodeID) [inline]

Set my node ID.

Sets the node ID for the calling process. Can be used to facilitate threaded programming across an MPI application by associating several MPI processes with a single node. By default, each MPI process is associated with a single node with the same ID.

Definition at line 453 of file Epetra_MpiSmpComm.h.

void Epetra_MpiSmpComm::Print ( std::ostream &  os) const [inline, virtual]

Print method that implements Epetra_Object virtual Print method.

Reimplemented from Epetra_Object.

Definition at line 459 of file Epetra_MpiSmpComm.h.

void Epetra_MpiSmpComm::PrintInfo ( std::ostream &  os) const [inline, virtual]

Print method that implements Epetra_Comm virtual PrintInfo method.

Implements Epetra_Comm.

Definition at line 465 of file Epetra_MpiSmpComm.h.

Epetra_MpiSmpComm & Epetra_MpiSmpComm::operator= ( const Epetra_MpiSmpComm Comm)

Assignment Operator.

Definition at line 187 of file Epetra_MpiSmpComm.cpp.

void Epetra_MpiSmpComm::CleanupData ( ) [private]

Definition at line 177 of file Epetra_MpiSmpComm.cpp.


Member Data Documentation

Definition at line 475 of file Epetra_MpiSmpComm.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines