c164034c790106afd67036eeb5b3c510914cef56
[alexxy/gromacs.git] / src / gromacs / nbnxm / nbnxm_geometry.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2012,2013,2014,2015,2016,2017,2018,2019, 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 #include "gmxpre.h"
37
38 #include "nbnxm_geometry.h"
39
40 #include "gromacs/nbnxm/nbnxm.h"
41 #include "gromacs/nbnxm/pairlist.h"
42 #include "gromacs/utility/fatalerror.h"
43 #include "gromacs/utility/real.h"
44
45 /* Clusters at the cut-off only increase rlist by 60% of their size */
46 static constexpr real c_nbnxnRlistIncreaseOutsideFactor = 0.6;
47
48 real nbnxn_get_rlist_effective_inc(const int  jClusterSize,
49                                    const real atomDensity)
50 {
51     /* We should get this from the setup, but currently it's the same for
52      * all setups, including GPUs.
53      */
54     const real iClusterSize    = c_nbnxnCpuIClusterSize;
55
56     const real iVolumeIncrease = (iClusterSize - 1)/atomDensity;
57     const real jVolumeIncrease = (jClusterSize - 1)/atomDensity;
58
59     return c_nbnxnRlistIncreaseOutsideFactor*std::cbrt(iVolumeIncrease +
60                                                        jVolumeIncrease);
61 }
62
63 real nbnxn_get_rlist_effective_inc(const int        clusterSize,
64                                    const gmx::RVec &averageClusterBoundingBox)
65 {
66     /* The average length of the diagonal of a sub cell */
67     const real diagonal    = std::sqrt(norm2(averageClusterBoundingBox));
68
69     const real volumeRatio = (clusterSize - 1.0_real)/clusterSize;
70
71     return c_nbnxnRlistIncreaseOutsideFactor*gmx::square(volumeRatio)*0.5_real*diagonal;
72 }