A real mpi helper.
More...
#include <dune/common/parallel/mpihelper.hh>
|
int | rank () const |
| return rank of process
|
|
int | size () const |
| return number of processes
|
|
| ~MPIHelper () |
| calls MPI_Finalize
|
|
|
static constexpr bool | isFake = false |
| Are we fake (i. e. pretend to have MPI support but are compiled without.
|
|
|
(Note that these are not member symbols.)
|
static DUNE_EXPORT MPIHelper & | instance (int *argc=nullptr, char ***argv=nullptr) |
| Get the singleton instance of the helper.
|
|
A real mpi helper.
This helper should be used for parallel programs.
◆ MPICommunicator
The type of the mpi communicator.
◆ ~MPIHelper()
Dune::MPIHelper::~MPIHelper |
( |
| ) |
|
|
inline |
◆ getCollectiveCommunication()
- Deprecated
- getCollectionCommunication is deprecated and will be removed after Dune 2.9.
Use getCommunication instead.
◆ getCommunication()
◆ getCommunicator()
get the default communicator
Return a communicator to exchange data with all processes
- Returns
- MPI_COMM_WORLD
◆ getLocalCommunicator()
get a local communicator
Returns a communicator to exchange data with the local process only
- Returns
- MPI_COMM_SELF
◆ instance()
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){
...
}
int main(int argc, char **argv)
Definition mpi_collective_benchmark.cc:297
static DUNE_EXPORT MPIHelper & instance(int &argc, char **&argv)
Get the singleton instance of the helper.
Definition mpihelper.hh:252
The MPIHelper will be globally initialized on its first call. Afterwards, all arguments to this function will be ignored.
- Parameters
-
argc | The number of arguments provided to main. |
argv | The arguments provided to main. |
◆ rank()
int Dune::MPIHelper::rank |
( |
| ) |
const |
|
inline |
◆ size()
int Dune::MPIHelper::size |
( |
| ) |
const |
|
inline |
return number of processes
◆ instance()
Get the singleton instance of the helper.
This method can be called either without any arguments, or with the same arguments that the main method of the program was called, passed as pointer:
int main(
int argc,
char** argv){
...
}
The MPIHelper will be globally initialized on its first call. Afterwards, all arguments to this function will be ignored.
- Note
- This overload accepts all arguments by pointer similar to the
MPI_Init
function and allows to pass nullptr
for all arguments.
(int&, char**&)
- Parameters
-
argc | The number of arguments provided to main. |
argv | The arguments provided to main. |
◆ isFake
bool Dune::MPIHelper::isFake = false |
|
staticconstexpr |
Are we fake (i. e. pretend to have MPI support but are compiled without.
The documentation for this class was generated from the following file: