2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2016,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.
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.
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.
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.
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.
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.
36 /*! \libinternal \file
38 * \brief Convenience wrappers for broadcasting structs.
40 * \author Mark Abraham <mark.j.abraham@gmail.com>
43 * \ingroup module_mdlib
45 #ifndef GMX_MDLIB_BROADCASTSTRUCTS_H
46 #define GMX_MDLIB_BROADCASTSTRUCTS_H
50 #include "gromacs/gmxlib/network.h"
51 #include "gromacs/mdtypes/commrec.h"
52 #include "gromacs/utility/arrayref.h"
53 #include "gromacs/utility/smalloc.h"
55 //! Convenience wrapper for gmx_bcast of a single value.
57 void block_bc(const t_commrec *cr, T &data)
59 gmx_bcast(sizeof(T), static_cast<void *>(&data), cr);
61 //! Convenience wrapper for gmx_bcast of a C-style array.
63 void nblock_bc(const t_commrec *cr, int numElements, T *data)
65 gmx_bcast(numElements * sizeof(T), static_cast<void *>(data), cr);
67 //! Convenience wrapper for gmx_bcast of an ArrayRef<T>
69 void nblock_bc(const t_commrec *cr, gmx::ArrayRef<T> data)
71 gmx_bcast(data.size() * sizeof(T), static_cast<void *>(data.data()), cr);
73 //! Convenience wrapper for allocation with snew of vectors that need allocation on non-master ranks.
75 void snew_bc(const t_commrec *cr, T * &data, int numElements)
79 snew(data, numElements);
82 //! Convenience wrapper for gmx_bcast of a C-style array which needs allocation on non-master ranks.
84 void nblock_abc(const t_commrec *cr, int numElements, T **v)
86 snew_bc(cr, v, numElements);
87 nblock_bc(cr, numElements, *v);
89 //! Convenience wrapper for gmx_bcast of a std::vector which needs resizing on non-master ranks.
91 void nblock_abc(const t_commrec *cr, int numElements, std::vector<T> *v)
95 v->resize(numElements);
97 gmx_bcast(numElements*sizeof(T), v->data(), cr);