src/gromacs/legacyheaders/md_support.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) 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 _md_support_h
  39 #define _md_support_h
  40
  41 #include "gromacs/legacyheaders/typedefs.h"
  42 #include "gromacs/legacyheaders/types/globsig.h"
  43 #include "gromacs/legacyheaders/sim_util.h"
  44 #include "gromacs/legacyheaders/vcm.h"
  45
  46 #include "../timing/wallcycle.h"
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 /* Define a number of flags to better control the information
  53  * passed to compute_globals in md.c and global_stat.
  54  */
  55
  56 /* We are rerunning the simulation */
  57 #define CGLO_RERUNMD        (1<<1)
  58 /* we are computing the kinetic energy from average velocities */
  59 #define CGLO_EKINAVEVEL     (1<<2)
  60 /* we are removing the center of mass momenta */
  61 #define CGLO_STOPCM         (1<<3)
  62 /* bGStat is defined in do_md */
  63 #define CGLO_GSTAT          (1<<4)
  64 /* Sum the energy terms in global computation */
  65 #define CGLO_ENERGY         (1<<6)
  66 /* Sum the kinetic energy terms in global computation */
  67 #define CGLO_TEMPERATURE    (1<<7)
  68 /* Sum the kinetic energy terms in global computation */
  69 #define CGLO_PRESSURE       (1<<8)
  70 /* Sum the constraint term in global computation */
  71 #define CGLO_CONSTRAINT     (1<<9)
  72 /* we are using an integrator that requires iteration over some steps - currently not used*/
  73 #define CGLO_ITERATE        (1<<10)
  74 /* it is the first time we are iterating (or, only once through is required */
  75 #define CGLO_FIRSTITERATE   (1<<11)
  76 /* Reading ekin from the trajectory */
  77 #define CGLO_READEKIN       (1<<12)
  78 /* we need to reset the ekin rescaling factor here */
  79 #define CGLO_SCALEEKIN      (1<<13)
  80
  81
  82 /* return the number of steps between global communcations */
  83 int check_nstglobalcomm(FILE *fplog, t_commrec *cr,
  84                         int nstglobalcomm, t_inputrec *ir);
  85
  86 /* check whether an 'nst'-style parameter p is a multiple of nst, and
  87    set it to be one if not, with a warning. */
  88 void check_nst_param(FILE *fplog, t_commrec *cr,
  89                      const char *desc_nst, int nst,
  90                      const char *desc_p, int *p);
  91
  92 /* check which of the multisim simulations has the shortest number of
  93    steps and return that number of nsteps */
  94 gmx_int64_t get_multisim_nsteps(const t_commrec *cr,
  95                                 gmx_int64_t      nsteps);
  96
  97 void rerun_parallel_comm(t_commrec *cr, t_trxframe *fr,
  98                          gmx_bool *bNotLastFrame);
  99
 100 /* get the conserved energy associated with the ensemble type*/
 101 real compute_conserved_from_auxiliary(t_inputrec *ir, t_state *state,
 102                                       t_extmass *MassQ);
 103
 104 /* set the lambda values at each step of mdrun when they change */
 105 void set_current_lambdas(gmx_int64_t step, t_lambda *fepvals, gmx_bool bRerunMD,
 106                          t_trxframe *rerun_fr, t_state *state_global, t_state *state, double lam0[]);
 107
 108 int multisim_min(const gmx_multisim_t *ms, int nmin, int n);
 109 /* Set an appropriate value for n across the whole multi-simulation */
 110
 111 int multisim_nstsimsync(const t_commrec *cr,
 112                         const t_inputrec *ir, int repl_ex_nst);
 113 /* Determine the interval for inter-simulation communication */
 114
 115 void init_global_signals(globsig_t *gs, const t_commrec *cr,
 116                          const t_inputrec *ir, int repl_ex_nst);
 117 /* Constructor for globsig_t */
 118
 119 void copy_coupling_state(t_state *statea, t_state *stateb,
 120                          gmx_ekindata_t *ekinda, gmx_ekindata_t *ekindb, t_grpopts* opts);
 121 /* Copy stuff from state A to state B */
 122
 123 void compute_globals(FILE *fplog, gmx_global_stat_t gstat, t_commrec *cr, t_inputrec *ir,
 124                      t_forcerec *fr, gmx_ekindata_t *ekind,
 125                      t_state *state, t_state *state_global, t_mdatoms *mdatoms,
 126                      t_nrnb *nrnb, t_vcm *vcm, gmx_wallcycle_t wcycle,
 127                      gmx_enerdata_t *enerd, tensor force_vir, tensor shake_vir, tensor total_vir,
 128                      tensor pres, rvec mu_tot, gmx_constr_t constr,
 129                      globsig_t *gs, gmx_bool bInterSimGS,
 130                      matrix box, gmx_mtop_t *top_global, gmx_bool *bSumEkinhOld, int flags);
 131 /* Compute global variables during integration */
 132
 133 #ifdef __cplusplus
 134 }
 135 #endif
 136
 137 #endif  /* _md_support_h */