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