Open MPI logo

MPI_Wtick(3) man page (version 1.8.1)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

MPI_Wtick - Returns the resolution of MPI_Wtime.

Syntax

C Syntax


#include <mpi.h>
double MPI_Wtick()

Fortran Syntax


INCLUDE ’mpif.h’
DOUBLE PRECISION MPI_WTICK()

C++ Syntax


#include <mpi.h>
double MPI::Wtick()

Return Value

Time in seconds of resolution of MPI_Wtime.

Description

MPI_Wtick returns the resolution of MPI_Wtime in seconds. That is, it returns, as a double-precision value, the number of seconds between successive clock ticks. For example, if the clock is implemented by the hardware as a counter that is incremented every millisecond, the value returned by MPI_Wtick should be 10^-3.

Note that on POSIX platforms, Open MPI should always return 10^-6 for MPI_Wtick. The returned value may be different on Windows platforms.

Note

This function does not return an error value. Consequently, the result of calling it before MPI_Init or after MPI_Finalize is undefined.

See Also

MPI_Wtime


Table of Contents

« Return to documentation listing