src/gromacs/mdlib/nbnxn_cuda/nbnxn_cuda.h

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