Dune Core Modules (2.9.0)

A fake mpi helper. More...

#include <dune/common/parallel/mpihelper.hh>

Public Types

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 More...
 
static MPICommunicator getLocalCommunicator ()
 get a local communicator More...
 
static Communication< MPICommunicatorgetCollectiveCommunication ()
 
static DUNE_EXPORT FakeMPIHelperinstance ([[maybe_unused]] int argc, [[maybe_unused]] char **argv)
 Get the singleton instance of the helper. More...
 

Static Public Attributes

constexpr static bool isFake = true
 Are we fake (i.e. pretend to have MPI support but are compiled without.)
 

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 Function Documentation

◆ getCollectiveCommunication()

static Communication<MPICommunicator> Dune::FakeMPIHelper::getCollectiveCommunication ( )
inlinestatic
Deprecated:
getCollectionCommunication is deprecated and will be removed after Dune 2.9.

Use getCommunication instead.

References getCommunicator().

◆ getCommunicator()

static DUNE_EXPORT 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().

◆ 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().

◆ instance()

static DUNE_EXPORT FakeMPIHelper& Dune::FakeMPIHelper::instance ( [[maybe_unused] ] int  argc,
[[maybe_unused] ] 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.

References instance().

Referenced by instance().


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Mar 28, 23:30, 2024)