HPL_grid_info(3)

💖 HPL_grid_info(3) 💖

okay bestie so this is a page from the HPL Library Functions manual, and it's about HPL_grid_info — the little function that tells you where you are and how big the party is. let's get into it 🫶

---

✨ NAME ✨

HPL_grid_info — retrieve grid information.

like. it gets you the grid info. that's the whole vibe. 🔥

---

🌸 SYNOPSIS 🌸

#include "hpl.h"

int HPL_grid_info( const HPL_T_grid * GRID, int * NPROW, int * NPCOL,
int * MYROW, int * MYCOL );

---

🦋 DESCRIPTION 🦋

HPL_grid_info returns the grid shape and the coordinates in the grid of the calling process. so like, who am I and where am I standing in this whole arrangement — that's what it's giving. ✨

Successful completion is indicated by the returned error code MPI_SUCCESS. any other error codes? those depend on your MPI implementation, so it's giving "depends on the vibes of whoever wrote your MPI." 🙈

---

👑 ARGUMENTS 👑

• GRID (local input) — const HPL_T_grid * — On entry, GRID points to the data structure containing the process grid information. it's the source of truth, the blueprint, the map. no cap. 🗺️
• NPROW (global output) — int * — On exit, NPROW specifies the number of process rows in the grid. NPROW is at least one. so like, never zero, we always have at least a row. periodt. 💅
• NPCOL (global output) — int * — On exit, NPCOL specifies the number of process columns in the grid. NPCOL is at least one. same energy, at least one column, always. 🌈
• MYROW (global output) — int * — On exit, MYROW specifies my row process coordinate in the grid. MYROW is greater than or equal to zero and less than NPROW. so it's a real coordinate, fully in bounds, main character energy confirmed. ⭐
• MYCOL (global output) — int * — On exit, MYCOL specifies my column process coordinate in the grid. MYCOL is greater than or equal to zero and less than NPCOL. yes bestie, your column, also in bounds, also valid. 🎀

---

🔥 SEE ALSO 🔥

• HPL_pnum (3)
• HPL_grid_init (3)
• HPL_grid_exit (3)

---

and that's the whole page fr fr. this one's from HPL 2.2, dated February 24, 2016 — old enough to be iconic, still out here telling processes exactly who they are and where they belong. 💜💖✨