src/kernel/repl_ex.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  * Gallium Rubidium Oxygen Manganese Argon Carbon Silicon
  34  */
  35
  36 #ifndef _repl_ex_h
  37 #define _repl_ex_h
  38
  39 #include "typedefs.h"
  40 #include "types/commrec.h"
  41
  42 /* Abstract type for replica exchange */
  43 typedef struct gmx_repl_ex *gmx_repl_ex_t;
  44
  45 extern gmx_repl_ex_t init_replica_exchange(FILE *fplog,
  46                                            const gmx_multisim_t *ms,
  47                                            const t_state *state,
  48                                            const t_inputrec *ir,
  49                                            int nst, int nmultiex, int init_seed);
  50 /* Should only be called on the master nodes */
  51
  52 extern gmx_bool replica_exchange(FILE *fplog,
  53                              const t_commrec *cr,
  54                              gmx_repl_ex_t re,
  55                              t_state *state,gmx_enerdata_t *enerd,
  56                              t_state *state_local,
  57                              gmx_large_int_t step,real time);
  58 /* Attempts replica exchange, should be called on all nodes.
  59  * Returns TRUE if this state has been exchanged.
  60  * When running each replica in parallel,
  61  * this routine collects the state on the master node before exchange.
  62  * With particle the state is redistributed over the nodes after exchange.
  63  * With domain decomposition the global state after exchanged in stored
  64  * in state and still needs to be redistributed over the nodes.
  65  */
  66
  67 extern void print_replica_exchange_statistics(FILE *fplog,gmx_repl_ex_t re);
  68 /* Should only be called on the master nodes */
  69
  70 extern void pd_distribute_state(const t_commrec *cr,t_state *state);
  71 /* Distributes the state after exchange for particle decomposition */
  72
  73 #endif  /* _repl_ex_h */