src/mdlib/nbnxn_cuda/nbnxn_cuda.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, 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 NBNXN_CUDA_H
  40 #define NBNXN_CUDA_H
  41
  42 #include "types/nbnxn_cuda_types_ext.h"
  43
  44 #ifdef GMX_GPU
  45 #define FUNC_TERM ;
  46 #else
  47 #define FUNC_TERM {}
  48 #endif
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 /*! Launch asynchronously the nonbonded force calculations.
  55  *  This consists of the following (async) steps launched:
  56  *  - upload x and q;
  57  *  - upload shift vector;
  58  *  - launch kernel;
  59  *  The local and non-local interaction calculations are launched in two
  60  *  separate streams.
  61  */
  62 void nbnxn_cuda_launch_kernel(nbnxn_cuda_ptr_t cu_nb,
  63                               const nbnxn_atomdata_t *nbdata,
  64                               int flags,
  65                               int iloc) FUNC_TERM
  66
  67 /*! Launch asynchronously the download of nonbonded forces from the GPU
  68  *  (and energies/shift forces if required).
  69  */
  70 void nbnxn_cuda_launch_cpyback(nbnxn_cuda_ptr_t cu_nb,
  71                                const nbnxn_atomdata_t *nbatom,
  72                                int flags,
  73                                int aloc) FUNC_TERM
  74
  75 /*! Wait for the asynchronously launched nonbonded calculations and data
  76  *  transfers to finish.
  77  */
  78 void nbnxn_cuda_wait_gpu(nbnxn_cuda_ptr_t cu_nb,
  79                          const nbnxn_atomdata_t * nbatom,
  80                          int flags, int aloc,
  81                          real *e_lj, real *e_el,
  82                          rvec *fshift) FUNC_TERM
  83
  84 #ifdef __cplusplus
  85 }
  86 #endif
  87
  88 #undef FUNC_TERM
  89
  90 #endif /* NBNXN_CUDA_H */