src/gromacs/nbnxm/boundingboxes.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \internal \file
  37  *
  38  * \brief Declares constants and helper functions used when handling
  39  * bounding boxes for clusters of particles.
  40  *
  41  * \author Berk Hess <hess@kth.se>
  42  * \ingroup module_nbnxm
  43  */
  44
  45 #ifndef GMX_NBNXM_BOUNDINGBOXES_H
  46 #define GMX_NBNXM_BOUNDINGBOXES_H
  47
  48 #include "gromacs/simd/simd.h"
  49
  50 namespace Nbnxm
  51 {
  52
  53 /*! \brief The number of bounds along one dimension of a bounding box */
  54 static constexpr int c_numBoundingBoxBounds1D = 2;
  55
  56 } // namespace Nbnxm
  57
  58 #ifndef DOXYGEN
  59
  60 /* Bounding box calculations are (currently) always in single precision, so
  61  * we only need to check for single precision support here.
  62  * This uses less (cache-)memory and SIMD is faster, at least on x86.
  63  */
  64 #if GMX_SIMD4_HAVE_FLOAT
  65 #    define NBNXN_SEARCH_BB_SIMD4      1
  66 #else
  67 #    define NBNXN_SEARCH_BB_SIMD4      0
  68 #endif
  69
  70
  71 #if NBNXN_SEARCH_BB_SIMD4
  72 /* Always use 4-wide SIMD for bounding box calculations */
  73
  74 #    if !GMX_DOUBLE
  75 /* Single precision BBs + coordinates, we can also load coordinates with SIMD */
  76 #        define NBNXN_SEARCH_SIMD4_FLOAT_X_BB  1
  77 #    else
  78 #        define NBNXN_SEARCH_SIMD4_FLOAT_X_BB  0
  79 #    endif
  80
  81 /* Store bounding boxes corners as quadruplets: xxxxyyyyzzzz
  82  *
  83  * The packed bounding box coordinate stride is always set to 4.
  84  * With AVX we could use 8, but that turns out not to be faster.
  85  */
  86 #    define NBNXN_BBXXXX  1
  87
  88 //! The number of bounding boxes in a pack, also the size of a pack along one dimension
  89 static constexpr int c_packedBoundingBoxesDimSize = GMX_SIMD4_WIDTH;
  90
  91 //! Total number of corners (floats) in a pack of bounding boxes
  92 static constexpr int c_packedBoundingBoxesSize    =
  93     c_packedBoundingBoxesDimSize*DIM*Nbnxm::c_numBoundingBoxBounds1D;
  94
  95 //! Returns the starting index of the bounding box pack that contains the given cluster
  96 static constexpr inline int packedBoundingBoxesIndex(int clusterIndex)
  97 {
  98     return (clusterIndex/c_packedBoundingBoxesDimSize)*c_packedBoundingBoxesSize;
  99 }
 100
 101 #else  /* NBNXN_SEARCH_BB_SIMD4 */
 102
 103 #    define NBNXN_SEARCH_SIMD4_FLOAT_X_BB  0
 104 #    define NBNXN_BBXXXX                   0
 105
 106 #endif /* NBNXN_SEARCH_BB_SIMD4 */
 107
 108 #endif // !DOXYGEN
 109
 110 #endif