Available Functions

Parallelization functions

Many of the functions have an MPI equivalent which is also listed in the table to aid people familiar with MPI.

Function name	Input	Output	Description	MPI equivalent
parGetRank	None	Id of the current node.	Returns the id of the current node.	MPI_Comm_rank
parGetSize	None	Total number of nodes.	Returns the total number of nodes.	MPI_Comm_size
parBarrier	None	None	Parallel barrier, all nodes must reach the point of calling this function for any of them to continue further. Provides synchronization.	MPI_Barrier

(Initialization and finalization of the Open MPI implementation is automatic. )

For an example of usage see how to write a parallel macro.

Progress logging functions

Function name	Input	Output	Description
parReportProgress	Task id (e.g. 8), progress percentage (e.g. 85 %)	None	Outputs progress in percentage for a specified task in the node’s progress log.
parReportText	Text	None	Outputs given text to the node’s log.
parAddTask	Description	Index of added task.	Creates a new task with the description provided.
parReportTasks	None	None	Outputs all task ids with their descriptions.
parEnableTiming	None	None	Enables timing each task in the progress logs. It measures time passed to reach 100% from 0% progress.

For an example of usage see how to use the progress reporting functions.

main hub:house: