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 namespace gmx
  50 {
  51
  52 struct LocalTopologyChecker
  53 {
  54     /*! \brief Data to help check local topology construction
  55      *
  56      * Partitioning could incorrectly miss a bonded interaction.
  57      * However, checking for that requires a global communication
  58      * stage, which does not otherwise happen during partitioning. So,
  59      * for performance, we do that alongside the first global energy
  60      * reduction after a new DD is made. These variables handle
  61      * whether the check happens, its input for this domain, output
  62      * across all domains, and the expected value it should match. */
  63     /*! \{ */
  64     /*! \brief Number of bonded interactions found in the local
  65      * topology for this domain. */
  66     int numBondedInteractionsToReduce = 0;
  67     /*! \brief Whether to check at the next global communication
  68      * stage the total number of bonded interactions found.
  69      *
  70      * Cleared after that number is found. */
  71     bool shouldCheckNumberOfBondedInteractions = false;
  72     /*! \brief The total number of bonded interactions found in
  73      * the local topology across all domains.
  74      *
  75      * Only has a value after reduction across all ranks, which is
  76      * removed when it is again time to check after a new
  77      * partition. */
  78     std::optional<int> numBondedInteractionsOverAllDomains;
  79     /*! \} */
  80 };
  81
  82 } // namespace gmx
  83
  84 #endif