Merge release-5-0 into master
[alexxy/gromacs.git] / src / programs / mdrun / repl_ex.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) 2011,2012,2013,2014, 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
38 #ifndef _repl_ex_h
39 #define _repl_ex_h
40
41 #include "gromacs/legacyheaders/typedefs.h"
42 #include "gromacs/legacyheaders/types/commrec.h"
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 /* Abstract type for replica exchange */
49 typedef struct gmx_repl_ex *gmx_repl_ex_t;
50
51 extern gmx_repl_ex_t init_replica_exchange(FILE *fplog,
52                                            const gmx_multisim_t *ms,
53                                            const t_state *state,
54                                            const t_inputrec *ir,
55                                            int nst, int nmultiex, int init_seed);
56 /* Should only be called on the master nodes */
57
58 extern gmx_bool replica_exchange(FILE *fplog,
59                                  const t_commrec *cr,
60                                  gmx_repl_ex_t re,
61                                  t_state *state, gmx_enerdata_t *enerd,
62                                  t_state *state_local,
63                                  gmx_int64_t step, real time);
64 /* Attempts replica exchange, should be called on all nodes.
65  * Returns TRUE if this state has been exchanged.
66  * When running each replica in parallel,
67  * this routine collects the state on the master node before exchange.
68  * With domain decomposition, the global state after exchange is stored
69  * in state and still needs to be redistributed over the nodes.
70  */
71
72 extern void print_replica_exchange_statistics(FILE *fplog, gmx_repl_ex_t re);
73 /* Should only be called on the master nodes */
74
75 #ifdef __cplusplus
76 }
77 #endif
78
79 #endif  /* _repl_ex_h */