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 "gromacs/mdtypes/locality.h"
  53
  54 #include "pairlistparams.h"
  55
  56 struct nbnxn_atomdata_t;
  57 class PairlistSet;
  58 enum class PairlistType;
  59 class PairSearch;
  60 struct t_blocka;
  61 struct t_nrnb;
  62
  63
  64 class PairlistSets
  65 {
  66     public:
  67         PairlistSets(const PairlistParams &pairlistParams,
  68                      bool                  haveMultipleDomains,
  69                      int                   minimumIlistCountForGpuBalancing);
  70
  71         //! Construct the pairlist set for the given locality
  72         void construct(gmx::InteractionLocality    iLocality,
  73                        PairSearch                 *pairSearch,
  74                        nbnxn_atomdata_t           *nbat,
  75                        const t_blocka             *excl,
  76                        int64_t                     step,
  77                        t_nrnb                     *nrnb);
  78
  79         //! Dispatches the dynamic pruning kernel for the given locality
  80         void dispatchPruneKernel(gmx::InteractionLocality    iLocality,
  81                                  const nbnxn_atomdata_t     *nbat,
  82                                  const rvec                 *shift_vec);
  83
  84         //! Returns the pair list parameters
  85         const PairlistParams &params() const
  86         {
  87             return params_;
  88         }
  89
  90         //! Returns the number of steps performed with the current pair list
  91         int numStepsWithPairlist(int64_t step) const
  92         {
  93             return static_cast<int>(step - outerListCreationStep_);
  94         }
  95
  96         //! Returns whether step is a dynamic list pruning step, for CPU lists
  97         bool isDynamicPruningStepCpu(int64_t step) const
  98         {
  99             return (params_.useDynamicPruning &&
 100                     numStepsWithPairlist(step) % params_.nstlistPrune == 0);
 101         }
 102
 103         //! Returns whether step is a dynamic list pruning step, for GPU lists
 104         bool isDynamicPruningStepGpu(int64_t step) const
 105         {
 106             const int age = numStepsWithPairlist(step);
 107
 108             return (params_.useDynamicPruning &&
 109                     age > 0 &&
 110                     age < params_.lifetime &&
 111                     (params_.haveMultipleDomains || age % 2 == 0));
 112         }
 113
 114         //! Changes the pair-list outer and inner radius
 115         void changePairlistRadii(real rlistOuter,
 116                                  real rlistInner)
 117         {
 118             params_.rlistOuter = rlistOuter;
 119             params_.rlistInner = rlistInner;
 120         }
 121
 122         //! Returns the pair-list set for the given locality
 123         const PairlistSet &pairlistSet(gmx::InteractionLocality iLocality) const
 124         {
 125             if (iLocality == gmx::InteractionLocality::Local)
 126             {
 127                 return *localSet_;
 128             }
 129             else
 130             {
 131                 GMX_ASSERT(nonlocalSet_, "Need a non-local set when requesting access");
 132                 return *nonlocalSet_;
 133             }
 134         }
 135
 136     private:
 137         //! Returns the pair-list set for the given locality
 138         PairlistSet &pairlistSet(gmx::InteractionLocality iLocality)
 139         {
 140             if (iLocality == gmx::InteractionLocality::Local)
 141             {
 142                 return *localSet_;
 143             }
 144             else
 145             {
 146                 GMX_ASSERT(nonlocalSet_, "Need a non-local set when requesting access");
 147                 return *nonlocalSet_;
 148             }
 149         }
 150
 151         //! Parameters for the search and list pruning setup
 152         PairlistParams               params_;
 153         //! Pair list balancing parameter for use with GPU
 154         int                          minimumIlistCountForGpuBalancing_;
 155         //! Local pairlist set
 156         std::unique_ptr<PairlistSet> localSet_;
 157         //! Non-local pairlist set
 158         std::unique_ptr<PairlistSet> nonlocalSet_;
 159         //! MD step at with the outer lists in pairlistSets_ were created
 160         int64_t                      outerListCreationStep_;
 161 };
 162
 163 #endif