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,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 #ifndef GMX_NBNXM_NBNXM_GEOMETRY_H
  37 #define GMX_NBNXM_NBNXM_GEOMETRY_H
  38
  39 #include "gromacs/utility/fatalerror.h"
  40
  41 /* Returns the base-2 log of n.
  42  * Generates a fatal error when n is not an integer power of 2.
  43  */
  44 static inline int get_2log(int n)
  45 {
  46     int log2;
  47
  48     log2 = 0;
  49     while ((1 << log2) < n)
  50     {
  51         log2++;
  52     }
  53     if ((1 << log2) != n)
  54     {
  55         gmx_fatal(FARGS, "nbnxn na_c (%d) is not a power of 2", n);
  56     }
  57
  58     return log2;
  59 }
  60
  61 /* Returns the nbnxn i-cluster size in atoms for the nbnxn kernel type */
  62 int nbnxn_kernel_to_cluster_i_size(int nb_kernel_type);
  63
  64 /* Returns the nbnxn i-cluster size in atoms for the nbnxn kernel type */
  65 int nbnxn_kernel_to_cluster_j_size(int nb_kernel_type);
  66
  67 #endif