Merge branch release-4-6
[alexxy/gromacs.git] / src / gromacs / legacyheaders / 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
40 #include <stdio.h>
41 #include "network.h"
42 #include "../fileio/filenm.h"
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 char *gmx_gethostname(char *name, size_t len);
49 /* Sets the hostname to the value given by gethostname, if available,
50  * and to "unknown" otherwise. name should have at least size len.
51  * Returns name.
52  */
53
54 void gmx_log_open(const char *fn, const t_commrec *cr,
55                   gmx_bool bMasterOnly, gmx_bool bAppendFiles, FILE**);
56 /* Open the log file, if necessary (nprocs > 1) the logfile name is
57  * communicated around the ring.
58  */
59
60 void gmx_log_close(FILE *fp);
61 /* Close the log file */
62
63 void check_multi_int(FILE *log, const gmx_multisim_t *ms,
64                      int val, const char *name,
65                      gmx_bool bQuiet);
66 void check_multi_large_int(FILE *log, const gmx_multisim_t *ms,
67                            gmx_large_int_t val, const char *name,
68                            gmx_bool bQuiet);
69 /* Check if val is the same on all processors for a mdrun -multi run
70  * The string name is used to print to the log file and in a fatal error
71  * if the val's don't match. If bQuiet is true and the check passes,
72  * no output is written.
73  */
74
75 void init_multisystem(t_commrec *cr, int nsim, char **multidirs,
76                       int nfile, const t_filenm fnm[], gmx_bool bParFn);
77 /* Splits the communication into nsim separate simulations
78  * and creates a communication structure between the master
79  * these simulations.
80  * If bParFn is set, the nodeid is appended to the tpx and each output file.
81  */
82
83 #ifdef __cplusplus
84 }
85 #endif
86
87 #endif  /* _main_h */