include/main.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _main_h
  37 #define _main_h
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include <config.h>
  41 #endif
  42
  43
  44 #include <stdio.h>
  45 #include "network.h"
  46
  47 extern bool gmx_parallel_env_initialized(void);
  48 /* 1 when running in a parallel environment, so could also be 1 if
  49    mdrun was started with: mpirun -np 1.
  50
  51    Use this function only to check whether a parallel environment has
  52    been initialized, for example when checking whether gmx_finalize()
  53    needs to be called. Use PAR(cr) to check whether the simulation actually
  54    has more than one node/thread. */
  55
  56
  57 extern void gmx_log_open(const char *fn,const t_commrec *cr,
  58                           bool bMasterOnly, unsigned long Flags, FILE**);
  59 /* Open the log file, if necessary (nprocs > 1) the logfile name is
  60  * communicated around the ring.
  61  */
  62
  63 extern void gmx_log_close(FILE *fp);
  64 /* Close the log file */
  65
  66 extern void check_multi_int(FILE *log,const gmx_multisim_t *ms,
  67                             int val,const char *name);
  68 /* Check if val is the same on all processors for a mdrun -multi 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.
  71  */
  72
  73 extern void init_multisystem(t_commrec *cr,int nsim,int nfile,
  74                              const t_filenm fnm[], bool bParFn);
  75 /* Splits the communication into nsim seperate simulations
  76  * and creates a communication structure between the master
  77  * these simulations.
  78  * If bParFn is set, the nodeid is appended to the tpx and each output file.
  79  */
  80
  81 extern t_commrec *init_par(int *argc,char ***argv_ptr);
  82 /* Initiate the parallel computer. Return the communication record
  83  * (see network.h). The command line arguments are communicated so that they can be
  84  * parsed on each processor.
  85  * Arguments are the number of command line arguments, and a pointer to the
  86  * array of argument strings.
  87  */
  88
  89 extern t_commrec *init_par_threads(t_commrec *cro);
  90 /* Initiate the communication records for thread-parallel simulations.
  91    Must be called before any communication takes place by the individual
  92    threads. cro is the old shared commrec */
  93
  94
  95 extern t_commrec *init_cr_nopar(void);
  96 /* Returns t_commrec for non-parallel functionality */
  97
  98 #endif  /* _main_h */