src/gromacs/domdec/atomdistribution.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, 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 AtomDistribution struct.
  38  *
  39  * \author Berk Hess <hess@kth.se>
  40  * \ingroup module_domdec
  41  */
  42 #ifndef GMX_DOMDEC_ATOMDISTRIBUTION_H
  43 #define GMX_DOMDEC_ATOMDISTRIBUTION_H
  44
  45 #include <array>
  46 #include <vector>
  47
  48 #include "gromacs/math/vectypes.h"
  49 #include "gromacs/utility/arrayref.h"
  50
  51 /*! \internal
  52  * \brief Distribution of atom groups over the domain (only available on the master rank)
  53  */
  54 struct AtomDistribution
  55 {
  56     /*! \internal
  57      * \brief Collection of local group and atom counts for a domain
  58      */
  59     struct DomainAtomGroups
  60     {
  61         gmx::ArrayRef<const int> atomGroups; /**< List of our atom groups */
  62         int                      numAtoms;   /**< Our number of local atoms */
  63     };
  64
  65     /*! \brief Constructor */
  66     AtomDistribution(const ivec numCells, int numAtomGroups, int numAtoms);
  67
  68     std::vector<DomainAtomGroups> domainGroups; /**< Group and atom division over ranks/domains */
  69     std::vector<int>              atomGroups; /**< The atom group division of the whole system, pointed into by counts[].atomGroups */
  70
  71     /* Temporary buffers, stored permanently here to avoid reallocation */
  72     std::array<std::vector<real>, DIM> cellSizesBuffer; /**< Cell boundaries, sizes: num_cells_in_dim + 1 */
  73     std::vector<int>       intBuffer;  /**< Buffer for communicating cg and atom counts */
  74     std::vector<gmx::RVec> rvecBuffer; /**< Buffer for state scattering and gathering */
  75 };
  76
  77 /*! \brief Returns state scatter/gather buffer element counts and displacements
  78  *
  79  * NOTE: Should only be called with a pointer to a valid ma struct
  80  *       (only available on the master rank).
  81  */
  82 void get_commbuffer_counts(AtomDistribution* ma, int** counts, int** disps);
  83
  84 #endif