src/kernel/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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _repl_ex_h
  40 #define _repl_ex_h
  41
  42 #include "typedefs.h"
  43 #include "types/commrec.h"
  44
  45 /* Abstract type for replica exchange */
  46 typedef struct gmx_repl_ex *gmx_repl_ex_t;
  47
  48 extern gmx_repl_ex_t init_replica_exchange(FILE *fplog,
  49                                            const gmx_multisim_t *ms,
  50                                            const t_state *state,
  51                                            const t_inputrec *ir,
  52                                            int nst, int nmultiex, int init_seed);
  53 /* Should only be called on the master nodes */
  54
  55 extern gmx_bool replica_exchange(FILE *fplog,
  56                              const t_commrec *cr,
  57                              gmx_repl_ex_t re,
  58                              t_state *state,gmx_enerdata_t *enerd,
  59                              t_state *state_local,
  60                              gmx_large_int_t step,real time);
  61 /* Attempts replica exchange, should be called on all nodes.
  62  * Returns TRUE if this state has been exchanged.
  63  * When running each replica in parallel,
  64  * this routine collects the state on the master node before exchange.
  65  * With particle the state is redistributed over the nodes after exchange.
  66  * With domain decomposition the global state after exchanged in stored
  67  * in state and still needs to be redistributed over the nodes.
  68  */
  69
  70 extern void print_replica_exchange_statistics(FILE *fplog,gmx_repl_ex_t re);
  71 /* Should only be called on the master nodes */
  72
  73 extern void pd_distribute_state(const t_commrec *cr,t_state *state);
  74 /* Distributes the state after exchange for particle decomposition */
  75
  76 #endif  /* _repl_ex_h */