src/gromacs/legacyheaders/types/nb_verlet.h

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