src/kernel/calc_verletbuf.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gallium Rubidium Oxygen Manganese Argon Carbon Silicon
  34  */
  35
  36 #ifndef _calc_verletbuf_h
  37 #define _calc_verletbuf_h
  38 #include "visibility.h"
  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 GMX_LIBGMXPREPROCESS_EXPORT
  53 void verletbuf_get_list_setup(gmx_bool bGPU,
  54                               verletbuf_list_setup_t *list_setup);
  55
  56
  57 /* Calculate the non-bonded pair-list buffer size for the Verlet list
  58  * based on the particle masses, temperature, LJ types, charges
  59  * and constraints as well as the non-bonded force behavior at the cut-off.
  60  * The target is a maximum energy drift.
  61  * Returns the number of non-linear virtual sites. For these it's difficult
  62  * to determine their contribution to the drift exaclty, so we approximate.
  63  * Returns the pair-list cut-off.
  64  */
  65 GMX_LIBGMXPREPROCESS_EXPORT
  66 void calc_verlet_buffer_size(const gmx_mtop_t *mtop,real boxvol,
  67                              const t_inputrec *ir,real drift_target,
  68                              const verletbuf_list_setup_t *list_setup,
  69                              int *n_nonlin_vsite,
  70                              real *rlist);
  71
  72 #endif  /* _calc_verletbuf_h */