src/gromacs/mdrun/replicaexchange.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,2015,2017,2018,2019, 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 /*! \libinternal \file
  38  *
  39  * \brief Declares the routines for replica exchange.
  40  *
  41  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  42  * \author Mark Abraham <mark.j.abraham@gmail.com>
  43  *
  44  * \ingroup module_mdrun
  45  */
  46 #ifndef GMX_MDRUN_REPLICAEXCHANGE_H
  47 #define GMX_MDRUN_REPLICAEXCHANGE_H
  48
  49 #include <cstdio>
  50
  51 #include "gromacs/utility/basedefinitions.h"
  52 #include "gromacs/utility/real.h"
  53
  54 struct gmx_enerdata_t;
  55 struct gmx_multisim_t;
  56 struct t_commrec;
  57 struct t_inputrec;
  58 class t_state;
  59
  60 /*! \libinternal
  61  * \brief The parameters for the replica exchange algorithm. */
  62 struct ReplicaExchangeParameters
  63 {
  64     //! Interval in steps at which to attempt exchanges, 0 means no replica exchange.
  65     int exchangeInterval = 0;
  66     //! The number of exchanges to attempt at an exchange step.
  67     int numExchanges = 0;
  68     //! The random seed, -1 means generate a seed.
  69     int randomSeed = -1;
  70 };
  71
  72 //! Abstract type for replica exchange
  73 typedef struct gmx_repl_ex* gmx_repl_ex_t;
  74
  75 /*! \brief Setup function.
  76  *
  77  * Should only be called on the master ranks */
  78 gmx_repl_ex_t init_replica_exchange(FILE*                            fplog,
  79                                     const gmx_multisim_t*            ms,
  80                                     int                              numAtomsInSystem,
  81                                     const t_inputrec*                ir,
  82                                     const ReplicaExchangeParameters& replExParams);
  83
  84 /*! \brief Attempts replica exchange.
  85  *
  86  * Should be called on all ranks.  When running each replica in
  87  * parallel, this routine collects the state on the master rank before
  88  * exchange.  With domain decomposition, the global state after
  89  * exchange is stored in state and still needs to be redistributed
  90  * over the ranks.
  91  *
  92  * \returns TRUE if the state has been exchanged.
  93  */
  94 gmx_bool replica_exchange(FILE*                 fplog,
  95                           const t_commrec*      cr,
  96                           const gmx_multisim_t* ms,
  97                           gmx_repl_ex_t         re,
  98                           t_state*              state,
  99                           const gmx_enerdata_t* enerd,
 100                           t_state*              state_local,
 101                           int64_t               step,
 102                           real                  time);
 103
 104 /*! \brief Prints replica exchange statistics to the log file.
 105  *
 106  * Should only be called on the master ranks */
 107 void print_replica_exchange_statistics(FILE* fplog, gmx_repl_ex_t re);
 108
 109 #endif