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