Skip to content

Commit 7de7ff8

Browse files
committed
MPI_COMM_WORLD -> mpi_comm in C++ API description
1 parent 66a9994 commit 7de7ff8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ Initialization can be done in the following manner, for example (`StaticLoadBala
1515
```cpp
1616
#include <SLB4MPI.h>
1717
...
18-
StaticLoadBalancer slb(MPI_COMM_WORLD, 1, 100, 2, 4);
18+
StaticLoadBalancer slb(mpi_comm, 1, 100, 2, 4);
1919
```
20-
That will initialize load balancer `slb` with range from lower bound (`1`) to upper bound (`100`) and with min (`2`) and max (`4`) chunk sizes which are optional which will work on communicator `comm`.
20+
That will initialize load balancer `slb` with range from lower bound (`1`) to upper bound (`100`) and with min (`2`) and max (`4`) chunk sizes which are optional which will work on communicator `mpi_comm`.
2121
Simpler initialization is also possible with default min and max chuck sizes:
2222
```cpp
23-
StaticLoadBalancer slb(MPI_COMM_WORLD, 1, 100);
23+
StaticLoadBalancer slb(mpi_comm, 1, 100);
2424
```
2525
This is a barrier for the whole communicator.
2626

@@ -39,7 +39,7 @@ Internally, it uses RAII, so it most of cases you do not think about destructing
3939
For `Runtime` load balancer, a proper load balancer must be specified via first argument during initialization:
4040
```cpp
4141
std::string rlbtype = std::string("dynamic");
42-
RuntimeLoadBalancer rlb(rlbtype, MPI_COMM_WORLD, 1, 100, 2, 4);
42+
RuntimeLoadBalancer rlb(rlbtype, mpi_comm, 1, 100, 2, 4);
4343
```
4444
See possible values in the next section.
4545

0 commit comments

Comments
 (0)