src/gromacs/nbnxm/pairlistset.cpp

   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 /*! \internal \file
  37  * \brief
  38  * Implements functionality for nbnxn_pairlist_set_t.
  39  *
  40  * \author Berk Hess <hess@kth.se>
  41  * \ingroup module_nbnxm
  42  */
  43
  44 #include "gmxpre.h"
  45
  46 #include "pairlistset.h"
  47
  48 #include "gromacs/nbnxm/nbnxm.h"
  49 #include "gromacs/nbnxm/nbnxm_geometry.h"
  50 #include "gromacs/nbnxm/pairlist.h"
  51 #include "gromacs/utility/gmxassert.h"
  52
  53 /*! \cond INTERNAL */
  54
  55 NbnxnListParameters::NbnxnListParameters(const Nbnxm::KernelType kernelType,
  56                                          const real              rlist) :
  57     useDynamicPruning(false),
  58     nstlistPrune(-1),
  59     rlistOuter(rlist),
  60     rlistInner(rlist),
  61     numRollingParts(1)
  62 {
  63     if (!Nbnxm::kernelTypeUsesSimplePairlist(kernelType))
  64     {
  65         pairlistType = PairlistType::Hierarchical8x8;
  66     }
  67     else
  68     {
  69         switch (Nbnxm::JClusterSizePerKernelType[kernelType])
  70         {
  71             case 2:
  72                 pairlistType = PairlistType::Simple4x2;
  73                 break;
  74             case 4:
  75                 pairlistType = PairlistType::Simple4x4;
  76                 break;
  77             case 8:
  78                 pairlistType = PairlistType::Simple4x8;
  79                 break;
  80             default:
  81                 GMX_RELEASE_ASSERT(false, "Kernel type does not have a pairlist type");
  82         }
  83     }
  84 }
  85
  86 nbnxn_pairlist_set_t::nbnxn_pairlist_set_t(const NbnxnListParameters &listParams) :
  87     params(listParams)
  88 {
  89     // TODO move this into this constructor
  90     nbnxn_init_pairlist_set(this);
  91 }
  92
  93 int nbnxnNumStepsWithPairlist(const nonbonded_verlet_t         &nbv,
  94                               const Nbnxm::InteractionLocality  iLocality,
  95                               const int64_t                     step)
  96 {
  97     return step - nbv.pairlistSet(iLocality).outerListCreationStep;
  98 }
  99
 100 bool nbnxnIsDynamicPairlistPruningStep(const nonbonded_verlet_t         &nbv,
 101                                        const Nbnxm::InteractionLocality  iLocality,
 102                                        const int64_t                     step)
 103 {
 104     return nbnxnNumStepsWithPairlist(nbv, iLocality, step) % nbv.listParams->nstlistPrune == 0;
 105 }
 106
 107 /*! \endcond */