walltime_c.h

Go to the documentation of this file.
00001 /*
00002  *  This file is part of libc_utils.
00003  *
00004  *  libc_utils is free software; you can redistribute it and/or modify
00005  *  it under the terms of the GNU General Public License as published by
00006  *  the Free Software Foundation; either version 2 of the License, or
00007  *  (at your option) any later version.
00008  *
00009  *  libc_utils is distributed in the hope that it will be useful,
00010  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00011  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012  *  GNU General Public License for more details.
00013  *
00014  *  You should have received a copy of the GNU General Public License
00015  *  along with libc_utils; if not, write to the Free Software
00016  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00017  */
00018 
00019 /*
00020  *  libc_utils is being developed at the Max-Planck-Institut fuer Astrophysik
00021  *  and financially supported by the Deutsches Zentrum fuer Luft- und Raumfahrt
00022  *  (DLR).
00023  */
00024 
00025 /*! \file walltime_c.h
00026  *  Functionality for reading wall clock time
00027  *
00028  *  Copyright (C) 2010 Max-Planck-Society
00029  *  \author Martin Reinecke
00030  */
00031 
00032 #ifndef PLANCK_WALLTIME_C_H
00033 #define PLANCK_WALLTIME_C_H
00034 
00035 #ifdef __cplusplus
00036 extern "C" {
00037 #endif
00038 
00039 /*! Returns an approximation of the current wall time (in seconds).
00040     The first available of the following timers will be used:
00041     <ul>
00042     <li> \a omp_get_wtime(), if OpenMP is available
00043     <li> \a MPI_Wtime(), if MPI is available
00044     <li> \a gettimeofday() otherwise
00045     </ul>
00046     \note Only useful for measuring time differences.
00047     \note This function has an execution time between 10 and 100 nanoseconds. */
00048 double wallTime(void);
00049 
00050 #ifdef __cplusplus
00051 }
00052 #endif
00053 
00054 #endif

Generated on Thu Oct 8 14:48:49 2015 for LevelS C support library