openmpi/ompi/mpi/man/man3/MPI_Wtick.3

.\"Copyright 2006, Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.TH MPI_Wtick 3OpenMPI "September 2006" "Open MPI 1.2" " "
.SH NAME
\fBMPI_Wtick\fP \- Returns the resolution of MPI_Wtime.

.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
double MPI_Wtick()

.SH Fortran Syntax
.nf
INCLUDE 'mpif.h'
DOUBLE PRECISION MPI_WTICK()

.SH C++ Syntax
.nf
#include <mpi.h>
double Wtick()

.SH RETURN VALUE
.ft R
Time in seconds of resolution of MPI_Wtime.

.SH DESCRIPTION
.ft R
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.
.PP
.SH NOTE
This function does not return an error value. Consequently, the result of calling it before MPI_Init or after MPI_Finalize is undefined.


.SH SEE ALSO 
.ft R
.sp
MPI_Wtime


' @(#)MPI_Wtick.3 1.21 06/03/09
Fixes trac:850, updates man pages This commit was SVN r13456. The following Trac tickets were found above: Ticket 850 --> https://svn.open-mpi.org/trac/ompi/ticket/850 2007-02-01 21:57:48 +00:00			`.\"Copyright 2006, Sun Microsystems, Inc.`
Initial man pages for all the MPI APIs. There are 304 of them. Also a general man page for mpi,openmpi,MPI, and OpenMPI. Extra work is needed so they get installed properly. This commit was SVN r11871. 2006-09-28 18:39:36 +00:00			`.\" Copyright (c) 1996 Thinking Machines Corporation`
			`.TH MPI_Wtick 3OpenMPI "September 2006" "Open MPI 1.2" " "`
			`.SH NAME`
			`\fBMPI_Wtick\fP \- Returns the resolution of MPI_Wtime.`

			`.SH SYNTAX`
			`.ft R`
			`.SH C Syntax`
			`.nf`
			`#include <mpi.h>`
			`double MPI_Wtick()`

			`.SH Fortran Syntax`
			`.nf`
			`INCLUDE 'mpif.h'`
			`DOUBLE PRECISION MPI_WTICK()`

			`.SH C++ Syntax`
			`.nf`
			`#include <mpi.h>`
			`double Wtick()`

			`.SH RETURN VALUE`
			`.ft R`
			`Time in seconds of resolution of MPI_Wtime.`

			`.SH DESCRIPTION`
			`.ft R`
			`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.`
			`.PP`
			`.SH NOTE`
			`This function does not return an error value. Consequently, the result of calling it before MPI_Init or after MPI_Finalize is undefined.`


			`.SH SEE ALSO`
			`.ft R`
			`.sp`
			`MPI_Wtime`


			`' @(#)MPI_Wtick.3 1.21 06/03/09`