src/gromacs/applied_forces/awh/biassharing.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2019,2020,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
  36 /*! \internal \file
  37  *
  38  * \brief
  39  * Declares functions to check bias sharing properties.
  40  *
  41  * This actual sharing of biases is currently implemeted in BiasState.
  42  *
  43  * \author Berk Hess <hess@kth.se>
  44  * \ingroup module_awh
  45  */
  46
  47 #ifndef GMX_AWH_BIASSHARING_H
  48 #define GMX_AWH_BIASSHARING_H
  49
  50 #include <cstddef>
  51
  52 #include <vector>
  53
  54 struct gmx_multisim_t;
  55
  56 namespace gmx
  57 {
  58
  59 template<typename>
  60 class ArrayRef;
  61 struct AwhParams;
  62
  63 /*! \brief Returns if any bias is sharing within a simulation.
  64  *
  65  * \param[in] awhParams  The AWH parameters.
  66  */
  67 bool haveBiasSharingWithinSimulation(const AwhParams& awhParams);
  68
  69 /*! \brief Checks if biases are compatible for sharing between simulations, throws if not.
  70  *
  71  * Should be called simultaneously on the master rank of every simulation.
  72  * Note that this only checks for technical compatibility. It is up to
  73  * the user to check that the sharing physically makes sense.
  74  * Throws an exception when shared biases are not compatible.
  75  *
  76  * \param[in] awhParams     The AWH parameters.
  77  * \param[in] pointSize     Vector of grid-point sizes for each bias.
  78  * \param[in] multiSimComm  Struct for multi-simulation communication.
  79  */
  80 void biasesAreCompatibleForSharingBetweenSimulations(const AwhParams&       awhParams,
  81                                                      ArrayRef<const size_t> pointSize,
  82                                                      const gmx_multisim_t*  multiSimComm);
  83
  84 } // namespace gmx
  85
  86 #endif /* GMX_AWH_BIASSHARING_H */