src/gromacs/mdlib/main.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2018, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_MDLIB_MAIN_H
  38 #define GMX_MDLIB_MAIN_H
  39
  40 #include <cstdio>
  41
  42 #include <string>
  43 #include <vector>
  44
  45 #include "gromacs/utility/arrayref.h"
  46 #include "gromacs/utility/basedefinitions.h"
  47 #include "gromacs/utility/gmxmpi.h"
  48
  49 struct gmx_multisim_t;
  50 struct t_commrec;
  51 struct t_filenm;
  52
  53 void gmx_log_open(const char *fn, const t_commrec *cr,
  54                   gmx_bool bAppendFiles, FILE**);
  55 /* Open the log file, if necessary (nprocs > 1) the logfile name is
  56  * communicated around the ring.
  57  */
  58
  59 void gmx_log_close(FILE *fp);
  60 /* Close the log file */
  61
  62 void check_multi_int(FILE *log, const gmx_multisim_t *ms,
  63                      int val, const char *name,
  64                      gmx_bool bQuiet);
  65 void check_multi_int64(FILE *log, const gmx_multisim_t *ms,
  66                        int64_t val, const char *name,
  67                        gmx_bool bQuiet);
  68 /* Check if val is the same on all processors for a mdrun -multidir run
  69  * The string name is used to print to the log file and in a fatal error
  70  * if the val's don't match. If bQuiet is true and the check passes,
  71  * no output is written.
  72  */
  73
  74 gmx_multisim_t *init_multisystem(MPI_Comm                         comm,
  75                                  gmx::ArrayRef<const std::string> multidirs);
  76 /* Splits the communication into multidirs.size() separate simulations, if >1,
  77  * and creates a communication structure between the master
  78  * these simulations.
  79  */
  80
  81 //! Cleans up multi-system handler.
  82 void done_multisim(gmx_multisim_t *ms);
  83
  84 #endif