Dune::FakeMPIHelper Class Reference

A fake mpi helper. More...

#include <dune/common/parallel/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 DUNE_EXPORT MPICommunicator getCommunicator ()
 get the default communicator
static MPICommunicator getLocalCommunicator ()
 get a local communicator
static CollectiveCommunication
< MPICommunicator
getCollectiveCommunication ()
static DUNE_EXPORT 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 (  )  [inline, static]
static DUNE_EXPORT MPICommunicator Dune::FakeMPIHelper::getCommunicator (  )  [inline, static]

get the default communicator

Return a communicator to exchange data with all processes

Returns:
a fake communicator
static MPICommunicator Dune::FakeMPIHelper::getLocalCommunicator (  )  [inline, static]

get a local communicator

Returns a communicator to communicate with the local process only

Returns:
a fake communicator
static DUNE_EXPORT FakeMPIHelper& Dune::FakeMPIHelper::instance ( int  argc,
char **  argv 
) [inline, static]

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:
argc The number of arguments provided to main.
argv The 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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 25 Mar 2018 for dune-common by  doxygen 1.6.1