src/gromacs/nbnxm/pairlistparams.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 PairlistParams class
  40  *
  41  * This class holds the Nbnxm pairlist parameters.
  42  *
  43  * \author Berk Hess <hess@kth.se>
  44  * \ingroup module_nbnxm
  45  */
  46
  47 #ifndef GMX_NBNXM_PAIRLISTPARAMS_H
  48 #define GMX_NBNXM_PAIRLISTPARAMS_H
  49
  50 #include "gromacs/utility/real.h"
  51
  52 #include "locality.h"
  53
  54 enum class PairlistType;
  55
  56 namespace Nbnxm
  57 {
  58 enum class KernelType;
  59 }
  60
  61
  62 /*! \internal
  63  * \brief The setup for generating and pruning the nbnxn pair list.
  64  *
  65  * Without dynamic pruning rlistOuter=rlistInner.
  66  */
  67 struct PairlistParams
  68 {
  69     /*! \brief Constructor producing a struct with dynamic pruning disabled
  70      */
  71     PairlistParams(Nbnxm::KernelType kernelType,
  72                    bool              haveFep,
  73                    real              rlist,
  74                    bool              haveMultipleDomains);
  75
  76     PairlistType pairlistType;           //!< The type of cluster-pair list
  77     bool         haveFep;                //!< Tells whether we have perturbed interactions
  78     real         rlistOuter;             //!< Cut-off of the larger, outer pair-list
  79     real         rlistInner;             //!< Cut-off of the smaller, inner pair-list
  80     bool         haveMultipleDomains;    //!< True when using DD with multiple domains
  81     bool         useDynamicPruning;      //!< Are we using dynamic pair-list pruning
  82     int          nstlistPrune;           //!< Pair-list dynamic pruning interval
  83     int          numRollingPruningParts; //!< The number parts to divide the pair-list into for rolling pruning, a value of 1 gives no rolling pruning
  84     int          lifetime;               //!< Lifetime in steps of the pair-list
  85 };
  86
  87 #endif