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