src/gromacs/mdlib/calc_verletbuf.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2017, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35
  36 #ifndef GMX_MDLIB_CALC_VERLETBUF_H
  37 #define GMX_MDLIB_CALC_VERLETBUF_H
  38
  39 #include "gromacs/utility/basedefinitions.h"
  40 #include "gromacs/utility/real.h"
  41
  42 struct gmx_mtop_t;
  43 struct t_inputrec;
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 typedef struct
  50 {
  51     int  cluster_size_i;  /* Cluster pair-list i-cluster size atom count */
  52     int  cluster_size_j;  /* Cluster pair-list j-cluster size atom count */
  53 } verletbuf_list_setup_t;
  54
  55
  56 /* Add a 5% and 10% rlist buffer for simulations without dynamics (EM, NM, ...)
  57  * and NVE simulations with zero initial temperature, respectively.
  58  * 10% should be enough for any NVE simulation with PME and nstlist=10,
  59  * for other settings it might not be enough, but then it's difficult
  60  * to come up with any reasonable (not crazily expensive) value
  61  * and grompp will notify the user when using the 10% buffer.
  62  */
  63 static const real verlet_buffer_ratio_nodynamics = 0.05;
  64 static const real verlet_buffer_ratio_NVE_T0     = 0.10;
  65
  66
  67 /* Sets the pair-list setup assumed for the current Gromacs configuration.
  68  * The setup with smallest cluster sizes is return, such that the Verlet
  69  * buffer size estimated with this setup will be conservative.
  70  * makeSimdPairList tells if to take into account SIMD, when supported.
  71  * makeGpuPairList tells to estimate for GPU kernels (makeSimdPairList is ignored with makeGpuPairList==true)
  72  */
  73 void verletbuf_get_list_setup(bool                    makeSimdPairList,
  74                               bool                    makeGpuPairList,
  75                               verletbuf_list_setup_t *list_setup);
  76
  77
  78 /* Calculate the non-bonded pair-list buffer size for the Verlet list
  79  * based on the particle masses, temperature, LJ types, charges
  80  * and constraints as well as the non-bonded force behavior at the cut-off.
  81  * The pair list update frequency and the list lifetime, which is nstlist-1
  82  * for normal pair-list buffering, are passed separately, as in some cases
  83  * we want an estimate for different values than the ones set in the inputrec.
  84  * If reference_temperature < 0, the maximum coupling temperature will be used.
  85  * The target is a maximum energy drift of ir->verletbuf_tol.
  86  * Returns the number of non-linear virtual sites. For these it's difficult
  87  * to determine their contribution to the drift exaclty, so we approximate.
  88  * Returns the pair-list cut-off.
  89  */
  90 void calc_verlet_buffer_size(const gmx_mtop_t *mtop, real boxvol,
  91                              const t_inputrec *ir,
  92                              int               nstlist,
  93                              int               list_lifetime,
  94                              real reference_temperature,
  95                              const verletbuf_list_setup_t *list_setup,
  96                              int *n_nonlin_vsite,
  97                              real *rlist);
  98
  99 /* Struct for unique atom type for calculating the energy drift.
 100  * The atom displacement depends on mass and constraints.
 101  * The energy jump for given distance depend on LJ type and q.
 102  */
 103 struct atom_nonbonded_kinetic_prop_t
 104 {
 105     real     mass;     /* mass */
 106     int      type;     /* type (used for LJ parameters) */
 107     real     q;        /* charge */
 108     gmx_bool bConstr;  /* constrained, if TRUE, use #DOF=2 iso 3 */
 109     real     con_mass; /* mass of heaviest atom connected by constraints */
 110     real     con_len;  /* constraint length to the heaviest atom */
 111 };
 112
 113 /* This function computes two components of the estimate of the variance
 114  * in the displacement of one atom in a system of two constrained atoms.
 115  * Returns in sigma2_2d the variance due to rotation of the constrained
 116  * atom around the atom to which it constrained.
 117  * Returns in sigma2_3d the variance due to displacement of the COM
 118  * of the whole system of the two constrained atoms.
 119  *
 120  * Only exposed here for testing purposes.
 121  */
 122 void constrained_atom_sigma2(real                                 kT_fac,
 123                              const atom_nonbonded_kinetic_prop_t *prop,
 124                              real                                *sigma2_2d,
 125                              real                                *sigma2_3d);
 126
 127 #ifdef __cplusplus
 128 }
 129 #endif
 130
 131 #endif