mpi Namespace Reference

CPP API: mio::mpi Namespace Reference
mio::mpi Namespace Reference

Typedefs

using Comm = void *
 Alias for MPI_Comm, to be used in APIs to avoid having to use #ifdef everywhere. More...
 

Functions

void finalize ()
 Finalize MPI. More...
 
Comm get_world ()
 Get the global MPI communicator. More...
 
void init ()
 Initialize MPI. More...
 
bool is_root ()
 Returns true if the calling process is the root process. More...
 
int rank (Comm comm)
 Return the rank of the calling process on the given communicator. More...
 
int size (Comm comm)
 Return the size of the given communicator. More...
 

Typedef Documentation

◆ Comm

using mio::mpi::Comm = typedef void*

Alias for MPI_Comm, to be used in APIs to avoid having to use #ifdef everywhere.

Function Documentation

◆ finalize()

void mio::mpi::finalize ( )

Finalize MPI.

◆ get_world()

Comm mio::mpi::get_world ( )

Get the global MPI communicator.

◆ init()

void mio::mpi::init ( )

Initialize MPI.

◆ is_root()

bool mio::mpi::is_root ( )

Returns true if the calling process is the root process.

◆ rank()

int mio::mpi::rank ( Comm  comm)

Return the rank of the calling process on the given communicator.

Parameters
commAn MPI communicator.

◆ size()

int mio::mpi::size ( Comm  comm)

Return the size of the given communicator.

Parameters
commAn MPI communicator.