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