src/gromacs/nbnxm/pairlist_tuning.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,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 /*! \libinternal \file
  37  *
  38  * \brief Declares functions for tuning adjustable parameters for the nbnxn non-bonded search and interaction kernels
  39  *
  40  * \author Berk Hess <hess@kth.se>
  41  *
  42  * \inlibraryapi
  43  * \ingroup __module_nb_verlet
  44  */
  45
  46 #ifndef NBNXM_PAIRLIST_TUNING_H
  47 #define NBNXM_PAIRLIST_TUNING_H
  48
  49 #include <stdio.h>
  50
  51 #include "gromacs/math/vectypes.h"
  52
  53 namespace gmx
  54 {
  55 class CpuInfo;
  56 class MDLogger;
  57 }
  58
  59 struct gmx_mtop_t;
  60 struct interaction_const_t;
  61 struct PairlistParams;
  62 struct t_commrec;
  63 struct t_inputrec;
  64
  65 /*! \brief Try to increase nstlist when using the Verlet cut-off scheme
  66  *
  67  * \param[in,out] fplog    Log file
  68  * \param[in]     cr       The communication record
  69  * \param[in]     ir       The input parameter record
  70  * \param[in]     nstlistOnCmdline  The value of nstlist provided on the command line
  71  * \param[in]     mtop     The global topology
  72  * \param[in]     box      The unit cell
  73  * \param[in]     useOrEmulateGpuForNonbondeds  Tells if we are using a GPU for non-bondeds
  74  * \param[in]     cpuinfo  Information about the CPU(s)
  75  */
  76 void increaseNstlist(FILE *fplog, t_commrec *cr,
  77                      t_inputrec *ir, int nstlistOnCmdline,
  78                      const gmx_mtop_t *mtop,
  79                      const matrix box,
  80                      bool useOrEmulateGpuForNonbondeds,
  81                      const gmx::CpuInfo &cpuinfo);
  82
  83 /*! \brief Set up the dynamic pairlist pruning
  84  *
  85  * \param[in,out] mdlog            MD logger
  86  * \param[in]     ir               The input parameter record
  87  * \param[in]     mtop             The global topology
  88  * \param[in]     box              The unit cell
  89  * \param[in]     ic               The nonbonded interactions constants
  90  * \param[in,out] listParams       The list setup parameters
  91  */
  92 void setupDynamicPairlistPruning(const gmx::MDLogger       &mdlog,
  93                                  const t_inputrec          *ir,
  94                                  const gmx_mtop_t          *mtop,
  95                                  matrix                     box,
  96                                  const interaction_const_t *ic,
  97                                  PairlistParams            *listParams);
  98
  99 #endif /* NBNXM_PAIRLIST_TUNING_H */