src/gromacs/mdrunutility/printtime.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \libinternal \file
  36  *
  37  * \brief Declares functions that write timestamps to e.g. log files.
  38  *
  39  * \ingroup module_mdrunutility
  40  * \inlibraryapi
  41  */
  42 #ifndef GMX_MDRUNUTILITY_PRINTTIME_H
  43 #define GMX_MDRUNUTILITY_PRINTTIME_H
  44
  45 #include <cstdint>
  46 #include <cstdio>
  47 #include <cstdlib>
  48
  49 struct gmx_walltime_accounting;
  50 struct t_commrec;
  51 struct t_inputrec;
  52
  53 //! Print time to \c out.
  54 void print_time(FILE *out, gmx_walltime_accounting *walltime_accounting,
  55                 int64_t step, const t_inputrec *ir, const t_commrec *cr);
  56
  57 /*! \brief Print date, time, MPI rank and a description of this point
  58  * in time.
  59  *
  60  * \param[in] log       logfile, or NULL to suppress output
  61  * \param[in] rank      MPI rank to include in the output
  62  * \param[in] title     Description to include in the output
  63  * \param[in] the_time  Seconds since the epoch, e.g. as reported by gmx_gettime
  64  */
  65 void print_date_and_time(FILE *log, int rank, const char *title,
  66                          double the_time);
  67
  68 //! Print start time to \c fplog.
  69 void print_start(FILE *fplog, const t_commrec *cr,
  70                  gmx_walltime_accounting *walltime_accounting,
  71                  const char *name);
  72
  73 #endif