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 <memory>
  48
  49 #include "gromacs/math/vectypes.h"
  50
  51 struct gmx_localtop_t;
  52 struct gmx_mtop_t;
  53 struct t_commrec;
  54 struct t_inputrec;
  55 class t_state;
  56
  57 namespace gmx
  58 {
  59 class MDLogger;
  60 class ObservablesReducerBuilder;
  61 } // namespace gmx
  62
  63 namespace gmx
  64 {
  65
  66 /*! \libinternal
  67  * \brief Has responsibility for checking that the local topology distributed
  68  * across domains describes a total number of bonded interactions that matches
  69  * the system topology
  70  *
  71  * This uses the ObservablesReducer framework to check that the count
  72  * of bonded interactions in the local topology made for each domain
  73  * sums to the expected value. Because this check is not urgent, the
  74  * communication that it requires is done at the next opportunity,
  75  * rather than requiring extra communication. If the check fails, a
  76  * fatal error stops execution. In principle, if there was a bug,
  77  * GROMACS might crash in the meantime because of the wrong
  78  * forces. However as a bug is unlikely we optimize by avoiding
  79  * creating extra overhead from communication.
  80  */
  81 class LocalTopologyChecker
  82 {
  83 public:
  84     /*! \brief Constructor
  85      * \param[in]    mdlog            Logger
  86      * \param[in]    cr               Communication object
  87      * \param[in]    mtop             Global system topology
  88      * \param[in]    localTopology    The local topology
  89      * \param[in]    localState       The local state
  90      * \param[in]    useUpdateGroups  Whether update groups are in use
  91      * \param[in]    observablesReducerBuilder  Handle to builder for ObservablesReducer
  92      */
  93     LocalTopologyChecker(const MDLogger&            mdlog,
  94                          const t_commrec*           cr,
  95                          const gmx_mtop_t&          mtop,
  96                          const gmx_localtop_t&      localTopology,
  97                          const t_state&             localState,
  98                          bool                       useUpdateGroups,
  99                          ObservablesReducerBuilder* observablesReducerBuilder);
 100     //! Destructor
 101     ~LocalTopologyChecker();
 102     //! Move constructor
 103     LocalTopologyChecker(LocalTopologyChecker&& other) noexcept;
 104     //! Move assignment
 105     LocalTopologyChecker& operator=(LocalTopologyChecker&& other) noexcept;
 106
 107     /*! \brief Set that the local topology should be checked via
 108      * observables reduction whenever that reduction is required by
 109      * another module. In case of a single domain a direct assertion
 110      * is performed instead.
 111      */
 112     void scheduleCheckOfLocalTopology(int numBondedInteractionsToReduce);
 113
 114 private:
 115     class Impl;
 116     std::unique_ptr<Impl> impl_;
 117 };
 118
 119 } // namespace gmx
 120 #endif