src/gromacs/domdec/localtopologychecker.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 functionality for checking whether
  38  * local topologies describe all bonded interactions.
  39  *
  40  * \inlibraryapi
  41  * \ingroup module_domdec
  42  */
  43
  44 #ifndef GMX_DOMDEC_LOCALTOPOLOGYCHECKER_H
  45 #define GMX_DOMDEC_LOCALTOPOLOGYCHECKER_H
  46
  47 #include <optional>
  48
  49 #include "gromacs/math/vectypes.h"
  50
  51 struct gmx_domdec_t;
  52 struct gmx_localtop_t;
  53 struct gmx_mtop_t;
  54 struct t_commrec;
  55 struct t_inputrec;
  56
  57 namespace gmx
  58 {
  59 class MDLogger;
  60 template<typename>
  61 class ArrayRef;
  62 enum class DDBondedChecking : bool;
  63 } // namespace gmx
  64
  65 namespace gmx
  66 {
  67
  68 struct LocalTopologyChecker
  69 {
  70 public:
  71     /*! \brief Data to help check local topology construction
  72      *
  73      * Partitioning could incorrectly miss a bonded interaction.
  74      * However, checking for that requires a global communication
  75      * stage, which does not otherwise happen during partitioning. So,
  76      * for performance, we do that alongside the first global energy
  77      * reduction after a new DD is made. These variables handle
  78      * whether the check happens, its input for this domain, output
  79      * across all domains, and the expected value it should match. */
  80     /*! \{ */
  81     /*! \brief Number of bonded interactions found in the local
  82      * topology for this domain. */
  83     int numBondedInteractionsToReduce = 0;
  84     /*! \brief Whether to check at the next global communication
  85      * stage the total number of bonded interactions found.
  86      *
  87      * Cleared after that number is found. */
  88     bool shouldCheckNumberOfBondedInteractions = false;
  89     /*! \brief The total number of bonded interactions found in
  90      * the local topology across all domains.
  91      *
  92      * Only has a value after reduction across all ranks, which is
  93      * removed when it is again time to check after a new
  94      * partition. */
  95     std::optional<int> numBondedInteractionsOverAllDomains;
  96     /*! \} */
  97 };
  98
  99 } // namespace gmx
 100
 101 //! Set that the local topology should be checked via observables reduction
 102 void scheduleCheckOfLocalTopology(gmx_domdec_t* dd, int numBondedInteractionsToReduce);
 103
 104 /*! \brief Return whether the total bonded interaction count across
 105  * domains should be checked in observables reduction. */
 106 bool shouldCheckNumberOfBondedInteractions(const gmx_domdec_t& dd);
 107
 108 //! Return the number of bonded interactions in this domain.
 109 int numBondedInteractions(const gmx_domdec_t& dd);
 110
 111 /*! \brief Set total bonded interaction count across domains. */
 112 void setNumberOfBondedInteractionsOverAllDomains(gmx_domdec_t* dd, int newValue);
 113
 114 /*! \brief Check whether bonded interactions are missing from the reverse topology
 115  * produced by domain decomposition.
 116  *
 117  * Must only be called when DD is active.
 118  *
 119  * \param[in]    mdlog                                  Logger
 120  * \param[in]    cr                                     Communication object
 121  * \param[in]    top_global                             Global topology for the error message
 122  * \param[in]    top_local                              Local topology for the error message
 123  * \param[in]    x                                      Position vector for the error message
 124  * \param[in]    box                                    Box matrix for the error message
 125  */
 126 void checkNumberOfBondedInteractions(const gmx::MDLogger&           mdlog,
 127                                      t_commrec*                     cr,
 128                                      const gmx_mtop_t&              top_global,
 129                                      const gmx_localtop_t*          top_local,
 130                                      gmx::ArrayRef<const gmx::RVec> x,
 131                                      const matrix                   box);
 132
 133 #endif