Storage and methods for MPI grid data.
Data is held in an external pointer.
new()
gridR6$new(gridtype = PROC_GRID_SQUARE)
gridtype
Type of processor grid: PROC_GRID_SQUARE
,
PROC_GRID_WIDE
, or PROC_GRID_TALL
.
Class initializer.
set()
gridR6$set(blacs_context)
blacs_context
The BLACS integer context number.
Set grid to another BLACS context.
exit()
gridR6$exit()
Exits the BLACS grid, but does not shutdown BLACS/MPI.
finalize()
gridR6$finalize(mpi_continue = FALSE)
mpi_continue
Should MPI continue, i.e., not be shut down too?
Shuts down BLACS, and optionally MPI.
info()
gridR6$info()
Print one-line information about the object.
print()
gridR6$print()
Print one-line information about the object.
rank0()
gridR6$rank0()
Is the calling process rank 0, i.e. row 0 and col 0?
ingrid()
gridR6$ingrid()
Is the calling process in the grid, i.e. row and col not -1?
barrier()
gridR6$barrier(scope = "A")
scope
'A' for all, 'R' for row, or 'C' for column.
Execute a barrier.
ictxt()
gridR6$ictxt()
The BLACS integer context.
nprocs()
gridR6$nprocs()
The BLACS integer context.
nprow()
gridR6$nprow()
The BLACS integer context.
npcol()
gridR6$npcol()
The BLACS integer context.
myrow()
gridR6$myrow()
The BLACS integer context.
mycol()
gridR6$mycol()
The BLACS integer context.
valid_grid()
gridR6$valid_grid()
Returns whether or not the grid object is valid.
data_ptr()
gridR6$data_ptr()
Returns the external pointer data. For developers only.
clone()
The objects of this class are cloneable with this method.
gridR6$clone(deep = FALSE)
deep
Whether to make a deep clone.