src/gromacs/domdec/distribute.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,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 /*! \internal \file
  36  *
  37  * \brief Declares the atom distribution function.
  38  *
  39  * \author Berk Hess <hess@kth.se>
  40  * \ingroup module_domdec
  41  */
  42 #ifndef GMX_DOMDEC_DOMDEC_DISTRIBUTE_H
  43 #define GMX_DOMDEC_DOMDEC_DISTRIBUTE_H
  44
  45 #include "gromacs/utility/basedefinitions.h"
  46
  47 struct df_history_t;
  48 struct gmx_ddbox_t;
  49 struct gmx_domdec_t;
  50 struct gmx_mtop_t;
  51 struct t_block;
  52 class t_state;
  53
  54 namespace gmx
  55 {
  56 class MDLogger;
  57 }
  58
  59 /*! \brief Distributes the state from the master rank to all DD ranks */
  60 void distributeState(const gmx::MDLogger& mdlog,
  61                      gmx_domdec_t*        dd,
  62                      const gmx_mtop_t&    mtop,
  63                      t_state*             state_global,
  64                      const gmx_ddbox_t&   ddbox,
  65                      t_state*             state_local);
  66
  67 /*! \brief Distribute the dfhist struct from the master rank to all DD ranks
  68  *
  69  * Used by the modular simulator checkpointing
  70  *
  71  * \param dd  Domain decomposition information
  72  * \param dfhist  Free energy history struct
  73  */
  74 void dd_distribute_dfhist(gmx_domdec_t* dd, df_history_t* dfhist);
  75
  76 #endif