src/gromacs/mdlib/nbnxn_search.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2017,2018,2019, 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_NBNXN_SEARCH_H
  37 #define GMX_MDLIB_NBNXN_SEARCH_H
  38
  39 #include "gromacs/mdlib/nbnxn_pairlist.h"
  40
  41 struct gmx_domdec_zones_t;
  42 struct gmx_groups_t;
  43 struct t_blocka;
  44 struct t_nrnb;
  45
  46 /* Tells if the pair-list corresponding to nb_kernel_type is simple.
  47  * Returns FALSE for super-sub type pair-list.
  48  */
  49 gmx_bool nbnxn_kernel_pairlist_simple(int nb_kernel_type);
  50
  51 /* Due to the cluster size the effective pair-list is longer than
  52  * that of a simple atom pair-list. This function gives the extra distance.
  53  */
  54 real nbnxn_get_rlist_effective_inc(int cluster_size, real atom_density);
  55
  56 /* Allocates and initializes a pair search data structure */
  57 nbnxn_search_t nbnxn_init_search(const ivec                *n_dd_cells,
  58                                  const gmx_domdec_zones_t  *zones,
  59                                  gmx_bool                   bFEP,
  60                                  int                        nthread_max);
  61
  62 /* Initializes a set of pair lists stored in nbnxn_pairlist_set_t */
  63 void nbnxn_init_pairlist_set(nbnxn_pairlist_set_t *nbl_list,
  64                              gmx_bool simple, gmx_bool combined);
  65
  66 /* Make a pair-list with radius rlist, store it in nbl.
  67  * The parameter min_ci_balanced sets the minimum required
  68  * number or roughly equally sized ci blocks in nbl.
  69  * When set >0 ci lists will be chopped up when the estimate
  70  * for the number of equally sized lists is below min_ci_balanced.
  71  * With perturbed particles, also a group scheme style nbl_fep list is made.
  72  */
  73 void nbnxn_make_pairlist(nbnxn_search_t        nbs,
  74                          nbnxn_atomdata_t     *nbat,
  75                          const t_blocka       *excl,
  76                          real                  rlist,
  77                          int                   min_ci_balanced,
  78                          nbnxn_pairlist_set_t *nbl_list,
  79                          int                   iloc,
  80                          int                   nb_kernel_type,
  81                          t_nrnb               *nrnb);
  82
  83 /*! \brief Prepare the list-set produced by the search for dynamic pruning
  84  *
  85  * \param[in,out] listSet  The list-set to prepare for dynamic pruning.
  86  */
  87 void nbnxnPrepareListForDynamicPruning(nbnxn_pairlist_set_t *listSet);
  88
  89 #endif