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