dune-common  2.2.0
Public Types | Public Member Functions | Static Public Member Functions
Dune::FakeMPIHelper Class Reference

A fake mpi helper. More...

#include <dune/common/mpihelper.hh>

List of all members.

Public Types

enum  { isFake = true }
typedef No_Comm MPICommunicator
 The type of the mpi communicator.

Public Member Functions

int rank () const
 return rank of process, i.e. zero
int size () const
 return rank of process, i.e. one

Static Public Member Functions

static MPICommunicator getCommunicator ()
 get the default communicator
static MPICommunicator getLocalCommunicator ()
 get a local communicator
static CollectiveCommunication
< MPICommunicator
getCollectiveCommunication ()
static FakeMPIHelperinstance (int argc, char **argv)
 Get the singleton instance of the helper.

Detailed Description

A fake mpi helper.

This helper can be used if no MPI is available or one wants to run sequentially even if MPI is available and used.


Member Typedef Documentation

The type of the mpi communicator.


Member Enumeration Documentation

anonymous enum
Enumerator:
isFake 

Are we fake (i.e. pretend to have MPI support but are compiled without.)


Member Function Documentation

static CollectiveCommunication<MPICommunicator> Dune::FakeMPIHelper::getCollectiveCommunication ( )
inlinestatic

References getCommunicator().

static MPICommunicator Dune::FakeMPIHelper::getCommunicator ( )
inlinestatic

get the default communicator

Return a communicator to exchange data with all processes

Returns:
a fake communicator

Referenced by getCollectiveCommunication(), and getLocalCommunicator().

static MPICommunicator Dune::FakeMPIHelper::getLocalCommunicator ( )
inlinestatic

get a local communicator

Returns a communicator to communicate with the local process only

Returns:
a fake communicator

References getCommunicator().

static FakeMPIHelper& Dune::FakeMPIHelper::instance ( int  argc,
char **  argv 
)
inlinestatic

Get the singleton instance of the helper.

This method has to be called with the same arguments that the main method of the program was called:

int main(int argc, char** argv){
MPIHelper::instance(argc, argv);
// program code comes here
...
}
Parameters:
argcThe number of arguments provided to main.
argvThe arguments provided to main.
int Dune::FakeMPIHelper::rank ( ) const
inline

return rank of process, i.e. zero

int Dune::FakeMPIHelper::size ( ) const
inline

return rank of process, i.e. one


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