src/gromacs/legacyheaders/update.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 _update_h
  39 #define _update_h
  40
  41 #include "gromacs/legacyheaders/typedefs.h"
  42 #include "gromacs/legacyheaders/tgroup.h"
  43 #include "gromacs/legacyheaders/network.h"
  44
  45 #include "../timing/wallcycle.h"
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 struct t_graph;
  52
  53 /* Abstract type for stochastic dynamics */
  54 typedef struct gmx_update *gmx_update_t;
  55
  56 /* Initialize the stochastic dynamics struct */
  57 gmx_update_t init_update(t_inputrec *ir);
  58
  59 /* Store the random state from sd in state */
  60 void get_stochd_state(gmx_update_t sd, t_state *state);
  61
  62 /* Set the random in sd from state */
  63 void set_stochd_state(gmx_update_t sd, t_state *state);
  64
  65 /* Store the box at step step
  66  * as a reference state for simulations with box deformation.
  67  */
  68 void set_deform_reference_box(gmx_update_t upd,
  69                               gmx_int64_t step, matrix box);
  70
  71 void update_tcouple(gmx_int64_t       step,
  72                     t_inputrec       *inputrec,
  73                     t_state          *state,
  74                     gmx_ekindata_t   *ekind,
  75                     t_extmass        *MassQ,
  76                     t_mdatoms        *md
  77                     );
  78
  79 void update_pcouple(FILE             *fplog,
  80                     gmx_int64_t       step,
  81                     t_inputrec       *inputrec,
  82                     t_state          *state,
  83                     matrix            pcoupl_mu,
  84                     matrix            M,
  85                     gmx_bool          bInitStep);
  86
  87 void update_coords(FILE             *fplog,
  88                    gmx_int64_t       step,
  89                    t_inputrec       *inputrec, /* input record and box stuff    */
  90                    t_mdatoms        *md,
  91                    t_state          *state,
  92                    gmx_bool          bMolPBC,
  93                    rvec             *f, /* forces on home particles */
  94                    gmx_bool          bDoLR,
  95                    rvec             *f_lr,
  96                    tensor           *vir_lr_constr,
  97                    t_fcdata         *fcd,
  98                    gmx_ekindata_t   *ekind,
  99                    matrix            M,
 100                    gmx_update_t      upd,
 101                    gmx_bool          bInitStep,
 102                    int               bUpdatePart,
 103                    t_commrec        *cr, /* these shouldn't be here -- need to think about it */
 104                    t_nrnb           *nrnb,
 105                    gmx_constr_t      constr,
 106                    t_idef           *idef);
 107
 108 /* Return TRUE if OK, FALSE in case of Shake Error */
 109
 110 extern gmx_bool update_randomize_velocities(t_inputrec *ir, gmx_int64_t step, const t_commrec *cr, t_mdatoms *md, t_state *state, gmx_update_t upd, gmx_constr_t constr);
 111
 112 void update_constraints(FILE             *fplog,
 113                         gmx_int64_t       step,
 114                         real             *dvdlambda, /* FEP stuff */
 115                         t_inputrec       *inputrec,  /* input record and box stuff      */
 116                         gmx_ekindata_t   *ekind,
 117                         t_mdatoms        *md,
 118                         t_state          *state,
 119                         gmx_bool          bMolPBC,
 120                         struct t_graph   *graph,
 121                         rvec              force[], /* forces on home particles */
 122                         t_idef           *idef,
 123                         tensor            vir_part,
 124                         t_commrec        *cr,
 125                         t_nrnb           *nrnb,
 126                         gmx_wallcycle_t   wcycle,
 127                         gmx_update_t      upd,
 128                         gmx_constr_t      constr,
 129                         gmx_bool          bFirstHalf,
 130                         gmx_bool          bCalcVir,
 131                         real              vetanew);
 132
 133 /* Return TRUE if OK, FALSE in case of Shake Error */
 134
 135 void update_box(FILE             *fplog,
 136                 gmx_int64_t       step,
 137                 t_inputrec       *inputrec, /* input record and box stuff       */
 138                 t_mdatoms        *md,
 139                 t_state          *state,
 140                 rvec              force[], /* forces on home particles */
 141                 matrix           *scale_tot,
 142                 matrix            pcoupl_mu,
 143                 t_nrnb           *nrnb,
 144                 gmx_update_t      upd);
 145 /* Return TRUE if OK, FALSE in case of Shake Error */
 146
 147 void calc_ke_part(t_state *state, t_grpopts *opts, t_mdatoms *md,
 148                   gmx_ekindata_t *ekind, t_nrnb *nrnb, gmx_bool bEkinAveVel, gmx_bool bSaveOld);
 149 /*
 150  * Compute the partial kinetic energy for home particles;
 151  * will be accumulated in the calling routine.
 152  * The tensor is
 153  *
 154  * Ekin = SUM(i) 0.5 m[i] v[i] (x) v[i]
 155  *
 156  *     use v[i] = v[i] - u[i] when calculating temperature
 157  *
 158  * u must be accumulated already.
 159  *
 160  * Now also computes the contribution of the kinetic energy to the
 161  * free energy
 162  *
 163  */
 164
 165
 166 void
 167 init_ekinstate(ekinstate_t *ekinstate, const t_inputrec *ir);
 168
 169 void
 170 update_ekinstate(ekinstate_t *ekinstate, gmx_ekindata_t *ekind);
 171
 172 void
 173 restore_ekinstate_from_state(t_commrec *cr,
 174                              gmx_ekindata_t *ekind, ekinstate_t *ekinstate);
 175
 176 void berendsen_tcoupl(t_inputrec *ir, gmx_ekindata_t *ekind, real dt);
 177
 178 void andersen_tcoupl(t_inputrec *ir, gmx_int64_t step,
 179                      const t_commrec *cr, const t_mdatoms *md, t_state *state, real rate, const gmx_bool *randomize, const real *boltzfac);
 180
 181 void nosehoover_tcoupl(t_grpopts *opts, gmx_ekindata_t *ekind, real dt,
 182                        double xi[], double vxi[], t_extmass *MassQ);
 183
 184 t_state *init_bufstate(const t_state *template_state);
 185
 186 void destroy_bufstate(t_state *state);
 187
 188 void trotter_update(t_inputrec *ir, gmx_int64_t step, gmx_ekindata_t *ekind,
 189                     gmx_enerdata_t *enerd, t_state *state, tensor vir, t_mdatoms *md,
 190                     t_extmass *MassQ, int **trotter_seqlist, int trotter_seqno);
 191
 192 int **init_npt_vars(t_inputrec *ir, t_state *state, t_extmass *Mass, gmx_bool bTrotter);
 193
 194 real NPT_energy(t_inputrec *ir, t_state *state, t_extmass *MassQ);
 195 /* computes all the pressure/tempertature control energy terms to get a conserved energy */
 196
 197 void NBaroT_trotter(t_grpopts *opts, real dt,
 198                     double xi[], double vxi[], real *veta, t_extmass *MassQ);
 199
 200 void vrescale_tcoupl(t_inputrec *ir, gmx_int64_t step,
 201                      gmx_ekindata_t *ekind, real dt,
 202                      double therm_integral[]);
 203 /* Compute temperature scaling. For V-rescale it is done in update. */
 204
 205 real vrescale_energy(t_grpopts *opts, double therm_integral[]);
 206 /* Returns the V-rescale contribution to the conserved energy */
 207
 208 void rescale_velocities(gmx_ekindata_t *ekind, t_mdatoms *mdatoms,
 209                         int start, int end, rvec v[]);
 210 /* Rescale the velocities with the scaling factor in ekind */
 211
 212 void update_annealing_target_temp(t_grpopts *opts, real t);
 213 /* Set reference temp for simulated annealing at time t*/
 214
 215 real calc_temp(real ekin, real nrdf);
 216 /* Calculate the temperature */
 217
 218 real calc_pres(int ePBC, int nwall, matrix box, tensor ekin, tensor vir,
 219                tensor pres);
 220 /* Calculate the pressure tensor, returns the scalar pressure.
 221  * The unit of pressure is bar.
 222  */
 223
 224 void parrinellorahman_pcoupl(FILE *fplog, gmx_int64_t step,
 225                              t_inputrec *ir, real dt, tensor pres,
 226                              tensor box, tensor box_rel, tensor boxv,
 227                              tensor M, matrix mu,
 228                              gmx_bool bFirstStep);
 229
 230 void berendsen_pcoupl(FILE *fplog, gmx_int64_t step,
 231                       t_inputrec *ir, real dt, tensor pres, matrix box,
 232                       matrix mu);
 233
 234
 235 void berendsen_pscale(t_inputrec *ir, matrix mu,
 236                       matrix box, matrix box_rel,
 237                       int start, int nr_atoms,
 238                       rvec x[], unsigned short cFREEZE[],
 239                       t_nrnb *nrnb);
 240
 241 void correct_ekin(FILE *log, int start, int end, rvec v[],
 242                   rvec vcm, real mass[], real tmass, tensor ekin);
 243 /* Correct ekin for vcm */
 244
 245
 246 #ifdef __cplusplus
 247 }
 248 #endif
 249
 250 #endif  /* _update_h */