src/gromacs/domdec/computemultibodycutoffs.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2021, 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 /*! \libinternal \file
  36  *
  37  * \brief This file declares the function for computing the required
  38  * cutoff distance for inter-domain multi-body interactions, when
  39  * those exist.
  40  *
  41  * \inlibraryapi
  42  * \author Berk Hess <hess@kth.se>
  43  * \ingroup module_domdec
  44  */
  45
  46 #ifndef GMX_DOMDEC_COMPUTEMULTIBODYCUTOFFS_H
  47 #define GMX_DOMDEC_COMPUTEMULTIBODYCUTOFFS_H
  48
  49 #include "gromacs/math/vectypes.h"
  50
  51 struct gmx_mtop_t;
  52 struct t_inputrec;
  53
  54 namespace gmx
  55 {
  56 template<typename>
  57 class ArrayRef;
  58 class MDLogger;
  59 enum class DDBondedChecking : bool;
  60 } // namespace gmx
  61
  62 /*! \brief Calculate the maximum distance involved in 2-body and multi-body bonded interactions */
  63 void dd_bonded_cg_distance(const gmx::MDLogger&           mdlog,
  64                            const gmx_mtop_t&              mtop,
  65                            const t_inputrec&              ir,
  66                            gmx::ArrayRef<const gmx::RVec> x,
  67                            const matrix                   box,
  68                            gmx::DDBondedChecking          ddBondedChecking,
  69                            real*                          r_2b,
  70                            real*                          r_mb);
  71
  72 #endif