2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015,2017,2018,2019, by the GROMACS development team, led by
7 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8 * and including many others, as listed in the AUTHORS file in the
9 * top-level source directory and at http://www.gromacs.org.
11 * GROMACS is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public License
13 * as published by the Free Software Foundation; either version 2.1
14 * of the License, or (at your option) any later version.
16 * GROMACS is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with GROMACS; if not, see
23 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 * If you want to redistribute modifications to GROMACS, please
27 * consider that scientific software is very special. Version
28 * control is crucial - bugs must be traceable. We will be happy to
29 * consider code for inclusion in the official distribution, but
30 * derived work must not be called official GROMACS. Details are found
31 * in the README & COPYING files - if they are missing, get the
32 * official version at http://www.gromacs.org.
34 * To help us fund GROMACS development, we humbly ask that you cite
35 * the research papers on the package. Check out http://www.gromacs.org.
37 #ifndef GMX_MDTYPES_COMMREC_H
38 #define GMX_MDTYPES_COMMREC_H
42 #include "gromacs/utility/basedefinitions.h"
43 #include "gromacs/utility/gmxassert.h"
44 #include "gromacs/utility/gmxmpi.h"
46 struct mpi_in_place_buf_t;
49 #define DUTY_PP (1U << 0U)
50 #define DUTY_PME (1U << 1U)
63 /* The nodeids in one sim are numbered sequentially from 0.
64 * All communication within some simulation should happen
65 * in mpi_comm_mysim, or its subset mpi_comm_mygroup.
67 int sim_nodeid, nnodes, npmenodes;
70 /* Not used yet: int threadid, nthreads; */
71 /* The nodeid in the PP/PME, PP or PME group */
74 /* MPI communicators within a single simulation
75 * Note: other parts of the code may further subset these communicators.
77 MPI_Comm mpi_comm_mysim; /* communicator including all ranks of
78 a single simulation */
79 MPI_Comm mpi_comm_mygroup; /* subset of mpi_comm_mysim including only
80 the ranks in the same group (PP or PME) */
84 /* For domain decomposition */
87 /* The duties of this node, see the DUTY_ defines above.
88 * This should be read through thisRankHasDuty() or getThisRankDuties().
92 /* these buffers are used as destination buffers if MPI_IN_PLACE isn't
94 mpi_in_place_buf_t* mpb;
98 * Returns the rank's duty, and asserts that it has been initialized.
100 inline int getThisRankDuties(const t_commrec* cr)
102 GMX_ASSERT(cr, "Invalid commrec pointer");
103 GMX_ASSERT(cr->duty != 0, "Commrec duty was not initialized!");
108 * A convenience getter for the commrec duty assignment;
109 * asserts that duty is actually valid (have been initialized).
111 * \param[in] cr Communication structure pointer
112 * \param[in] duty A single duty's corresponding DUTY_ flag. Combinations are not supported.
114 * \returns Whether this duty is assigned to this rank.
116 inline bool thisRankHasDuty(const t_commrec* cr, int duty)
118 GMX_ASSERT((duty == DUTY_PME) || (duty == DUTY_PP), "Invalid duty type");
119 return (getThisRankDuties(cr) & duty) != 0;
122 //! True if this is a simulation with more than 1 node
123 #define PAR(cr) ((cr)->nnodes > 1)
125 //! True of this is the master node
126 #define MASTER(cr) (((cr)->nodeid == 0) || !PAR(cr))
128 //! True if this is the particle-particle master
129 #define SIMMASTER(cr) ((MASTER(cr) && thisRankHasDuty((cr), DUTY_PP)) || !PAR(cr))
131 //! The node id for this rank
132 #define RANK(cr, nodeid) (nodeid)
134 //! The node id for the master
135 #define MASTERRANK(cr) (0)
137 /*! \brief Do we use domain decomposition
139 * Note that even with particle decomposition removed, the use of
140 * non-DD parallelization in TPI, NM and multi-simulations means that
141 * PAR(cr) and DOMAINDECOMP(cr) are not universally synonymous. In
142 * particular, DOMAINDECOMP(cr) == true indicates that there is more
143 * than one domain, not just that the dd algorithm is active. */
144 #define DOMAINDECOMP(cr) (((cr)->dd != nullptr) && PAR(cr))
146 /*! \brief Returns whether we have actual domain decomposition for the particle-particle interactions
148 * Will return false when we use 1 rank for PP and 1 for PME
150 static bool inline havePPDomainDecomposition(const t_commrec* cr)
152 /* NOTE: It would be better to use cr->dd->nnodes, but we do not want
153 * to pull in a dependency on domdec.h into this file.
155 GMX_ASSERT(cr != nullptr, "Invalid call of havePPDomainDecomposition before commrec is made");
156 GMX_ASSERT(cr->npmenodes >= 0,
157 "Invalid call of havePPDomainDecomposition before MPMD automated decomposition was "
159 return (cr->dd != nullptr && cr->nnodes - cr->npmenodes > 1);