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 /*! Nonbonded NxN kernel types: plain C, SSE/AVX, GPU CUDA, GPU emulation, etc */
  47 enum { nbkNotSet = 0,
  48        nbk4x4_PlainC,
  49        nbk4xN_X86_SIMD128,
  50        nbk4xN_X86_SIMD256,
  51        nbk8x8x8_CUDA,
  52        nbk8x8x8_PlainC };
  53
  54 enum { ewaldexclTable, ewaldexclAnalytical };
  55
  56 /* Atom locality indicator: local, non-local, all, used for calls to:
  57    gridding, pair-search, force calculation, x/f buffer operations */
  58 enum { eatLocal = 0, eatNonlocal = 1, eatAll  };
  59
  60 #define LOCAL_A(x)               ((x) == eatLocal)
  61 #define NONLOCAL_A(x)            ((x) == eatNonlocal)
  62 #define LOCAL_OR_NONLOCAL_A(x)   (LOCAL_A(x) || NONLOCAL_A(x))
  63
  64 /* Interaction locality indicator (used in pair-list search/calculations):
  65     - local interactions require local atom data and affect local output only;
  66     - non-local interactions require both local and non-local atom data and
  67       affect both local- and non-local output. */
  68 enum { eintLocal = 0, eintNonlocal = 1 };
  69
  70 #define LOCAL_I(x)               ((x) == eintLocal)
  71 #define NONLOCAL_I(x)            ((x) == eintNonlocal)
  72
  73 enum { enbvClearFNo, enbvClearFYes };
  74
  75 typedef struct {
  76     nbnxn_pairlist_set_t nbl_lists;   /* pair list(s)                       */
  77     nbnxn_atomdata_t     *nbat;       /* atom data                          */
  78     int                  kernel_type; /* non-bonded kernel - see enum above */
  79     int                  ewald_excl;  /* Ewald exclusion - see enum above   */
  80 } nonbonded_verlet_group_t;
  81
  82 /* non-bonded data structure with Verlet-type cut-off */
  83 typedef struct {
  84     nbnxn_search_t           nbs;   /* n vs n atom pair searching data          */
  85     int                      ngrp;  /* number of interaction groups             */
  86     nonbonded_verlet_group_t grp[2];/* local and non-local interaction group    */
  87
  88     gmx_bool         bUseGPU;          /* TRUE when GPU acceleration is used */
  89     nbnxn_cuda_ptr_t cu_nbv;           /* pointer to CUDA nb verlet data     */
  90     int              min_ci_balanced;  /* pair list balancing parameter
  91                                           used for the 8x8x8 CUDA kernels    */
  92 } nonbonded_verlet_t;
  93
  94 #ifdef __cplusplus
  95 }
  96 #endif
  97
  98 #endif /* NB_VERLET_H */