src/gromacs/nbnxm/pairlistsets.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,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  *
  38  * \brief
  39  * Declares the PairlistSets class
  40  *
  41  * This class holds the local and non-local pairlist sets.
  42  *
  43  * \author Berk Hess <hess@kth.se>
  44  * \ingroup module_nbnxm
  45  */
  46
  47 #ifndef GMX_NBNXM_PAIRLISTSETS_H
  48 #define GMX_NBNXM_PAIRLISTSETS_H
  49
  50 #include <memory>
  51
  52 #include "locality.h"
  53 #include "pairlistparams.h"
  54
  55 struct nbnxn_atomdata_t;
  56 class PairlistSet;
  57 enum class PairlistType;
  58 class PairSearch;
  59 struct t_blocka;
  60 struct t_nrnb;
  61
  62 namespace Nbnxm
  63 {
  64 enum class KernelType;
  65 }
  66
  67
  68 class PairlistSets
  69 {
  70     public:
  71         PairlistSets(const PairlistParams &pairlistParams,
  72                      bool                  haveMultipleDomains,
  73                      int                   minimumIlistCountForGpuBalancing);
  74
  75         //! Construct the pairlist set for the given locality
  76         void construct(Nbnxm::InteractionLocality  iLocality,
  77                        PairSearch                 *pairSearch,
  78                        nbnxn_atomdata_t           *nbat,
  79                        const t_blocka             *excl,
  80                        Nbnxm::KernelType           kernelbType,
  81                        int64_t                     step,
  82                        t_nrnb                     *nrnb);
  83
  84         //! Dispatches the dynamic pruning kernel for the given locality
  85         void dispatchPruneKernel(Nbnxm::InteractionLocality  iLocality,
  86                                  const nbnxn_atomdata_t     *nbat,
  87                                  const rvec                 *shift_vec,
  88                                  Nbnxm::KernelType           kernelType);
  89
  90         //! Returns the pair list parameters
  91         const PairlistParams &params() const
  92         {
  93             return params_;
  94         }
  95
  96         //! Returns the number of steps performed with the current pair list
  97         int numStepsWithPairlist(int64_t step) const
  98         {
  99             return step - outerListCreationStep_;
 100         }
 101
 102         //! Returns whether step is a dynamic list pruning step, for CPU lists
 103         bool isDynamicPruningStepCpu(int64_t step) const
 104         {
 105             return (params_.useDynamicPruning &&
 106                     numStepsWithPairlist(step) % params_.nstlistPrune == 0);
 107         }
 108
 109         //! Returns whether step is a dynamic list pruning step, for GPU lists
 110         bool isDynamicPruningStepGpu(int64_t step) const
 111         {
 112             const int age = numStepsWithPairlist(step);
 113
 114             return (params_.useDynamicPruning &&
 115                     age > 0 &&
 116                     age < params_.lifetime &&
 117                     (params_.haveMultipleDomains || age % 2 == 0));
 118         }
 119
 120         //! Changes the pair-list outer and inner radius
 121         void changePairlistRadii(real rlistOuter,
 122                                  real rlistInner)
 123         {
 124             params_.rlistOuter = rlistOuter;
 125             params_.rlistInner = rlistInner;
 126         }
 127
 128         //! Returns the pair-list set for the given locality
 129         const PairlistSet &pairlistSet(Nbnxm::InteractionLocality iLocality) const
 130         {
 131             if (iLocality == Nbnxm::InteractionLocality::Local)
 132             {
 133                 return *localSet_;
 134             }
 135             else
 136             {
 137                 GMX_ASSERT(nonlocalSet_, "Need a non-local set when requesting access");
 138                 return *nonlocalSet_;
 139             }
 140         }
 141
 142     private:
 143         //! Returns the pair-list set for the given locality
 144         PairlistSet &pairlistSet(Nbnxm::InteractionLocality iLocality)
 145         {
 146             if (iLocality == Nbnxm::InteractionLocality::Local)
 147             {
 148                 return *localSet_;
 149             }
 150             else
 151             {
 152                 GMX_ASSERT(nonlocalSet_, "Need a non-local set when requesting access");
 153                 return *nonlocalSet_;
 154             }
 155         }
 156
 157         //! Parameters for the search and list pruning setup
 158         PairlistParams               params_;
 159         //! Pair list balancing parameter for use with GPU
 160         int                          minimumIlistCountForGpuBalancing_;
 161         //! Local pairlist set
 162         std::unique_ptr<PairlistSet> localSet_;
 163         //! Non-local pairlist set
 164         std::unique_ptr<PairlistSet> nonlocalSet_;
 165         //! MD step at with the outer lists in pairlistSets_ were created
 166         int64_t                      outerListCreationStep_;
 167 };
 168
 169 #endif