src/mdlib/nbnxn_search.h

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