src/gromacs/domdec/ga2la.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \internal \file
  36  * \brief
  37  * Implements functions for mapping from global to local atom indices.
  38  *
  39  * \ingroup module_domdec
  40  *
  41  * \author Berk Hess <hess@kth.se>
  42  */
  43
  44 #include "gmxpre.h"
  45
  46 #include "ga2la.h"
  47
  48 /*! \brief Returns whether to use a direct list only
  49  *
  50  * There are two methods implemented for finding the local atom number
  51  * belonging to a global atom number:
  52  * 1) a simple, direct array
  53  * 2) a hash table consisting of list of linked lists indexed with
  54  *    the global number modulo mod.
  55  * Memory requirements:
  56  * 1) numAtomsTotal*2 ints
  57  * 2) numAtomsLocal*(2+1-2(1-e^-1/2))*4 ints
  58  * where numAtomsLocal is the number of atoms in the home + communicated zones.
  59  * Method 1 is faster for low parallelization, 2 for high parallelization.
  60  * We switch to method 2 when it uses less than half the memory method 1.
  61  */
  62 static bool directListIsFaster(int numAtomsTotal, int numAtomsLocal)
  63 {
  64     constexpr int c_numAtomsSmallRelativeToCache  = 1024;
  65     constexpr int c_memoryRatioHashedVersusDirect = 9;
  66
  67     return (numAtomsTotal <= c_numAtomsSmallRelativeToCache
  68             || numAtomsTotal <= numAtomsLocal * c_memoryRatioHashedVersusDirect);
  69 }
  70
  71 gmx_ga2la_t::gmx_ga2la_t(int numAtomsTotal, int numAtomsLocal) :
  72     usingDirect_(directListIsFaster(numAtomsTotal, numAtomsLocal))
  73 {
  74     if (usingDirect_)
  75     {
  76         new (&(data_.direct)) std::vector<Entry>(numAtomsTotal, { -1, -1 });
  77     }
  78     else
  79     {
  80         new (&(data_.hashed)) gmx::HashedMap<Entry>(numAtomsLocal);
  81     }
  82 }