src/kernel/calc_verletbuf.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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * 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
  39 #ifndef _calc_verletbuf_h
  40 #define _calc_verletbuf_h
  41 #include "visibility.h"
  42 #include "typedefs.h"
  43
  44 typedef struct
  45 {
  46     int  cluster_size_i;  /* Cluster pair-list i-cluster size atom count */
  47     int  cluster_size_j;  /* Cluster pair-list j-cluster size atom count */
  48 } verletbuf_list_setup_t;
  49
  50
  51 /* Sets the pair-list setup assumed for the current Gromacs configuration.
  52  * The setup with smallest cluster sizes is return, such that the Verlet
  53  * buffer size estimated with this setup will be conservative.
  54  */
  55 GMX_LIBGMXPREPROCESS_EXPORT
  56 void verletbuf_get_list_setup(gmx_bool bGPU,
  57                               verletbuf_list_setup_t *list_setup);
  58
  59
  60 /* Calculate the non-bonded pair-list buffer size for the Verlet list
  61  * based on the particle masses, temperature, LJ types, charges
  62  * and constraints as well as the non-bonded force behavior at the cut-off.
  63  * The target is a maximum energy drift.
  64  * Returns the number of non-linear virtual sites. For these it's difficult
  65  * to determine their contribution to the drift exaclty, so we approximate.
  66  * Returns the pair-list cut-off.
  67  */
  68 GMX_LIBGMXPREPROCESS_EXPORT
  69 void calc_verlet_buffer_size(const gmx_mtop_t *mtop,real boxvol,
  70                              const t_inputrec *ir,real drift_target,
  71                              const verletbuf_list_setup_t *list_setup,
  72                              int *n_nonlin_vsite,
  73                              real *rlist);
  74
  75 #endif  /* _calc_verletbuf_h */