src/gromacs/nbnxm/nbnxm_geometry.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) 2017,2018,2019,2020,2021, 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 /*! \internal \file
  37  *
  38  * \brief
  39  * Declares the geometry-related functionality
  40  *
  41  * \author Berk Hess <hess@kth.se>
  42  * \ingroup module_nbnxm
  43  */
  44 #ifndef GMX_NBNXM_NBNXM_GEOMETRY_H
  45 #define GMX_NBNXM_NBNXM_GEOMETRY_H
  46
  47 #include "gromacs/math/vectypes.h"
  48 #include "gromacs/nbnxm/nbnxm.h"
  49 #include "gromacs/simd/simd.h"
  50 #include "gromacs/utility/fatalerror.h"
  51
  52 #include "pairlist.h"
  53
  54
  55 /*! \brief Returns the base-2 log of n.
  56  * *
  57  * Generates a fatal error when n is not an integer power of 2.
  58  */
  59 static inline int get_2log(int n)
  60 {
  61     if (!gmx::isPowerOfTwo(n))
  62     {
  63         gmx_fatal(FARGS, "nbnxn na_c (%d) is not a power of 2", n);
  64     }
  65
  66     return gmx::log2I(n);
  67 }
  68
  69 namespace Nbnxm
  70 {
  71
  72 /*! \brief The nbnxn i-cluster size in atoms for each nbnxn kernel type */
  73 static constexpr gmx::EnumerationArray<KernelType, int> IClusterSizePerKernelType = {
  74     { 0, c_nbnxnCpuIClusterSize, c_nbnxnCpuIClusterSize, c_nbnxnCpuIClusterSize, c_nbnxnGpuClusterSize, c_nbnxnGpuClusterSize }
  75 };
  76
  77 /*! \brief The nbnxn j-cluster size in atoms for each nbnxn kernel type */
  78 static constexpr gmx::EnumerationArray<KernelType, int> JClusterSizePerKernelType = {
  79     { 0,
  80       c_nbnxnCpuIClusterSize,
  81 #if GMX_SIMD
  82       GMX_SIMD_REAL_WIDTH,
  83       GMX_SIMD_REAL_WIDTH / 2,
  84 #else
  85       0,
  86       0,
  87 #endif
  88       c_nbnxnGpuClusterSize,
  89       c_nbnxnGpuClusterSize / 2 }
  90 };
  91
  92 /*! \brief Returns whether the pair-list corresponding to nb_kernel_type is simple */
  93 static inline bool kernelTypeUsesSimplePairlist(const KernelType kernelType)
  94 {
  95     return (kernelType == KernelType::Cpu4x4_PlainC || kernelType == KernelType::Cpu4xN_Simd_4xN
  96             || kernelType == KernelType::Cpu4xN_Simd_2xNN);
  97 }
  98
  99 //! Returns whether a SIMD kernel is in use
 100 static inline bool kernelTypeIsSimd(const KernelType kernelType)
 101 {
 102     return (kernelType == KernelType::Cpu4xN_Simd_4xN || kernelType == KernelType::Cpu4xN_Simd_2xNN);
 103 }
 104
 105 } // namespace Nbnxm
 106
 107 /*! \brief Returns the effective list radius of the pair-list
 108  *
 109  * Due to the cluster size the effective pair-list is longer than
 110  * that of a simple atom pair-list. This function gives the extra distance.
 111  *
 112  * NOTE: If the i- and j-cluster sizes are identical and you know
 113  *       the physical dimensions of the clusters, use the next function
 114  *       for more accurate results
 115  */
 116 real nbnxn_get_rlist_effective_inc(int jClusterSize, real atomDensity);
 117
 118 /*! \brief Returns the effective list radius of the pair-list
 119  *
 120  * Due to the cluster size the effective pair-list is longer than
 121  * that of a simple atom pair-list. This function gives the extra distance.
 122  */
 123 real nbnxn_get_rlist_effective_inc(int clusterSize, const gmx::RVec& averageClusterBoundingBox);
 124
 125 #endif