include/types/nbnxn_pairlist.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-2012, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, 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 _nbnxn_pairlist_h
  40 #define _nbnxn_pairlist_h
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 /* A buffer data structure of 64 bytes
  47  * to be placed at the beginning and end of structs
  48  * to avoid cache invalidation of the real contents
  49  * of the struct by writes to neighboring memory.
  50  */
  51 typedef struct {
  52     int dummy[16];
  53 } gmx_cache_protect_t;
  54
  55 /* Abstract type for pair searching data */
  56 typedef struct nbnxn_search * nbnxn_search_t;
  57
  58 /* Function that should return a pointer *ptr to memory
  59  * of size nbytes.
  60  * Error handling should be done within this function.
  61  */
  62 typedef void nbnxn_alloc_t(void **ptr,size_t nbytes);
  63
  64 /* Function that should free the memory pointed to by *ptr.
  65  * NULL should not be passed to this function.
  66  */
  67 typedef void nbnxn_free_t(void *ptr);
  68
  69 typedef struct {
  70     int      cj;    /* The j-cluster                    */
  71     unsigned excl;  /* The exclusion (interaction) bits */
  72 } nbnxn_cj_t;
  73
  74 /* In nbnxn_ci_t the integer shift contains the shift in the lower 7 bits.
  75  * The upper bits contain information for non-bonded kernel optimization.
  76  * Simply calculating LJ and Coulomb for all pairs in a cluster pair is fine.
  77  * But three flags can be used to skip interactions, currently only for subc=0
  78  * !(shift & NBNXN_CI_DO_LJ(subc))   => we can skip LJ for all pairs
  79  * shift & NBNXN_CI_HALF_LJ(subc)    => we can skip LJ for the second half of i
  80  * !(shift & NBNXN_CI_DO_COUL(subc)) => we can skip Coulomb for all pairs
  81  */
  82 #define NBNXN_CI_SHIFT          127
  83 #define NBNXN_CI_DO_LJ(subc)    (1<<(7+3*(subc)))
  84 #define NBNXN_CI_HALF_LJ(subc)  (1<<(8+3*(subc)))
  85 #define NBNXN_CI_DO_COUL(subc)  (1<<(9+3*(subc)))
  86
  87 /* Simple pair-list i-unit */
  88 typedef struct {
  89     int ci;             /* i-cluster             */
  90     int shift;          /* Shift vector index plus possible flags, see above */
  91     int cj_ind_start;   /* Start index into cj   */
  92     int cj_ind_end;     /* End index into cj     */
  93 } nbnxn_ci_t;
  94
  95 /* Grouped pair-list i-unit */
  96 typedef struct {
  97     int sci;            /* i-super-cluster       */
  98     int shift;          /* Shift vector index plus possible flags */
  99     int cj4_ind_start;  /* Start index into cj4  */
 100     int cj4_ind_end;    /* End index into cj4    */
 101 } nbnxn_sci_t;
 102
 103 typedef struct {
 104     unsigned imask;        /* The i-cluster interactions mask for 1 warp  */
 105     int excl_ind;          /* Index into the exclusion array for 1 warp   */
 106 } nbnxn_im_ei_t;
 107
 108 typedef struct {
 109     int cj[4];             /* The 4 j-clusters                            */
 110     nbnxn_im_ei_t imei[2]; /* The i-cluster mask data       for 2 warps   */
 111 } nbnxn_cj4_t;
 112
 113 typedef struct {
 114     unsigned pair[32];     /* Exclusion bits for one warp,                *
 115                             * each unsigned has bit for 4*8 i clusters    */
 116 } nbnxn_excl_t;
 117
 118 typedef struct {
 119     gmx_cache_protect_t cp0;
 120
 121     nbnxn_alloc_t *alloc;
 122     nbnxn_free_t  *free;
 123
 124     gmx_bool bSimple;      /* Simple list has na_sc=na_s and uses cj   *
 125                             * Complex list uses cj4                    */
 126
 127     int      na_ci;        /* The number of atoms per i-cluster        */
 128     int      na_cj;        /* The number of atoms per j-cluster        */
 129     int      na_sc;        /* The number of atoms per super cluster    */
 130     real     rlist;        /* The radius for constructing the list     */
 131     int      nci;          /* The number of i-clusters in the list     */
 132     nbnxn_ci_t *ci;        /* The i-cluster list, size nci             */
 133     int      ci_nalloc;    /* The allocation size of ci                */
 134     int      nsci;         /* The number of i-super-clusters in the list */
 135     nbnxn_sci_t *sci;      /* The i-super-cluster list                 */
 136     int      sci_nalloc;   /* The allocation size of sci               */
 137
 138     int      ncj;          /* The number of j-clusters in the list     */
 139     nbnxn_cj_t *cj;        /* The j-cluster list, size ncj             */
 140     int      cj_nalloc;    /* The allocation size of cj                */
 141
 142     int      ncj4;         /* The total number of 4*j clusters         */
 143     nbnxn_cj4_t *cj4;      /* The 4*j cluster list, size ncj4          */
 144     int      cj4_nalloc;   /* The allocation size of cj4               */
 145     int      nexcl;        /* The count for excl                       */
 146     nbnxn_excl_t *excl;    /* Atom interaction bits (non-exclusions)   */
 147     int      excl_nalloc;  /* The allocation size for excl             */
 148     int      nci_tot;      /* The total number of i clusters           */
 149
 150     struct nbnxn_list_work *work;
 151
 152     gmx_cache_protect_t cp1;
 153 } nbnxn_pairlist_t;
 154
 155 typedef struct {
 156     int          nnbl;      /* number of lists */
 157     nbnxn_pairlist_t **nbl; /* lists */
 158     gmx_bool     bCombined; /* TRUE if lists get combined into one (the 1st) */
 159     gmx_bool     bSimple;   /* TRUE if the list of of type "simple"
 160                                (na_sc=na_s, no super-clusters used) */
 161     int          natpair_ljq; /* Total number of atom pairs for LJ+Q kernel */
 162     int          natpair_lj;  /* Total number of atom pairs for LJ kernel   */
 163     int          natpair_q;   /* Total number of atom pairs for Q kernel    */
 164 } nbnxn_pairlist_set_t;
 165
 166 enum { nbatXYZ, nbatXYZQ, nbatX4, nbatX8 };
 167
 168 typedef struct {
 169     real *f;      /* f, size natoms*fstride                             */
 170     real *fshift; /* Shift force array, size SHIFTS*DIM                 */
 171     int  nV;      /* The size of *Vvdw and *Vc                          */
 172     real *Vvdw;   /* Temporary Van der Waals group energy storage       */
 173     real *Vc;     /* Temporary Coulomb group energy storage             */
 174     int  nVS;     /* The size of *VSvdw and *VSc                        */
 175     real *VSvdw;  /* Temporary SIMD Van der Waals group energy storage  */
 176     real *VSc;    /* Temporary SIMD Coulomb group energy storage        */
 177 } nbnxn_atomdata_output_t;
 178
 179 /* Block size in atoms for the non-bonded thread force-buffer reduction,
 180  * should be a multiple of all cell and x86 SIMD sizes (i.e. 2, 4 and 8).
 181  * Should be small to reduce the reduction and zeroing cost,
 182  * but too small will result in overhead.
 183  * Currently the block size is NBNXN_BUFFERFLAG_SIZE*3*sizeof(real)=192 bytes.
 184  */
 185 #ifdef GMX_DOUBLE
 186 #define NBNXN_BUFFERFLAG_SIZE   8
 187 #else
 188 #define NBNXN_BUFFERFLAG_SIZE  16
 189 #endif
 190
 191 /* We currently store the reduction flags as bits in an unsigned int.
 192  * In most cases this limits the number of flags to 32.
 193  * The reduction will automatically disable the flagging and do a full
 194  * reduction when the flags won't fit, but this will lead to very slow
 195  * reduction. As we anyhow don't expect reasonable performance with
 196  * more than 32 threads, we put in this hard limit.
 197  * You can increase this number, but the reduction will be very slow.
 198  */
 199 #define NBNXN_BUFFERFLAG_MAX_THREADS  32
 200
 201 /* Flags for telling if threads write to force output buffers */
 202 typedef struct {
 203     int nflag;       /* The number of flag blocks                         */
 204     unsigned *flag;  /* Bit i is set when thread i writes to a cell-block */
 205     int flag_nalloc; /* Allocation size of cxy_flag                       */
 206 } nbnxn_buffer_flags_t;
 207
 208 /* LJ combination rules: geometric, Lorentz-Berthelot, none */
 209 enum { ljcrGEOM, ljcrLB, ljcrNONE, ljcrNR };
 210
 211 typedef struct {
 212     nbnxn_alloc_t *alloc;
 213     nbnxn_free_t  *free;
 214     int  ntype;      /* The number of different atom types                 */
 215     real *nbfp;      /* Lennard-Jones 6*C6 and 12*C12 params, size ntype^2*2 */
 216     int  comb_rule;  /* Combination rule, see enum above                   */
 217     real *nbfp_comb; /* LJ parameter per atom type, size ntype*2           */
 218     real *nbfp_s4;   /* As nbfp, but with stride 4, size ntype^2*4         */
 219     int  natoms;     /* Number of atoms                                    */
 220     int  natoms_local;  /* Number of local atoms                           */
 221     int  *type;      /* Atom types                                         */
 222     real *lj_comb;   /* LJ parameters per atom for combining for pairs     */
 223     int  XFormat;    /* The format of x (and q), enum                      */
 224     int  FFormat;    /* The format of f, enum                              */
 225     real *q;         /* Charges, can be NULL if incorporated in x          */
 226     int  na_c;       /* The number of atoms per cluster                    */
 227     int  nenergrp;   /* The number of energy groups                        */
 228     int  neg_2log;   /* Log2 of nenergrp                                   */
 229     int  *energrp;   /* The energy groups per cluster, can be NULL         */
 230     gmx_bool bDynamicBox; /* Do we need to update shift_vec every step?    */
 231     rvec *shift_vec; /* Shift vectors, copied from t_forcerec              */
 232     int  xstride;    /* stride for a coordinate in x (usually 3 or 4)      */
 233     int  fstride;    /* stride for a coordinate in f (usually 3 or 4)      */
 234     real *x;         /* x and possibly q, size natoms*xstride              */
 235     real *simd_4xn_diag;  /* indices to set the SIMD 4xN diagonal masks    */
 236     real *simd_2xnn_diag; /* indices to set the SIMD 2x(N+N)diagonal masks */
 237     int  nout;       /* The number of force arrays                         */
 238     nbnxn_atomdata_output_t *out;  /* Output data structures               */
 239     int  nalloc;     /* Allocation size of all arrays (for x/f *x/fstride) */
 240     gmx_bool bUseBufferFlags; /* Use the flags or operate on all atoms     */
 241     nbnxn_buffer_flags_t buffer_flags; /* Flags for buffer zeroing+reduc.  */
 242 } nbnxn_atomdata_t;
 243
 244 #ifdef __cplusplus
 245 }
 246 #endif
 247
 248 #endif