src/gromacs/mdlib/nbnxn_search.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 _nbnxn_search_h
  37 #define _nbnxn_search_h
  38
  39 #include "typedefs.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /* Returns the j-cluster size for kernel of type nb_kernel_type */
  46 int nbnxn_kernel_to_cj_size(int nb_kernel_type);
  47
  48 /* Tells if the pair-list corresponding to nb_kernel_type is simple.
  49  * Returns FALSE for super-sub type pair-list.
  50  */
  51 gmx_bool nbnxn_kernel_pairlist_simple(int nb_kernel_type);
  52
  53 /* Due to the cluster size the effective pair-list is longer than
  54  * that of a simple atom pair-list. This function gives the extra distance.
  55  */
  56 real nbnxn_get_rlist_effective_inc(int cluster_size, real atom_density);
  57
  58 /* Allocates and initializes a pair search data structure */
  59 void nbnxn_init_search(nbnxn_search_t    * nbs_ptr,
  60                        ivec               *n_dd_cells,
  61                        gmx_domdec_zones_t *zones,
  62                        int                 nthread_max);
  63
  64 /* Put the atoms on the pair search grid.
  65  * Only atoms a0 to a1 in x are put on the grid.
  66  * The atom_density is used to determine the grid size.
  67  * When atom_density=-1, the density is determined from a1-a0 and the corners.
  68  * With domain decomposition part of the n particles might have migrated,
  69  * but have not been removed yet. This count is given by nmoved.
  70  * When move[i] < 0 particle i has migrated and will not be put on the grid.
  71  * Without domain decomposition move will be NULL.
  72  */
  73 void nbnxn_put_on_grid(nbnxn_search_t nbs,
  74                        int ePBC, matrix box,
  75                        int dd_zone,
  76                        rvec corner0, rvec corner1,
  77                        int a0, int a1,
  78                        real atom_density,
  79                        const int *atinfo,
  80                        rvec *x,
  81                        int nmoved, int *move,
  82                        int nb_kernel_type,
  83                        nbnxn_atomdata_t *nbat);
  84
  85 /* As nbnxn_put_on_grid, but for the non-local atoms
  86  * with domain decomposition. Should be called after calling
  87  * nbnxn_search_put_on_grid for the local atoms / home zone.
  88  */
  89 void nbnxn_put_on_grid_nonlocal(nbnxn_search_t            nbs,
  90                                 const gmx_domdec_zones_t *zones,
  91                                 const int                *atinfo,
  92                                 rvec                     *x,
  93                                 int                       nb_kernel_type,
  94                                 nbnxn_atomdata_t         *nbat);
  95
  96 /* Add simple grid type information to the local super/sub grid */
  97 void nbnxn_grid_add_simple(nbnxn_search_t    nbs,
  98                            nbnxn_atomdata_t *nbat);
  99
 100 /* Return the number of x and y cells in the local grid */
 101 void nbnxn_get_ncells(nbnxn_search_t nbs, int *ncx, int *ncy);
 102
 103 /* Return the order indices *a of the atoms on the ns grid, size n */
 104 void nbnxn_get_atomorder(nbnxn_search_t nbs, int **a, int *n);
 105
 106 /* Renumber the atom indices on the grid to consecutive order */
 107 void nbnxn_set_atomorder(nbnxn_search_t nbs);
 108
 109 /* Initializes a set of pair lists stored in nbnxn_pairlist_set_t */
 110 void nbnxn_init_pairlist_set(nbnxn_pairlist_set_t *nbl_list,
 111                              gmx_bool simple, gmx_bool combined,
 112                              nbnxn_alloc_t *alloc,
 113                              nbnxn_free_t  *free);
 114
 115 /* Make a apir-list with radius rlist, store it in nbl.
 116  * The parameter min_ci_balanced sets the minimum required
 117  * number or roughly equally sized ci blocks in nbl.
 118  * When set >0 ci lists will be chopped up when the estimate
 119  * for the number of equally sized lists is below min_ci_balanced.
 120  */
 121 void nbnxn_make_pairlist(const nbnxn_search_t  nbs,
 122                          nbnxn_atomdata_t     *nbat,
 123                          const t_blocka       *excl,
 124                          real                  rlist,
 125                          int                   min_ci_balanced,
 126                          nbnxn_pairlist_set_t *nbl_list,
 127                          int                   iloc,
 128                          int                   nb_kernel_type,
 129                          t_nrnb               *nrnb);
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif