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,2016,2017,2018, 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 /* IMPORTANT FOR DEVELOPERS:
39 * Triclinic pme stuff isn't entirely trivial, and we've experienced
40 * some bugs during development (many of them due to me). To avoid
41 * this in the future, please check the following things if you make
42 * changes in this file:
44 * 1. You should obtain identical (at least to the PME precision)
45 * energies, forces, and virial for
46 * a rectangular box and a triclinic one where the z (or y) axis is
47 * tilted a whole box side. For instance you could use these boxes:
49 * rectangular triclinic
54 * 2. You should check the energy conservation in a triclinic box.
56 * It might seem an overkill, but better safe than sorry.
75 #include "gromacs/compat/make_unique.h"
76 #include "gromacs/domdec/domdec.h"
77 #include "gromacs/ewald/pme.h"
78 #include "gromacs/fft/parallel_3dfft.h"
79 #include "gromacs/fileio/pdbio.h"
80 #include "gromacs/gmxlib/network.h"
81 #include "gromacs/gmxlib/nrnb.h"
82 #include "gromacs/gpu_utils/hostallocator.h"
83 #include "gromacs/math/gmxcomplex.h"
84 #include "gromacs/math/units.h"
85 #include "gromacs/math/vec.h"
86 #include "gromacs/mdtypes/commrec.h"
87 #include "gromacs/mdtypes/inputrec.h"
88 #include "gromacs/timing/cyclecounter.h"
89 #include "gromacs/timing/wallcycle.h"
90 #include "gromacs/utility/fatalerror.h"
91 #include "gromacs/utility/futil.h"
92 #include "gromacs/utility/gmxmpi.h"
93 #include "gromacs/utility/gmxomp.h"
94 #include "gromacs/utility/smalloc.h"
96 #include "pme-internal.h"
97 #include "pme-pp-communication.h"
99 //! Contains information about the PP ranks that partner this PME rank.
102 //! The MPI rank ID of this partner PP rank.
104 //! The number of atoms to communicate with this partner PP rank.
108 /*! \brief Master PP-PME communication data structure */
110 MPI_Comm mpi_comm_mysim; /**< MPI communicator for this simulation */
111 std::vector<PpRanks> ppRanks; /**< The PP partner ranks */
112 int peerRankId; /**< The peer PP rank id */
114 /**< Vectors of A- and B-state parameters used to transfer vectors to PME ranks */
115 gmx::HostVector<real> chargeA;
116 std::vector<real> chargeB;
117 std::vector<real> sqrt_c6A;
118 std::vector<real> sqrt_c6B;
119 std::vector<real> sigmaA;
120 std::vector<real> sigmaB;
122 gmx::HostVector<gmx::RVec> x; /**< Vector of atom coordinates to transfer to PME ranks */
123 std::vector<gmx::RVec> f; /**< Vector of atom forces received from PME ranks */
125 /**< Vectors of MPI objects used in non-blocking communication between multiple PP ranks per PME rank */
126 std::vector<MPI_Request> req;
127 std::vector<MPI_Status> stat;
131 /*! \brief Initialize the PME-only side of the PME <-> PP communication */
132 static std::unique_ptr<gmx_pme_pp> gmx_pme_pp_init(const t_commrec *cr)
134 auto pme_pp = gmx::compat::make_unique<gmx_pme_pp>();
139 pme_pp->mpi_comm_mysim = cr->mpi_comm_mysim;
140 MPI_Comm_rank(cr->mpi_comm_mygroup, &rank);
141 auto ppRanks = get_pme_ddranks(cr, rank);
142 pme_pp->ppRanks.reserve(ppRanks.size());
143 for (const auto &ppRankId : ppRanks)
145 pme_pp->ppRanks.push_back({ppRankId, 0});
147 // The peer PP rank is the last one.
148 pme_pp->peerRankId = pme_pp->ppRanks.back().rankId;
149 pme_pp->req.resize(eCommType_NR*pme_pp->ppRanks.size());
150 pme_pp->stat.resize(eCommType_NR*pme_pp->ppRanks.size());
152 GMX_UNUSED_VALUE(cr);
158 static void reset_pmeonly_counters(gmx_wallcycle_t wcycle,
159 gmx_walltime_accounting_t walltime_accounting,
160 t_nrnb *nrnb, t_inputrec *ir,
164 /* Reset all the counters related to performance over the run */
165 wallcycle_stop(wcycle, ewcRUN);
166 wallcycle_reset_all(wcycle);
170 /* ir->nsteps is not used here, but we update it for consistency */
171 ir->nsteps -= step - ir->init_step;
173 ir->init_step = step;
174 wallcycle_start(wcycle, ewcRUN);
175 walltime_accounting_start(walltime_accounting);
183 static gmx_pme_t *gmx_pmeonly_switch(std::vector<gmx_pme_t *> *pmedata,
184 const ivec grid_size,
185 real ewaldcoeff_q, real ewaldcoeff_lj,
186 const t_commrec *cr, const t_inputrec *ir)
188 GMX_ASSERT(pmedata, "Bad PME tuning list pointer");
189 for (auto &pme : *pmedata)
191 GMX_ASSERT(pme, "Bad PME tuning list element pointer");
192 if (pme->nkx == grid_size[XX] &&
193 pme->nky == grid_size[YY] &&
194 pme->nkz == grid_size[ZZ])
196 /* Here we have found an existing PME data structure that suits us.
197 * However, in the GPU case, we have to reinitialize it - there's only one GPU structure.
198 * This should not cause actual GPU reallocations, at least (the allocated buffers are never shrunk).
199 * So, just some grid size updates in the GPU kernel parameters.
200 * TODO: this should be something like gmx_pme_update_split_params()
202 gmx_pme_reinit(&pme, cr, pme, ir, grid_size, ewaldcoeff_q, ewaldcoeff_lj);
207 const auto &pme = pmedata->back();
208 gmx_pme_t *newStructure = nullptr;
209 // Copy last structure with new grid params
210 gmx_pme_reinit(&newStructure, cr, pme, ir, grid_size, ewaldcoeff_q, ewaldcoeff_lj);
211 pmedata->push_back(newStructure);
215 /*! \brief Called by PME-only ranks to receive coefficients and coordinates
217 * \param[in,out] pme_pp PME-PP communication structure.
218 * \param[out] natoms Number of received atoms.
219 * \param[out] box System box, if received.
220 * \param[out] maxshift_x Maximum shift in X direction, if received.
221 * \param[out] maxshift_y Maximum shift in Y direction, if received.
222 * \param[out] lambda_q Free-energy lambda for electrostatics, if received.
223 * \param[out] lambda_lj Free-energy lambda for Lennard-Jones, if received.
224 * \param[out] bEnerVir Set to true if this is an energy/virial calculation step, otherwise set to false.
225 * \param[out] step MD integration step number.
226 * \param[out] grid_size PME grid size, if received.
227 * \param[out] ewaldcoeff_q Ewald cut-off parameter for electrostatics, if received.
228 * \param[out] ewaldcoeff_lj Ewald cut-off parameter for Lennard-Jones, if received.
229 * \param[out] atomSetChanged Set to true only if the local domain atom data (charges/coefficients)
230 * has been received (after DD) and should be reinitialized. Otherwise not changed.
232 * \retval pmerecvqxX All parameters were set, chargeA and chargeB can be NULL.
233 * \retval pmerecvqxFINISH No parameters were set.
234 * \retval pmerecvqxSWITCHGRID Only grid_size and *ewaldcoeff were set.
235 * \retval pmerecvqxRESETCOUNTERS *step was set.
237 static int gmx_pme_recv_coeffs_coords(gmx_pme_pp *pme_pp,
249 bool *atomSetChanged)
255 unsigned int flags = 0;
260 gmx_pme_comm_n_box_t cnb;
263 /* Receive the send count, box and time step from the peer PP node */
264 MPI_Recv(&cnb, sizeof(cnb), MPI_BYTE,
265 pme_pp->peerRankId, eCommType_CNB,
266 pme_pp->mpi_comm_mysim, MPI_STATUS_IGNORE);
268 /* We accumulate all received flags */
275 fprintf(debug, "PME only rank receiving:%s%s%s%s%s\n",
276 (cnb.flags & PP_PME_CHARGE) ? " charges" : "",
277 (cnb.flags & PP_PME_COORD ) ? " coordinates" : "",
278 (cnb.flags & PP_PME_FINISH) ? " finish" : "",
279 (cnb.flags & PP_PME_SWITCHGRID) ? " switch grid" : "",
280 (cnb.flags & PP_PME_RESETCOUNTERS) ? " reset counters" : "");
283 if (cnb.flags & PP_PME_FINISH)
285 status = pmerecvqxFINISH;
288 if (cnb.flags & PP_PME_SWITCHGRID)
290 /* Special case, receive the new parameters and return */
291 copy_ivec(cnb.grid_size, *grid_size);
292 *ewaldcoeff_q = cnb.ewaldcoeff_q;
293 *ewaldcoeff_lj = cnb.ewaldcoeff_lj;
295 status = pmerecvqxSWITCHGRID;
298 if (cnb.flags & PP_PME_RESETCOUNTERS)
300 /* Special case, receive the step (set above) and return */
301 status = pmerecvqxRESETCOUNTERS;
304 if (cnb.flags & (PP_PME_CHARGE | PP_PME_SQRTC6 | PP_PME_SIGMA))
306 *atomSetChanged = true;
308 /* Receive the send counts from the other PP nodes */
309 for (auto &sender : pme_pp->ppRanks)
311 if (sender.rankId == pme_pp->peerRankId)
313 sender.numAtoms = cnb.natoms;
317 MPI_Irecv(&sender.numAtoms, sizeof(sender.numAtoms),
319 sender.rankId, eCommType_CNB,
320 pme_pp->mpi_comm_mysim, &pme_pp->req[messages++]);
323 MPI_Waitall(messages, pme_pp->req.data(), pme_pp->stat.data());
327 for (const auto &sender : pme_pp->ppRanks)
329 nat += sender.numAtoms;
332 if (cnb.flags & PP_PME_CHARGE)
334 pme_pp->chargeA.resize(nat);
336 if (cnb.flags & PP_PME_CHARGEB)
338 pme_pp->chargeB.resize(nat);
340 if (cnb.flags & PP_PME_SQRTC6)
342 pme_pp->sqrt_c6A.resize(nat);
344 if (cnb.flags & PP_PME_SQRTC6B)
346 pme_pp->sqrt_c6B.resize(nat);
348 if (cnb.flags & PP_PME_SIGMA)
350 pme_pp->sigmaA.resize(nat);
352 if (cnb.flags & PP_PME_SIGMAB)
354 pme_pp->sigmaB.resize(nat);
356 pme_pp->x.resize(nat);
357 pme_pp->f.resize(nat);
359 /* maxshift is sent when the charges are sent */
360 *maxshift_x = cnb.maxshift_x;
361 *maxshift_y = cnb.maxshift_y;
363 /* Receive the charges in place */
364 for (int q = 0; q < eCommType_NR; q++)
368 if (!(cnb.flags & (PP_PME_CHARGE<<q)))
374 case eCommType_ChargeA: bufferPtr = pme_pp->chargeA.data(); break;
375 case eCommType_ChargeB: bufferPtr = pme_pp->chargeB.data(); break;
376 case eCommType_SQRTC6A: bufferPtr = pme_pp->sqrt_c6A.data(); break;
377 case eCommType_SQRTC6B: bufferPtr = pme_pp->sqrt_c6B.data(); break;
378 case eCommType_SigmaA: bufferPtr = pme_pp->sigmaA.data(); break;
379 case eCommType_SigmaB: bufferPtr = pme_pp->sigmaB.data(); break;
380 default: gmx_incons("Wrong eCommType");
383 for (const auto &sender : pme_pp->ppRanks)
385 if (sender.numAtoms > 0)
387 MPI_Irecv(bufferPtr+nat,
388 sender.numAtoms*sizeof(real),
391 pme_pp->mpi_comm_mysim,
392 &pme_pp->req[messages++]);
393 nat += sender.numAtoms;
396 fprintf(debug, "Received from PP rank %d: %d %s\n",
397 sender.rankId, sender.numAtoms,
398 (q == eCommType_ChargeA ||
399 q == eCommType_ChargeB) ? "charges" : "params");
406 if (cnb.flags & PP_PME_COORD)
408 /* The box, FE flag and lambda are sent along with the coordinates
410 copy_mat(cnb.box, box);
411 *lambda_q = cnb.lambda_q;
412 *lambda_lj = cnb.lambda_lj;
413 *bEnerVir = (cnb.flags & PP_PME_ENER_VIR);
416 /* Receive the coordinates in place */
418 for (const auto &sender : pme_pp->ppRanks)
420 if (sender.numAtoms > 0)
422 MPI_Irecv(pme_pp->x[nat], sender.numAtoms*sizeof(rvec),
424 sender.rankId, eCommType_COORD,
425 pme_pp->mpi_comm_mysim, &pme_pp->req[messages++]);
426 nat += sender.numAtoms;
429 fprintf(debug, "Received from PP rank %d: %d "
431 sender.rankId, sender.numAtoms);
439 /* Wait for the coordinates and/or charges to arrive */
440 MPI_Waitall(messages, pme_pp->req.data(), pme_pp->stat.data());
443 while (status == -1);
445 GMX_UNUSED_VALUE(pme_pp);
446 GMX_UNUSED_VALUE(box);
447 GMX_UNUSED_VALUE(maxshift_x);
448 GMX_UNUSED_VALUE(maxshift_y);
449 GMX_UNUSED_VALUE(lambda_q);
450 GMX_UNUSED_VALUE(lambda_lj);
451 GMX_UNUSED_VALUE(bEnerVir);
452 GMX_UNUSED_VALUE(step);
453 GMX_UNUSED_VALUE(grid_size);
454 GMX_UNUSED_VALUE(ewaldcoeff_q);
455 GMX_UNUSED_VALUE(ewaldcoeff_lj);
456 GMX_UNUSED_VALUE(atomSetChanged);
461 if (status == pmerecvqxX)
469 /*! \brief Send the PME mesh force, virial and energy to the PP-only ranks. */
470 static void gmx_pme_send_force_vir_ener(gmx_pme_pp *pme_pp,
472 matrix vir_q, real energy_q,
473 matrix vir_lj, real energy_lj,
474 real dvdlambda_q, real dvdlambda_lj,
478 gmx_pme_comm_vir_ene_t cve;
479 int messages, ind_start, ind_end;
482 /* Now the evaluated forces have to be transferred to the PP nodes */
485 for (const auto &receiver : pme_pp->ppRanks)
488 ind_end = ind_start + receiver.numAtoms;
489 if (MPI_Isend(const_cast<void *>(static_cast<const void *>(f[ind_start])),
490 (ind_end-ind_start)*sizeof(rvec), MPI_BYTE,
492 pme_pp->mpi_comm_mysim, &pme_pp->req[messages++]) != 0)
494 gmx_comm("MPI_Isend failed in do_pmeonly");
498 /* send virial and energy to our last PP node */
499 copy_mat(vir_q, cve.vir_q);
500 copy_mat(vir_lj, cve.vir_lj);
501 cve.energy_q = energy_q;
502 cve.energy_lj = energy_lj;
503 cve.dvdlambda_q = dvdlambda_q;
504 cve.dvdlambda_lj = dvdlambda_lj;
505 /* check for the signals to send back to a PP node */
506 cve.stop_cond = gmx_get_stop_condition();
512 fprintf(debug, "PME rank sending to PP rank %d: virial and energy\n",
515 MPI_Isend(&cve, sizeof(cve), MPI_BYTE,
516 pme_pp->peerRankId, 1,
517 pme_pp->mpi_comm_mysim, &pme_pp->req[messages++]);
519 /* Wait for the forces to arrive */
520 MPI_Waitall(messages, pme_pp->req.data(), pme_pp->stat.data());
522 gmx_call("MPI not enabled");
523 GMX_UNUSED_VALUE(pme_pp);
525 GMX_UNUSED_VALUE(vir_q);
526 GMX_UNUSED_VALUE(energy_q);
527 GMX_UNUSED_VALUE(vir_lj);
528 GMX_UNUSED_VALUE(energy_lj);
529 GMX_UNUSED_VALUE(dvdlambda_q);
530 GMX_UNUSED_VALUE(dvdlambda_lj);
531 GMX_UNUSED_VALUE(cycles);
535 int gmx_pmeonly(struct gmx_pme_t *pme,
536 const t_commrec *cr, t_nrnb *mynrnb,
537 gmx_wallcycle *wcycle,
538 gmx_walltime_accounting_t walltime_accounting,
539 t_inputrec *ir, PmeRunMode runMode)
546 int maxshift_x = 0, maxshift_y = 0;
547 real energy_q, energy_lj, dvdlambda_q, dvdlambda_lj;
548 matrix vir_q, vir_lj;
551 gmx_bool bEnerVir = FALSE;
554 /* This data will only use with PME tuning, i.e. switching PME grids */
555 std::vector<gmx_pme_t *> pmedata;
556 pmedata.push_back(pme);
558 auto pme_pp = gmx_pme_pp_init(cr);
559 //TODO the variable below should be queried from the task assignment info
560 const bool useGpuForPme = (runMode == PmeRunMode::GPU) || (runMode == PmeRunMode::Mixed);
563 changePinningPolicy(&pme_pp->chargeA, pme_get_pinning_policy());
564 changePinningPolicy(&pme_pp->x, pme_get_pinning_policy());
570 do /****** this is a quasi-loop over time steps! */
572 /* The reason for having a loop here is PME grid tuning/switching */
575 /* Domain decomposition */
577 bool atomSetChanged = false;
578 real ewaldcoeff_q = 0, ewaldcoeff_lj = 0;
579 ret = gmx_pme_recv_coeffs_coords(pme_pp.get(),
582 &maxshift_x, &maxshift_y,
583 &lambda_q, &lambda_lj,
591 if (ret == pmerecvqxSWITCHGRID)
593 /* Switch the PME grid to newGridSize */
594 pme = gmx_pmeonly_switch(&pmedata, newGridSize, ewaldcoeff_q, ewaldcoeff_lj, cr, ir);
599 gmx_pme_reinit_atoms(pme, natoms, pme_pp->chargeA.data());
602 if (ret == pmerecvqxRESETCOUNTERS)
604 /* Reset the cycle and flop counters */
605 reset_pmeonly_counters(wcycle, walltime_accounting, mynrnb, ir, step, useGpuForPme);
608 while (ret == pmerecvqxSWITCHGRID || ret == pmerecvqxRESETCOUNTERS);
610 if (ret == pmerecvqxFINISH)
612 /* We should stop: break out of the loop */
618 wallcycle_start(wcycle, ewcRUN);
619 walltime_accounting_start(walltime_accounting);
622 wallcycle_start(wcycle, ewcPMEMESH);
631 // TODO Make a struct of array refs onto these per-atom fields
632 // of pme_pp (maybe box, energy and virial, too; and likewise
633 // from mdatoms for the other call to gmx_pme_do), so we have
634 // fewer lines of code and less parameter passing.
635 const int pmeFlags = GMX_PME_DO_ALL_F | (bEnerVir ? GMX_PME_CALC_ENER_VIR : 0);
636 gmx::ArrayRef<const gmx::RVec> forces;
639 const bool boxChanged = false;
640 //TODO this should be set properly by gmx_pme_recv_coeffs_coords,
641 // or maybe use inputrecDynamicBox(ir), at the very least - change this when this codepath is tested!
642 pme_gpu_prepare_computation(pme, boxChanged, box, wcycle, pmeFlags);
643 pme_gpu_launch_spread(pme, as_rvec_array(pme_pp->x.data()), wcycle);
644 pme_gpu_launch_complex_transforms(pme, wcycle);
645 pme_gpu_launch_gather(pme, wcycle, PmeForceOutputHandling::Set);
646 pme_gpu_wait_finish_task(pme, wcycle, &forces, vir_q, &energy_q);
647 pme_gpu_reinit_computation(pme, wcycle);
651 gmx_pme_do(pme, 0, natoms, as_rvec_array(pme_pp->x.data()), as_rvec_array(pme_pp->f.data()),
652 pme_pp->chargeA.data(), pme_pp->chargeB.data(),
653 pme_pp->sqrt_c6A.data(), pme_pp->sqrt_c6B.data(),
654 pme_pp->sigmaA.data(), pme_pp->sigmaB.data(), box,
655 cr, maxshift_x, maxshift_y, mynrnb, wcycle,
657 &energy_q, &energy_lj, lambda_q, lambda_lj, &dvdlambda_q, &dvdlambda_lj,
662 cycles = wallcycle_stop(wcycle, ewcPMEMESH);
664 gmx_pme_send_force_vir_ener(pme_pp.get(), as_rvec_array(forces.data()),
665 vir_q, energy_q, vir_lj, energy_lj,
666 dvdlambda_q, dvdlambda_lj, cycles);
669 } /***** end of quasi-loop, we stop with the break above */
672 walltime_accounting_end(walltime_accounting);