Skip to content

Latest commit

 

History

History
69 lines (39 loc) · 1.1 KB

MPI_Wtick.3.rst

File metadata and controls

69 lines (39 loc) · 1.1 KB
Raw

MPI_Wtick

:ref:`MPI_Wtick` - Returns the resolution of :ref:`MPI_Wtime`.

SYNTAX

C Syntax

#include <mpi.h>

double MPI_Wtick()

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
DOUBLE PRECISION MPI_WTICK()

Fortran 2008 Syntax

USE mpi_f08
DOUBLE PRECISION MPI_WTICK()

RETURN VALUE

Time in seconds of resolution of :ref:`MPI_Wtime`.

DESCRIPTION

:ref:`MPI_Wtick` returns the resolution of :ref:`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 :ref:`MPI_Wtick` should be 10^-3.

NOTE

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

.. seealso::
   * :ref:`MPI_Wtime`