include/types/nb_verlet.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 NB_VERLET_H
  40 #define NB_VERLET_H
  41
  42 #include "nbnxn_pairlist.h"
  43 #include "nbnxn_cuda_types_ext.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49
  50 /* For testing the reference plain-C SIMD kernels, uncomment the next lines,
  51  * as well as the GMX_SIMD_REFERENCE_PLAIN_C define in gmx_simd_macros.h
  52  * The actual SIMD width is set in gmx_simd_macros.h
  53  * The 4xN reference kernels support 2-, 4- and 8-way SIMD.
  54  * The 2x(N+N) reference kernels support 8- and 16-way SIMD.
  55  */
  56 /* #define GMX_NBNXN_SIMD */
  57 /* #define GMX_NBNXN_SIMD_4XN */
  58 /* #define GMX_NBNXN_SIMD_2XNN */
  59
  60
  61 #ifdef GMX_X86_SSE2
  62 /* Use SIMD accelerated nbnxn search and kernels */
  63 #define GMX_NBNXN_SIMD
  64
  65 /* Uncomment the next line to use, slower, 128-bit SIMD with AVX-256 */
  66 /* #define GMX_NBNXN_HALF_WIDTH_SIMD */
  67
  68 /* The nbnxn SIMD 4xN and 2x(N+N) kernels can be added independently.
  69  * Currently the 2xNN SIMD kernels only make sense with:
  70  *  8-way SIMD: 4x4 setup, works with AVX-256 in single precision
  71  * 16-way SIMD: 4x8 setup, not used, but most of the kernel code is there
  72  */
  73 #define GMX_NBNXN_SIMD_4XN
  74 #if defined GMX_X86_AVX_256 && !(defined GMX_DOUBLE || defined GMX_NBNXN_HALF_WIDTH_SIMD)
  75 #define GMX_NBNXN_SIMD_2XNN
  76 #endif
  77
  78 #endif
  79
  80
  81 /*! Nonbonded NxN kernel types: plain C, CPU SIMD, GPU CUDA, GPU emulation */
  82 typedef enum
  83 {
  84     nbnxnkNotSet = 0,
  85     nbnxnk4x4_PlainC,
  86     nbnxnk4xN_SIMD_4xN,
  87     nbnxnk4xN_SIMD_2xNN,
  88     nbnxnk8x8x8_CUDA,
  89     nbnxnk8x8x8_PlainC,
  90     nbnxnkNR
  91 } nbnxn_kernel_type;
  92
  93 /*! Return a string indentifying the kernel type */
  94 const char *lookup_nbnxn_kernel_name(int kernel_type);
  95
  96 enum {
  97     ewaldexclTable, ewaldexclAnalytical
  98 };
  99
 100 /* Atom locality indicator: local, non-local, all, used for calls to:
 101    gridding, pair-search, force calculation, x/f buffer operations */
 102 enum {
 103     eatLocal = 0, eatNonlocal = 1, eatAll
 104 };
 105
 106 #define LOCAL_A(x)               ((x) == eatLocal)
 107 #define NONLOCAL_A(x)            ((x) == eatNonlocal)
 108 #define LOCAL_OR_NONLOCAL_A(x)   (LOCAL_A(x) || NONLOCAL_A(x))
 109
 110 /* Interaction locality indicator (used in pair-list search/calculations):
 111     - local interactions require local atom data and affect local output only;
 112     - non-local interactions require both local and non-local atom data and
 113       affect both local- and non-local output. */
 114 enum {
 115     eintLocal = 0, eintNonlocal = 1
 116 };
 117
 118 #define LOCAL_I(x)               ((x) == eintLocal)
 119 #define NONLOCAL_I(x)            ((x) == eintNonlocal)
 120
 121 enum {
 122     enbvClearFNo, enbvClearFYes
 123 };
 124
 125 typedef struct {
 126     nbnxn_pairlist_set_t  nbl_lists;   /* pair list(s)                       */
 127     nbnxn_atomdata_t     *nbat;        /* atom data                          */
 128     int                   kernel_type; /* non-bonded kernel - see enum above */
 129     int                   ewald_excl;  /* Ewald exclusion - see enum above   */
 130 } nonbonded_verlet_group_t;
 131
 132 /* non-bonded data structure with Verlet-type cut-off */
 133 typedef struct {
 134     nbnxn_search_t           nbs;             /* n vs n atom pair searching data       */
 135     int                      ngrp;            /* number of interaction groups          */
 136     nonbonded_verlet_group_t grp[2];          /* local and non-local interaction group */
 137
 138     gmx_bool                 bUseGPU;         /* TRUE when GPU acceleration is used */
 139     nbnxn_cuda_ptr_t         cu_nbv;          /* pointer to CUDA nb verlet data     */
 140     int                      min_ci_balanced; /* pair list balancing parameter
 141                                                  used for the 8x8x8 CUDA kernels    */
 142 } nonbonded_verlet_t;
 143
 144 #ifdef __cplusplus
 145 }
 146 #endif
 147
 148 #endif /* NB_VERLET_H */