src/gromacs/gmxpreprocess/calc_verletbuf.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013, 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 _calc_verletbuf_h
  37 #define _calc_verletbuf_h
  38
  39 #include "typedefs.h"
  40
  41 typedef struct
  42 {
  43     int  cluster_size_i;  /* Cluster pair-list i-cluster size atom count */
  44     int  cluster_size_j;  /* Cluster pair-list j-cluster size atom count */
  45 } verletbuf_list_setup_t;
  46
  47
  48 /* Sets the pair-list setup assumed for the current Gromacs configuration.
  49  * The setup with smallest cluster sizes is return, such that the Verlet
  50  * buffer size estimated with this setup will be conservative.
  51  */
  52 void verletbuf_get_list_setup(gmx_bool                bGPU,
  53                               verletbuf_list_setup_t *list_setup);
  54
  55
  56 /* Calculate the non-bonded pair-list buffer size for the Verlet list
  57  * based on the particle masses, temperature, LJ types, charges
  58  * and constraints as well as the non-bonded force behavior at the cut-off.
  59  * The target is a maximum energy drift of ir->verletbuf_tol.
  60  * Returns the number of non-linear virtual sites. For these it's difficult
  61  * to determine their contribution to the drift exaclty, so we approximate.
  62  * Returns the pair-list cut-off.
  63  */
  64 void calc_verlet_buffer_size(const gmx_mtop_t *mtop, real boxvol,
  65                              const t_inputrec *ir,
  66                              const verletbuf_list_setup_t *list_setup,
  67                              int *n_nonlin_vsite,
  68                              real *rlist);
  69
  70 #endif  /* _calc_verletbuf_h */