1HPL_grid_init(3) HPL Library Functions HPL_grid_init(3)
2
3
4
6 HPL_grid_init - Create a process grid.
7
9 #include "hpl.h"
10
11 int HPL_grid_init( MPI_Comm COMM, const HPL_T_ORDER ORDER, const int
12 NPROW, const int NPCOL, HPL_T_grid * GRID );
13
15 HPL_grid_init creates a NPROW x NPCOL process grid using column- or
16 row-major ordering from an initial collection of processes identified
17 by an MPI communicator. Successful completion is indicated by the
18 returned error code MPI_SUCCESS. Other error codes depend on the MPI
19 implementation. The coordinates of processes that are not part of the
20 grid are set to values outside of [0..NPROW) x [0..NPCOL).
21
23 COMM (global/local input) MPI_Comm
24 On entry, COMM is the MPI communicator identifying the
25 initial collection of processes out of which the grid is
26 formed.
27
28 ORDER (global input) const HPL_T_ORDER
29 On entry, ORDER specifies how the processes should be ordered
30 in the grid as follows:
31 ORDER = HPL_ROW_MAJOR row-major ordering;
32 ORDER = HPL_COLUMN_MAJOR column-major ordering;
33
34 NPROW (global input) const int
35 On entry, NPROW specifies the number of process rows in the
36 grid to be created. NPROW must be at least one.
37
38 NPCOL (global input) const int
39 On entry, NPCOL specifies the number of process columns in
40 the grid to be created. NPCOL must be at least one.
41
42 GRID (local input/output) HPL_T_grid *
43 On entry, GRID points to the data structure containing the
44 process grid information to be initialized.
45
47 HPL_pnum (3), HPL_grid_info (3), HPL_grid_exit (3).
48
49
50
51HPL 2.2 February 24, 2016 HPL_grid_init(3)