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