src/gromacs/mdlib/broadcaststructs.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,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
  36 /*! \libinternal \file
  37  *
  38  * \brief Convenience wrappers for broadcasting structs.
  39  *
  40  * \author Mark Abraham <mark.j.abraham@gmail.com>
  41  *
  42  * \inlibraryapi
  43  * \ingroup module_mdlib
  44  */
  45 #ifndef GMX_MDLIB_BROADCASTSTRUCTS_H
  46 #define GMX_MDLIB_BROADCASTSTRUCTS_H
  47
  48 #include <vector>
  49
  50 #include "gromacs/gmxlib/network.h"
  51 #include "gromacs/mdtypes/commrec.h"
  52 #include "gromacs/utility/arrayref.h"
  53 #include "gromacs/utility/smalloc.h"
  54
  55 struct gmx_mtop_t;
  56 struct t_commrec;
  57 struct t_inputrec;
  58 class t_state;
  59
  60 //! Convenience wrapper for gmx_bcast of a single value.
  61 template <typename T>
  62 void block_bc(const t_commrec *cr, T &data)
  63 {
  64     gmx_bcast(sizeof(T), static_cast<void *>(&data), cr);
  65 }
  66 //! Convenience wrapper for gmx_bcast of a C-style array.
  67 template <typename T>
  68 void nblock_bc(const t_commrec *cr, int numElements, T *data)
  69 {
  70     gmx_bcast(numElements * sizeof(T), static_cast<void *>(data), cr);
  71 }
  72 //! Convenience wrapper for gmx_bcast of an ArrayRef<T>
  73 template <typename T>
  74 void nblock_bc(const t_commrec *cr, gmx::ArrayRef<T> data)
  75 {
  76     gmx_bcast(data.size() * sizeof(T), static_cast<void *>(data.data()), cr);
  77 }
  78 //! Convenience wrapper for allocation with snew of vectors that need allocation on non-master ranks.
  79 template <typename T>
  80 void snew_bc(const t_commrec *cr, T * &data, int numElements)
  81 {
  82     if (!MASTER(cr))
  83     {
  84         snew(data, numElements);
  85     }
  86 }
  87 //! Convenience wrapper for gmx_bcast of a C-style array which needs allocation on non-master ranks.
  88 template <typename T>
  89 void nblock_abc(const t_commrec *cr, int numElements, T **v)
  90 {
  91     snew_bc(cr, v, numElements);
  92     nblock_bc(cr, numElements, *v);
  93 }
  94 //! Convenience wrapper for gmx_bcast of a std::vector which needs resizing on non-master ranks.
  95 template <typename T>
  96 void nblock_abc(const t_commrec *cr, int numElements, std::vector<T> *v)
  97 {
  98     if (!MASTER(cr))
  99     {
 100         v->resize(numElements);
 101     }
 102     gmx_bcast(numElements*sizeof(T), v->data(), cr);
 103 }
 104
 105 //! \brief Broadcasts the, non-dynamic, state from the master to all ranks in cr->mpi_comm_mygroup
 106 //
 107 // This is intended to be used with MPI parallelization without
 108 // domain decompostion (currently with NM and TPI).
 109 void broadcastStateWithoutDynamics(const t_commrec *cr, t_state *state);
 110
 111 //! \brief Broadcast inputrec and mtop and allocate node-specific settings
 112 void init_parallel(t_commrec *cr, t_inputrec *inputrec,
 113                    gmx_mtop_t *mtop);
 114
 115 #endif