src/gromacs/domdec/collect.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018, 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  * \brief Declares functions to collect state data to the master rank.
  37  *
  38  * \author Berk Hess <hess@kth.se>
  39  * \inlibraryapi
  40  * \ingroup module_domdec
  41  */
  42
  43 #ifndef GMX_DOMDEC_COLLECT_H
  44 #define GMX_DOMDEC_COLLECT_H
  45
  46 #include "gromacs/math/vectypes.h"
  47 #include "gromacs/utility/arrayref.h"
  48
  49 struct gmx_domdec_t;
  50 class t_state;
  51
  52 /*! \brief Gathers rvec arrays \p localVector to \p globalVector on the master rank */
  53 void dd_collect_vec(gmx_domdec_t                   *dd,
  54                     const t_state                  *localState,
  55                     gmx::ArrayRef<const gmx::RVec>  localVector,
  56                     gmx::ArrayRef<gmx::RVec>        globalVector);
  57
  58 /*! \brief Gathers state \p localState to \p globalState on the master rank */
  59 void dd_collect_state(gmx_domdec_t  *dd,
  60                       const t_state *localState,
  61                       t_state       *globalState);
  62
  63 #endif