41a3e15f707acd86075beaa60f05f68b29a78960
[alexxy/gromacs.git] / src / gromacs / nbnxm / constants.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2012,2013,2014,2015,2016 by the GROMACS development team.
5  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
7  * and including many others, as listed in the AUTHORS file in the
8  * top-level source directory and at http://www.gromacs.org.
9  *
10  * GROMACS is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public License
12  * as published by the Free Software Foundation; either version 2.1
13  * of the License, or (at your option) any later version.
14  *
15  * GROMACS is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with GROMACS; if not, see
22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
24  *
25  * If you want to redistribute modifications to GROMACS, please
26  * consider that scientific software is very special. Version
27  * control is crucial - bugs must be traceable. We will be happy to
28  * consider code for inclusion in the official distribution, but
29  * derived work must not be called official GROMACS. Details are found
30  * in the README & COPYING files - if they are missing, get the
31  * official version at http://www.gromacs.org.
32  *
33  * To help us fund GROMACS development, we humbly ask that you cite
34  * the research papers on the package. Check out http://www.gromacs.org.
35  */
36
37 /*! \internal \file
38  *
39  * \brief
40  * Declares constants for the module
41  *
42  * \author Berk Hess <hess@kth.se>
43  * \ingroup module_nbnxm
44  */
45
46 #ifndef GMX_NBNXN_CONSTANTS_H
47 #define GMX_NBNXN_CONSTANTS_H
48
49 /*! \brief Lower limit for square interaction distances in nonbonded kernels.
50  *
51  * For smaller values we will overflow when calculating r^-1 or r^-12, but
52  * to keep it simple we always apply the limit from the tougher r^-12 condition.
53  */
54 #if GMX_DOUBLE
55 // Some double precision SIMD architectures use single precision in the first
56 // step, so although the double precision criterion would allow smaller rsq,
57 // we need to stay in single precision with some margin for the N-R iterations.
58 #    define NBNXN_MIN_RSQ 1.0e-36
59 #else
60 // The worst intermediate value we might evaluate is r^-12, which
61 // means we should ensure r^2 stays above pow(GMX_FLOAT_MAX,-1.0/6.0)*1.01 (some margin)
62 #    define NBNXN_MIN_RSQ 3.82e-07f // r > 6.2e-4
63 #endif
64
65
66 //! The number of clusters in a super-cluster, used for GPU
67 #define c_nbnxnGpuNumClusterPerSupercluster 8
68
69 /*! \brief With GPU kernels we group cluster pairs in 4 to optimize memory usage
70  * of integers containing 32 bits.
71  */
72 #define c_nbnxnGpuJgroupSize (32 / c_nbnxnGpuNumClusterPerSupercluster)
73
74 #endif