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,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.
47 #include "gromacs/domdec/domdec_struct.h"
48 #include "gromacs/fileio/confio.h"
49 #include "gromacs/gmxlib/network.h"
50 #include "gromacs/gmxlib/nrnb.h"
51 #include "gromacs/listed_forces/disre.h"
52 #include "gromacs/listed_forces/orires.h"
53 #include "gromacs/math/functions.h"
54 #include "gromacs/math/invertmatrix.h"
55 #include "gromacs/math/paddedvector.h"
56 #include "gromacs/math/units.h"
57 #include "gromacs/math/vec.h"
58 #include "gromacs/math/vecdump.h"
59 #include "gromacs/mdlib/boxdeformation.h"
60 #include "gromacs/mdlib/constr.h"
61 #include "gromacs/mdlib/gmx_omp_nthreads.h"
62 #include "gromacs/mdlib/mdatoms.h"
63 #include "gromacs/mdlib/stat.h"
64 #include "gromacs/mdlib/tgroup.h"
65 #include "gromacs/mdtypes/commrec.h"
66 #include "gromacs/mdtypes/group.h"
67 #include "gromacs/mdtypes/inputrec.h"
68 #include "gromacs/mdtypes/md_enums.h"
69 #include "gromacs/mdtypes/state.h"
70 #include "gromacs/pbcutil/boxutilities.h"
71 #include "gromacs/pbcutil/mshift.h"
72 #include "gromacs/pbcutil/pbc.h"
73 #include "gromacs/pulling/pull.h"
74 #include "gromacs/random/tabulatednormaldistribution.h"
75 #include "gromacs/random/threefry.h"
76 #include "gromacs/simd/simd.h"
77 #include "gromacs/timing/wallcycle.h"
78 #include "gromacs/topology/atoms.h"
79 #include "gromacs/utility/exceptions.h"
80 #include "gromacs/utility/fatalerror.h"
81 #include "gromacs/utility/futil.h"
82 #include "gromacs/utility/gmxassert.h"
83 #include "gromacs/utility/gmxomp.h"
84 #include "gromacs/utility/smalloc.h"
86 using namespace gmx; // TODO: Remove when this file is moved into gmx namespace
101 std::vector<real> bd_rf;
103 std::vector<gmx_sd_const_t> sdc;
104 std::vector<gmx_sd_sigma_t> sdsig;
105 /* andersen temperature control stuff */
106 std::vector<bool> randomize_group;
107 std::vector<real> boltzfac;
109 explicit gmx_stochd_t(const t_inputrec *ir);
112 //! pImpled implementation for Update
117 Impl(const t_inputrec *ir, BoxDeformation *boxDeformation);
120 //! stochastic dynamics struct
121 std::unique_ptr<gmx_stochd_t> sd;
122 //! xprime for constraint algorithms
123 PaddedVector<RVec> xp;
124 //! Box deformation handler (or nullptr if inactive).
125 BoxDeformation *deform = nullptr;
128 Update::Update(const t_inputrec *ir, BoxDeformation *boxDeformation)
129 : impl_(new Impl(ir, boxDeformation))
135 gmx_stochd_t* Update::sd() const
137 return impl_->sd.get();
140 PaddedVector<RVec> * Update::xp()
145 BoxDeformation * Update::deform() const
147 return impl_->deform;
150 /*! \brief Sets the velocities of virtual sites to zero */
151 static void clearVsiteVelocities(int start,
153 const unsigned short *particleType,
154 rvec * gmx_restrict v)
156 for (int a = start; a < nrend; a++)
158 if (particleType[a] == eptVSite)
165 /*! \brief Sets the number of different temperature coupling values */
166 enum class NumTempScaleValues
168 single, //!< Single T-scaling value (either one group or all values =1)
169 multiple //!< Multiple T-scaling values, need to use T-group indices
172 /*! \brief Sets if to apply no or diagonal Parrinello-Rahman pressure scaling
174 * Note that this enum is only used in updateMDLeapfrogSimple(), which does
175 * not handle fully anistropic Parrinello-Rahman scaling, so we only have
176 * options \p no and \p diagonal here and no anistropic option.
178 enum class ApplyParrinelloRahmanVScaling
180 no, //!< Do not apply velocity scaling (not a PR-coupling run or step)
181 diagonal //!< Apply velocity scaling using a diagonal matrix
184 /*! \brief Integrate using leap-frog with T-scaling and optionally diagonal Parrinello-Rahman p-coupling
186 * \tparam numTempScaleValues The number of different T-couple values
187 * \tparam applyPRVScaling Apply Parrinello-Rahman velocity scaling
188 * \param[in] start Index of first atom to update
189 * \param[in] nrend Last atom to update: \p nrend - 1
190 * \param[in] dt The time step
191 * \param[in] dtPressureCouple Time step for pressure coupling
192 * \param[in] invMassPerDim 1/mass per atom and dimension
193 * \param[in] tcstat Temperature coupling information
194 * \param[in] cTC T-coupling group index per atom
195 * \param[in] pRVScaleMatrixDiagonal Parrinello-Rahman v-scale matrix diagonal
196 * \param[in] x Input coordinates
197 * \param[out] xprime Updated coordinates
198 * \param[inout] v Velocities
199 * \param[in] f Forces
201 * We expect this template to get good SIMD acceleration by most compilers,
202 * unlike the more complex general template.
203 * Note that we might get even better SIMD acceleration when we introduce
204 * aligned (and padded) memory, possibly with some hints for the compilers.
206 template<NumTempScaleValues numTempScaleValues,
207 ApplyParrinelloRahmanVScaling applyPRVScaling>
209 updateMDLeapfrogSimple(int start,
212 real dtPressureCouple,
213 const rvec * gmx_restrict invMassPerDim,
214 gmx::ArrayRef<const t_grp_tcstat> tcstat,
215 const unsigned short * cTC,
216 const rvec pRVScaleMatrixDiagonal,
217 const rvec * gmx_restrict x,
218 rvec * gmx_restrict xprime,
219 rvec * gmx_restrict v,
220 const rvec * gmx_restrict f)
224 if (numTempScaleValues == NumTempScaleValues::single)
226 lambdaGroup = tcstat[0].lambda;
229 for (int a = start; a < nrend; a++)
231 if (numTempScaleValues == NumTempScaleValues::multiple)
233 lambdaGroup = tcstat[cTC[a]].lambda;
236 for (int d = 0; d < DIM; d++)
238 /* Note that using rvec invMassPerDim results in more efficient
239 * SIMD code, but this increases the cache pressure.
240 * For large systems with PME on the CPU this slows down the
241 * (then already slow) update by 20%. If all data remains in cache,
242 * using rvec is much faster.
244 real vNew = lambdaGroup*v[a][d] + f[a][d]*invMassPerDim[a][d]*dt;
246 if (applyPRVScaling == ApplyParrinelloRahmanVScaling::diagonal)
248 vNew -= dtPressureCouple*pRVScaleMatrixDiagonal[d]*v[a][d];
251 xprime[a][d] = x[a][d] + vNew*dt;
256 #if GMX_SIMD && GMX_SIMD_HAVE_REAL
257 #define GMX_HAVE_SIMD_UPDATE 1
259 #define GMX_HAVE_SIMD_UPDATE 0
262 #if GMX_HAVE_SIMD_UPDATE
264 /*! \brief Load (aligned) the contents of GMX_SIMD_REAL_WIDTH rvec elements sequentially into 3 SIMD registers
266 * The loaded output is:
267 * \p r0: { r[index][XX], r[index][YY], ... }
269 * \p r2: { ..., r[index+GMX_SIMD_REAL_WIDTH-1][YY], r[index+GMX_SIMD_REAL_WIDTH-1][ZZ] }
271 * \param[in] r Real to an rvec array, has to be aligned to SIMD register width
272 * \param[in] index Index of the first rvec triplet of reals to load
273 * \param[out] r0 Pointer to first SIMD register
274 * \param[out] r1 Pointer to second SIMD register
275 * \param[out] r2 Pointer to third SIMD register
277 static inline void simdLoadRvecs(const rvec *r,
283 const real *realPtr = r[index];
285 GMX_ASSERT(isSimdAligned(realPtr), "Pointer should be SIMD aligned");
287 *r0 = simdLoad(realPtr + 0*GMX_SIMD_REAL_WIDTH);
288 *r1 = simdLoad(realPtr + 1*GMX_SIMD_REAL_WIDTH);
289 *r2 = simdLoad(realPtr + 2*GMX_SIMD_REAL_WIDTH);
292 /*! \brief Store (aligned) 3 SIMD registers sequentially to GMX_SIMD_REAL_WIDTH rvec elements
294 * The stored output is:
295 * \p r[index] = { { r0[0], r0[1], ... }
297 * \p r[index+GMX_SIMD_REAL_WIDTH-1] = { ... , r2[GMX_SIMD_REAL_WIDTH-2], r2[GMX_SIMD_REAL_WIDTH-1] }
299 * \param[out] r Pointer to an rvec array, has to be aligned to SIMD register width
300 * \param[in] index Index of the first rvec triplet of reals to store to
301 * \param[in] r0 First SIMD register
302 * \param[in] r1 Second SIMD register
303 * \param[in] r2 Third SIMD register
305 static inline void simdStoreRvecs(rvec *r,
311 real *realPtr = r[index];
313 GMX_ASSERT(isSimdAligned(realPtr), "Pointer should be SIMD aligned");
315 store(realPtr + 0*GMX_SIMD_REAL_WIDTH, r0);
316 store(realPtr + 1*GMX_SIMD_REAL_WIDTH, r1);
317 store(realPtr + 2*GMX_SIMD_REAL_WIDTH, r2);
320 /*! \brief Integrate using leap-frog with single group T-scaling and SIMD
322 * \param[in] start Index of first atom to update
323 * \param[in] nrend Last atom to update: \p nrend - 1
324 * \param[in] dt The time step
325 * \param[in] invMass 1/mass per atom
326 * \param[in] tcstat Temperature coupling information
327 * \param[in] x Input coordinates
328 * \param[out] xprime Updated coordinates
329 * \param[inout] v Velocities
330 * \param[in] f Forces
333 updateMDLeapfrogSimpleSimd(int start,
336 const real * gmx_restrict invMass,
337 gmx::ArrayRef<const t_grp_tcstat> tcstat,
338 const rvec * gmx_restrict x,
339 rvec * gmx_restrict xprime,
340 rvec * gmx_restrict v,
341 const rvec * gmx_restrict f)
343 SimdReal timestep(dt);
344 SimdReal lambdaSystem(tcstat[0].lambda);
346 /* We declare variables here, since code is often slower when declaring them inside the loop */
348 /* Note: We should implement a proper PaddedVector, so we don't need this check */
349 GMX_ASSERT(isSimdAligned(invMass), "invMass should be aligned");
351 for (int a = start; a < nrend; a += GMX_SIMD_REAL_WIDTH)
353 SimdReal invMass0, invMass1, invMass2;
354 expandScalarsToTriplets(simdLoad(invMass + a),
355 &invMass0, &invMass1, &invMass2);
359 simdLoadRvecs(v, a, &v0, &v1, &v2);
360 simdLoadRvecs(f, a, &f0, &f1, &f2);
362 v0 = fma(f0*invMass0, timestep, lambdaSystem*v0);
363 v1 = fma(f1*invMass1, timestep, lambdaSystem*v1);
364 v2 = fma(f2*invMass2, timestep, lambdaSystem*v2);
366 simdStoreRvecs(v, a, v0, v1, v2);
369 simdLoadRvecs(x, a, &x0, &x1, &x2);
371 SimdReal xprime0 = fma(v0, timestep, x0);
372 SimdReal xprime1 = fma(v1, timestep, x1);
373 SimdReal xprime2 = fma(v2, timestep, x2);
375 simdStoreRvecs(xprime, a, xprime0, xprime1, xprime2);
379 #endif // GMX_HAVE_SIMD_UPDATE
381 /*! \brief Sets the NEMD acceleration type */
382 enum class AccelerationType
387 /*! \brief Integrate using leap-frog with support for everything
389 * \tparam accelerationType Type of NEMD acceleration
390 * \param[in] start Index of first atom to update
391 * \param[in] nrend Last atom to update: \p nrend - 1
392 * \param[in] doNoseHoover If to apply Nose-Hoover T-coupling
393 * \param[in] dt The time step
394 * \param[in] dtPressureCouple Time step for pressure coupling, is 0 when no pressure coupling should be applied at this step
395 * \param[in] ir The input parameter record
396 * \param[in] md Atom properties
397 * \param[in] ekind Kinetic energy data
398 * \param[in] box The box dimensions
399 * \param[in] x Input coordinates
400 * \param[out] xprime Updated coordinates
401 * \param[inout] v Velocities
402 * \param[in] f Forces
403 * \param[in] nh_vxi Nose-Hoover velocity scaling factors
404 * \param[in] M Parrinello-Rahman scaling matrix
406 template<AccelerationType accelerationType>
408 updateMDLeapfrogGeneral(int start,
412 real dtPressureCouple,
413 const t_inputrec * ir,
414 const t_mdatoms * md,
415 const gmx_ekindata_t * ekind,
417 const rvec * gmx_restrict x,
418 rvec * gmx_restrict xprime,
419 rvec * gmx_restrict v,
420 const rvec * gmx_restrict f,
421 const double * gmx_restrict nh_vxi,
424 /* This is a version of the leap-frog integrator that supports
425 * all combinations of T-coupling, P-coupling and NEMD.
426 * Nose-Hoover uses the reversible leap-frog integrator from
427 * Holian et al. Phys Rev E 52(3) : 2338, 1995
430 gmx::ArrayRef<const t_grp_tcstat> tcstat = ekind->tcstat;
431 gmx::ArrayRef<const t_grp_acc> grpstat = ekind->grpstat;
432 const unsigned short * cTC = md->cTC;
433 const unsigned short * cACC = md->cACC;
434 const rvec * accel = ir->opts.acc;
436 const rvec * gmx_restrict invMassPerDim = md->invMassPerDim;
438 /* Initialize group values, changed later when multiple groups are used */
443 real omega_Z = 2*static_cast<real>(M_PI)/box[ZZ][ZZ];
445 for (int n = start; n < nrend; n++)
451 real lg = tcstat[gt].lambda;
454 real cosineZ, vCosine;
455 #ifdef __INTEL_COMPILER
456 #pragma warning( disable : 280 )
458 switch (accelerationType)
460 case AccelerationType::none:
461 copy_rvec(v[n], vRel);
463 case AccelerationType::group:
468 /* Avoid scaling the group velocity */
469 rvec_sub(v[n], grpstat[ga].u, vRel);
471 case AccelerationType::cosine:
472 cosineZ = std::cos(x[n][ZZ]*omega_Z);
473 vCosine = cosineZ*ekind->cosacc.vcos;
474 /* Avoid scaling the cosine profile velocity */
475 copy_rvec(v[n], vRel);
482 /* Here we account for multiple time stepping, by increasing
483 * the Nose-Hoover correction by nsttcouple
485 factorNH = 0.5*ir->nsttcouple*dt*nh_vxi[gt];
488 for (int d = 0; d < DIM; d++)
491 (lg*vRel[d] + (f[n][d]*invMassPerDim[n][d]*dt - factorNH*vRel[d]
492 - dtPressureCouple*iprod(M[d], vRel)))/(1 + factorNH);
493 switch (accelerationType)
495 case AccelerationType::none:
497 case AccelerationType::group:
498 /* Add back the mean velocity and apply acceleration */
499 vNew += grpstat[ga].u[d] + accel[ga][d]*dt;
501 case AccelerationType::cosine:
504 /* Add back the mean velocity and apply acceleration */
505 vNew += vCosine + cosineZ*ekind->cosacc.cos_accel*dt;
510 xprime[n][d] = x[n][d] + vNew*dt;
515 /*! \brief Handles the Leap-frog MD x and v integration */
516 static void do_update_md(int start,
520 const t_inputrec * ir,
521 const t_mdatoms * md,
522 const gmx_ekindata_t * ekind,
524 const rvec * gmx_restrict x,
525 rvec * gmx_restrict xprime,
526 rvec * gmx_restrict v,
527 const rvec * gmx_restrict f,
528 const double * gmx_restrict nh_vxi,
531 GMX_ASSERT(nrend == start || xprime != x, "For SIMD optimization certain compilers need to have xprime != x");
532 GMX_ASSERT(ir->eI == eiMD, "Leap-frog integrator was called while another integrator was requested");
534 /* Note: Berendsen pressure scaling is handled after do_update_md() */
535 bool doTempCouple = (ir->etc != etcNO && do_per_step(step + ir->nsttcouple - 1, ir->nsttcouple));
536 bool doNoseHoover = (ir->etc == etcNOSEHOOVER && doTempCouple);
537 bool doParrinelloRahman = (ir->epc == epcPARRINELLORAHMAN && do_per_step(step + ir->nstpcouple - 1, ir->nstpcouple));
538 bool doPROffDiagonal = (doParrinelloRahman && (M[YY][XX] != 0 || M[ZZ][XX] != 0 || M[ZZ][YY] != 0));
540 real dtPressureCouple = (doParrinelloRahman ? ir->nstpcouple*dt : 0);
542 /* NEMD (also cosine) acceleration is applied in updateMDLeapFrogGeneral */
543 bool doAcceleration = (ekind->bNEMD || ekind->cosacc.cos_accel != 0);
545 if (doNoseHoover || doPROffDiagonal || doAcceleration)
548 if (!doParrinelloRahman)
550 /* We should not apply PR scaling at this step */
560 updateMDLeapfrogGeneral<AccelerationType::none>
561 (start, nrend, doNoseHoover, dt, dtPressureCouple,
562 ir, md, ekind, box, x, xprime, v, f, nh_vxi, stepM);
564 else if (ekind->bNEMD)
566 updateMDLeapfrogGeneral<AccelerationType::group>
567 (start, nrend, doNoseHoover, dt, dtPressureCouple,
568 ir, md, ekind, box, x, xprime, v, f, nh_vxi, stepM);
572 updateMDLeapfrogGeneral<AccelerationType::cosine>
573 (start, nrend, doNoseHoover, dt, dtPressureCouple,
574 ir, md, ekind, box, x, xprime, v, f, nh_vxi, stepM);
579 /* Use a simple and thus more efficient integration loop. */
580 /* The simple loop does not check for particle type (so it can
581 * be vectorized), which means we need to clear the velocities
582 * of virtual sites in advance, when present. Note that vsite
583 * velocities are computed after update and constraints from
584 * their displacement.
588 /* Note: The overhead of this loop is completely neligible */
589 clearVsiteVelocities(start, nrend, md->ptype, v);
592 /* We determine if we have a single T-coupling lambda value for all
593 * atoms. That allows for better SIMD acceleration in the template.
594 * If we do not do temperature coupling (in the run or this step),
595 * all scaling values are 1, so we effectively have a single value.
597 bool haveSingleTempScaleValue = (!doTempCouple || ekind->ngtc == 1);
599 /* Extract some pointers needed by all cases */
600 const unsigned short *cTC = md->cTC;
601 gmx::ArrayRef<const t_grp_tcstat> tcstat = ekind->tcstat;
602 const rvec *invMassPerDim = md->invMassPerDim;
604 if (doParrinelloRahman)
606 GMX_ASSERT(!doPROffDiagonal, "updateMDLeapfrogSimple only support diagonal Parrinello-Rahman scaling matrices");
609 for (int d = 0; d < DIM; d++)
614 if (haveSingleTempScaleValue)
616 updateMDLeapfrogSimple
617 <NumTempScaleValues::single,
618 ApplyParrinelloRahmanVScaling::diagonal>
619 (start, nrend, dt, dtPressureCouple,
620 invMassPerDim, tcstat, cTC, diagM, x, xprime, v, f);
624 updateMDLeapfrogSimple
625 <NumTempScaleValues::multiple,
626 ApplyParrinelloRahmanVScaling::diagonal>
627 (start, nrend, dt, dtPressureCouple,
628 invMassPerDim, tcstat, cTC, diagM, x, xprime, v, f);
633 if (haveSingleTempScaleValue)
635 /* Note that modern compilers are pretty good at vectorizing
636 * updateMDLeapfrogSimple(). But the SIMD version will still
637 * be faster because invMass lowers the cache pressure
638 * compared to invMassPerDim.
640 #if GMX_HAVE_SIMD_UPDATE
641 /* Check if we can use invmass instead of invMassPerDim */
642 if (!md->havePartiallyFrozenAtoms)
644 updateMDLeapfrogSimpleSimd
645 (start, nrend, dt, md->invmass, tcstat, x, xprime, v, f);
650 updateMDLeapfrogSimple
651 <NumTempScaleValues::single,
652 ApplyParrinelloRahmanVScaling::no>
653 (start, nrend, dt, dtPressureCouple,
654 invMassPerDim, tcstat, cTC, nullptr, x, xprime, v, f);
659 updateMDLeapfrogSimple
660 <NumTempScaleValues::multiple,
661 ApplyParrinelloRahmanVScaling::no>
662 (start, nrend, dt, dtPressureCouple,
663 invMassPerDim, tcstat, cTC, nullptr, x, xprime, v, f);
669 static void do_update_vv_vel(int start, int nrend, real dt,
670 const rvec accel[], const ivec nFreeze[], const real invmass[],
671 const unsigned short ptype[], const unsigned short cFREEZE[],
672 const unsigned short cACC[], rvec v[], const rvec f[],
673 gmx_bool bExtended, real veta, real alpha)
681 g = 0.25*dt*veta*alpha;
683 mv2 = gmx::series_sinhx(g);
690 for (n = start; n < nrend; n++)
692 real w_dt = invmass[n]*dt;
702 for (d = 0; d < DIM; d++)
704 if ((ptype[n] != eptVSite) && (ptype[n] != eptShell) && !nFreeze[gf][d])
706 v[n][d] = mv1*(mv1*v[n][d] + 0.5*(w_dt*mv2*f[n][d]))+0.5*accel[ga][d]*dt;
714 } /* do_update_vv_vel */
716 static void do_update_vv_pos(int start, int nrend, real dt,
717 const ivec nFreeze[],
718 const unsigned short ptype[], const unsigned short cFREEZE[],
719 const rvec x[], rvec xprime[], const rvec v[],
720 gmx_bool bExtended, real veta)
726 /* Would it make more sense if Parrinello-Rahman was put here? */
731 mr2 = gmx::series_sinhx(g);
739 for (n = start; n < nrend; n++)
747 for (d = 0; d < DIM; d++)
749 if ((ptype[n] != eptVSite) && (ptype[n] != eptShell) && !nFreeze[gf][d])
751 xprime[n][d] = mr1*(mr1*x[n][d]+mr2*dt*v[n][d]);
755 xprime[n][d] = x[n][d];
759 } /* do_update_vv_pos */
761 gmx_stochd_t::gmx_stochd_t(const t_inputrec *ir)
763 const t_grpopts *opts = &ir->opts;
764 const int ngtc = opts->ngtc;
770 else if (EI_SD(ir->eI))
775 for (int gt = 0; gt < ngtc; gt++)
777 if (opts->tau_t[gt] > 0)
779 sdc[gt].em = std::exp(-ir->delta_t/opts->tau_t[gt]);
783 /* No friction and noise on this group */
788 else if (ETC_ANDERSEN(ir->etc))
790 randomize_group.resize(ngtc);
791 boltzfac.resize(ngtc);
793 /* for now, assume that all groups, if randomized, are randomized at the same rate, i.e. tau_t is the same. */
794 /* since constraint groups don't necessarily match up with temperature groups! This is checked in readir.c */
796 for (int gt = 0; gt < ngtc; gt++)
798 real reft = std::max<real>(0, opts->ref_t[gt]);
799 if ((opts->tau_t[gt] > 0) && (reft > 0)) /* tau_t or ref_t = 0 means that no randomization is done */
801 randomize_group[gt] = true;
802 boltzfac[gt] = BOLTZ*opts->ref_t[gt];
806 randomize_group[gt] = false;
812 void update_temperature_constants(gmx_stochd_t *sd, const t_inputrec *ir)
816 if (ir->bd_fric != 0)
818 for (int gt = 0; gt < ir->opts.ngtc; gt++)
820 sd->bd_rf[gt] = std::sqrt(2.0*BOLTZ*ir->opts.ref_t[gt]/(ir->bd_fric*ir->delta_t));
825 for (int gt = 0; gt < ir->opts.ngtc; gt++)
827 sd->bd_rf[gt] = std::sqrt(2.0*BOLTZ*ir->opts.ref_t[gt]);
833 for (int gt = 0; gt < ir->opts.ngtc; gt++)
835 real kT = BOLTZ*ir->opts.ref_t[gt];
836 /* The mass is accounted for later, since this differs per atom */
837 sd->sdsig[gt].V = std::sqrt(kT*(1 - sd->sdc[gt].em * sd->sdc[gt].em));
842 Update::Impl::Impl(const t_inputrec *ir, BoxDeformation *boxDeformation)
844 sd = std::make_unique<gmx_stochd_t>(ir);
845 update_temperature_constants(sd.get(), ir);
846 xp.resizeWithPadding(0);
847 deform = boxDeformation;
850 void Update::setNumAtoms(int nAtoms)
853 impl_->xp.resizeWithPadding(nAtoms);
856 /*! \brief Sets the SD update type */
857 enum class SDUpdate : int
859 ForcesOnly, FrictionAndNoiseOnly, Combined
862 /*! \brief SD integrator update
864 * Two phases are required in the general case of a constrained
865 * update, the first phase from the contribution of forces, before
866 * applying constraints, and then a second phase applying the friction
867 * and noise, and then further constraining. For details, see
870 * Without constraints, the two phases can be combined, for
873 * Thus three instantiations of this templated function will be made,
874 * two with only one contribution, and one with both contributions. */
875 template <SDUpdate updateType>
877 doSDUpdateGeneral(const gmx_stochd_t &sd,
878 int start, int nrend, real dt,
879 const rvec accel[], const ivec nFreeze[],
880 const real invmass[], const unsigned short ptype[],
881 const unsigned short cFREEZE[], const unsigned short cACC[],
882 const unsigned short cTC[],
883 const rvec x[], rvec xprime[], rvec v[], const rvec f[],
884 int64_t step, int seed, const int *gatindex)
886 // cTC, cACC and cFREEZE can be nullptr any time, but various
887 // instantiations do not make sense with particular pointer
889 if (updateType == SDUpdate::ForcesOnly)
891 GMX_ASSERT(f != nullptr, "SD update with only forces requires forces");
892 GMX_ASSERT(cTC == nullptr, "SD update with only forces cannot handle temperature groups");
894 if (updateType == SDUpdate::FrictionAndNoiseOnly)
896 GMX_ASSERT(f == nullptr, "SD update with only noise cannot handle forces");
897 GMX_ASSERT(cACC == nullptr, "SD update with only noise cannot handle acceleration groups");
899 if (updateType == SDUpdate::Combined)
901 GMX_ASSERT(f != nullptr, "SD update with forces and noise requires forces");
904 // Even 0 bits internal counter gives 2x64 ints (more than enough for three table lookups)
905 gmx::ThreeFry2x64<0> rng(seed, gmx::RandomDomain::UpdateCoordinates);
906 gmx::TabulatedNormalDistribution<real, 14> dist;
908 for (int n = start; n < nrend; n++)
910 int globalAtomIndex = gatindex ? gatindex[n] : n;
911 rng.restart(step, globalAtomIndex);
914 real inverseMass = invmass[n];
915 real invsqrtMass = std::sqrt(inverseMass);
917 int freezeGroup = cFREEZE ? cFREEZE[n] : 0;
918 int accelerationGroup = cACC ? cACC[n] : 0;
919 int temperatureGroup = cTC ? cTC[n] : 0;
921 for (int d = 0; d < DIM; d++)
923 if ((ptype[n] != eptVSite) && (ptype[n] != eptShell) && !nFreeze[freezeGroup][d])
925 if (updateType == SDUpdate::ForcesOnly)
927 real vn = v[n][d] + (inverseMass*f[n][d] + accel[accelerationGroup][d])*dt;
929 // Simple position update.
930 xprime[n][d] = x[n][d] + v[n][d]*dt;
932 else if (updateType == SDUpdate::FrictionAndNoiseOnly)
935 v[n][d] = (vn*sd.sdc[temperatureGroup].em +
936 invsqrtMass*sd.sdsig[temperatureGroup].V*dist(rng));
937 // The previous phase already updated the
938 // positions with a full v*dt term that must
939 // now be half removed.
940 xprime[n][d] = xprime[n][d] + 0.5*(v[n][d] - vn)*dt;
944 real vn = v[n][d] + (inverseMass*f[n][d] + accel[accelerationGroup][d])*dt;
945 v[n][d] = (vn*sd.sdc[temperatureGroup].em +
946 invsqrtMass*sd.sdsig[temperatureGroup].V*dist(rng));
947 // Here we include half of the friction+noise
948 // update of v into the position update.
949 xprime[n][d] = x[n][d] + 0.5*(vn + v[n][d])*dt;
954 // When using constraints, the update is split into
955 // two phases, but we only need to zero the update of
956 // virtual, shell or frozen particles in at most one
958 if (updateType != SDUpdate::FrictionAndNoiseOnly)
961 xprime[n][d] = x[n][d];
968 static void do_update_bd(int start, int nrend, real dt,
969 const ivec nFreeze[],
970 const real invmass[], const unsigned short ptype[],
971 const unsigned short cFREEZE[], const unsigned short cTC[],
972 const rvec x[], rvec xprime[], rvec v[],
973 const rvec f[], real friction_coefficient,
974 const real *rf, int64_t step, int seed,
977 /* note -- these appear to be full step velocities . . . */
982 // Use 1 bit of internal counters to give us 2*2 64-bits values per stream
983 // Each 64-bit value is enough for 4 normal distribution table numbers.
984 gmx::ThreeFry2x64<0> rng(seed, gmx::RandomDomain::UpdateCoordinates);
985 gmx::TabulatedNormalDistribution<real, 14> dist;
987 if (friction_coefficient != 0)
989 invfr = 1.0/friction_coefficient;
992 for (n = start; (n < nrend); n++)
994 int ng = gatindex ? gatindex[n] : n;
996 rng.restart(step, ng);
1007 for (d = 0; (d < DIM); d++)
1009 if ((ptype[n] != eptVSite) && (ptype[n] != eptShell) && !nFreeze[gf][d])
1011 if (friction_coefficient != 0)
1013 vn = invfr*f[n][d] + rf[gt]*dist(rng);
1017 /* NOTE: invmass = 2/(mass*friction_constant*dt) */
1018 vn = 0.5*invmass[n]*f[n][d]*dt
1019 + std::sqrt(0.5*invmass[n])*rf[gt]*dist(rng);
1023 xprime[n][d] = x[n][d]+vn*dt;
1028 xprime[n][d] = x[n][d];
1034 static void calc_ke_part_normal(const rvec v[], const t_grpopts *opts, const t_mdatoms *md,
1035 gmx_ekindata_t *ekind, t_nrnb *nrnb, gmx_bool bEkinAveVel)
1038 gmx::ArrayRef<t_grp_tcstat> tcstat = ekind->tcstat;
1039 gmx::ArrayRef<t_grp_acc> grpstat = ekind->grpstat;
1041 /* three main: VV with AveVel, vv with AveEkin, leap with AveEkin. Leap with AveVel is also
1042 an option, but not supported now.
1043 bEkinAveVel: If TRUE, we sum into ekin, if FALSE, into ekinh.
1046 /* group velocities are calculated in update_ekindata and
1047 * accumulated in acumulate_groups.
1048 * Now the partial global and groups ekin.
1050 for (g = 0; (g < opts->ngtc); g++)
1052 copy_mat(tcstat[g].ekinh, tcstat[g].ekinh_old);
1055 clear_mat(tcstat[g].ekinf);
1056 tcstat[g].ekinscalef_nhc = 1.0; /* need to clear this -- logic is complicated! */
1060 clear_mat(tcstat[g].ekinh);
1063 ekind->dekindl_old = ekind->dekindl;
1064 int nthread = gmx_omp_nthreads_get(emntUpdate);
1066 #pragma omp parallel for num_threads(nthread) schedule(static)
1067 for (int thread = 0; thread < nthread; thread++)
1069 // This OpenMP only loops over arrays and does not call any functions
1070 // or memory allocation. It should not be able to throw, so for now
1071 // we do not need a try/catch wrapper.
1072 int start_t, end_t, n;
1080 start_t = ((thread+0)*md->homenr)/nthread;
1081 end_t = ((thread+1)*md->homenr)/nthread;
1083 ekin_sum = ekind->ekin_work[thread];
1084 dekindl_sum = ekind->dekindl_work[thread];
1086 for (gt = 0; gt < opts->ngtc; gt++)
1088 clear_mat(ekin_sum[gt]);
1094 for (n = start_t; n < end_t; n++)
1104 hm = 0.5*md->massT[n];
1106 for (d = 0; (d < DIM); d++)
1108 v_corrt[d] = v[n][d] - grpstat[ga].u[d];
1110 for (d = 0; (d < DIM); d++)
1112 for (m = 0; (m < DIM); m++)
1114 /* if we're computing a full step velocity, v_corrt[d] has v(t). Otherwise, v(t+dt/2) */
1115 ekin_sum[gt][m][d] += hm*v_corrt[m]*v_corrt[d];
1118 if (md->nMassPerturbed && md->bPerturbed[n])
1121 0.5*(md->massB[n] - md->massA[n])*iprod(v_corrt, v_corrt);
1127 for (int thread = 0; thread < nthread; thread++)
1129 for (g = 0; g < opts->ngtc; g++)
1133 m_add(tcstat[g].ekinf, ekind->ekin_work[thread][g],
1138 m_add(tcstat[g].ekinh, ekind->ekin_work[thread][g],
1143 ekind->dekindl += *ekind->dekindl_work[thread];
1146 inc_nrnb(nrnb, eNR_EKIN, md->homenr);
1149 static void calc_ke_part_visc(const matrix box, const rvec x[], const rvec v[],
1150 const t_grpopts *opts, const t_mdatoms *md,
1151 gmx_ekindata_t *ekind,
1152 t_nrnb *nrnb, gmx_bool bEkinAveVel)
1154 int start = 0, homenr = md->homenr;
1155 int g, d, n, m, gt = 0;
1158 gmx::ArrayRef<t_grp_tcstat> tcstat = ekind->tcstat;
1159 t_cos_acc *cosacc = &(ekind->cosacc);
1164 for (g = 0; g < opts->ngtc; g++)
1166 copy_mat(ekind->tcstat[g].ekinh, ekind->tcstat[g].ekinh_old);
1167 clear_mat(ekind->tcstat[g].ekinh);
1169 ekind->dekindl_old = ekind->dekindl;
1171 fac = 2*M_PI/box[ZZ][ZZ];
1174 for (n = start; n < start+homenr; n++)
1180 hm = 0.5*md->massT[n];
1182 /* Note that the times of x and v differ by half a step */
1183 /* MRS -- would have to be changed for VV */
1184 cosz = std::cos(fac*x[n][ZZ]);
1185 /* Calculate the amplitude of the new velocity profile */
1186 mvcos += 2*cosz*md->massT[n]*v[n][XX];
1188 copy_rvec(v[n], v_corrt);
1189 /* Subtract the profile for the kinetic energy */
1190 v_corrt[XX] -= cosz*cosacc->vcos;
1191 for (d = 0; (d < DIM); d++)
1193 for (m = 0; (m < DIM); m++)
1195 /* if we're computing a full step velocity, v_corrt[d] has v(t). Otherwise, v(t+dt/2) */
1198 tcstat[gt].ekinf[m][d] += hm*v_corrt[m]*v_corrt[d];
1202 tcstat[gt].ekinh[m][d] += hm*v_corrt[m]*v_corrt[d];
1206 if (md->nPerturbed && md->bPerturbed[n])
1208 /* The minus sign here might be confusing.
1209 * The kinetic contribution from dH/dl doesn't come from
1210 * d m(l)/2 v^2 / dl, but rather from d p^2/2m(l) / dl,
1211 * where p are the momenta. The difference is only a minus sign.
1213 dekindl -= 0.5*(md->massB[n] - md->massA[n])*iprod(v_corrt, v_corrt);
1216 ekind->dekindl = dekindl;
1217 cosacc->mvcos = mvcos;
1219 inc_nrnb(nrnb, eNR_EKIN, homenr);
1223 const rvec *x, const rvec *v, const matrix box,
1224 const t_grpopts *opts, const t_mdatoms *md,
1225 gmx_ekindata_t *ekind, t_nrnb *nrnb, gmx_bool bEkinAveVel)
1227 if (ekind->cosacc.cos_accel == 0)
1229 calc_ke_part_normal(v, opts, md, ekind, nrnb, bEkinAveVel);
1233 calc_ke_part_visc(box, x, v, opts, md, ekind, nrnb, bEkinAveVel);
1237 extern void init_ekinstate(ekinstate_t *ekinstate, const t_inputrec *ir)
1239 ekinstate->ekin_n = ir->opts.ngtc;
1240 snew(ekinstate->ekinh, ekinstate->ekin_n);
1241 snew(ekinstate->ekinf, ekinstate->ekin_n);
1242 snew(ekinstate->ekinh_old, ekinstate->ekin_n);
1243 ekinstate->ekinscalef_nhc.resize(ekinstate->ekin_n);
1244 ekinstate->ekinscaleh_nhc.resize(ekinstate->ekin_n);
1245 ekinstate->vscale_nhc.resize(ekinstate->ekin_n);
1246 ekinstate->dekindl = 0;
1247 ekinstate->mvcos = 0;
1248 ekinstate->hasReadEkinState = false;
1251 void update_ekinstate(ekinstate_t *ekinstate, const gmx_ekindata_t *ekind)
1255 for (i = 0; i < ekinstate->ekin_n; i++)
1257 copy_mat(ekind->tcstat[i].ekinh, ekinstate->ekinh[i]);
1258 copy_mat(ekind->tcstat[i].ekinf, ekinstate->ekinf[i]);
1259 copy_mat(ekind->tcstat[i].ekinh_old, ekinstate->ekinh_old[i]);
1260 ekinstate->ekinscalef_nhc[i] = ekind->tcstat[i].ekinscalef_nhc;
1261 ekinstate->ekinscaleh_nhc[i] = ekind->tcstat[i].ekinscaleh_nhc;
1262 ekinstate->vscale_nhc[i] = ekind->tcstat[i].vscale_nhc;
1265 copy_mat(ekind->ekin, ekinstate->ekin_total);
1266 ekinstate->dekindl = ekind->dekindl;
1267 ekinstate->mvcos = ekind->cosacc.mvcos;
1271 void restore_ekinstate_from_state(const t_commrec *cr,
1272 gmx_ekindata_t *ekind, const ekinstate_t *ekinstate)
1278 for (i = 0; i < ekinstate->ekin_n; i++)
1280 copy_mat(ekinstate->ekinh[i], ekind->tcstat[i].ekinh);
1281 copy_mat(ekinstate->ekinf[i], ekind->tcstat[i].ekinf);
1282 copy_mat(ekinstate->ekinh_old[i], ekind->tcstat[i].ekinh_old);
1283 ekind->tcstat[i].ekinscalef_nhc = ekinstate->ekinscalef_nhc[i];
1284 ekind->tcstat[i].ekinscaleh_nhc = ekinstate->ekinscaleh_nhc[i];
1285 ekind->tcstat[i].vscale_nhc = ekinstate->vscale_nhc[i];
1288 copy_mat(ekinstate->ekin_total, ekind->ekin);
1290 ekind->dekindl = ekinstate->dekindl;
1291 ekind->cosacc.mvcos = ekinstate->mvcos;
1292 n = ekinstate->ekin_n;
1297 gmx_bcast(sizeof(n), &n, cr);
1298 for (i = 0; i < n; i++)
1300 gmx_bcast(DIM*DIM*sizeof(ekind->tcstat[i].ekinh[0][0]),
1301 ekind->tcstat[i].ekinh[0], cr);
1302 gmx_bcast(DIM*DIM*sizeof(ekind->tcstat[i].ekinf[0][0]),
1303 ekind->tcstat[i].ekinf[0], cr);
1304 gmx_bcast(DIM*DIM*sizeof(ekind->tcstat[i].ekinh_old[0][0]),
1305 ekind->tcstat[i].ekinh_old[0], cr);
1307 gmx_bcast(sizeof(ekind->tcstat[i].ekinscalef_nhc),
1308 &(ekind->tcstat[i].ekinscalef_nhc), cr);
1309 gmx_bcast(sizeof(ekind->tcstat[i].ekinscaleh_nhc),
1310 &(ekind->tcstat[i].ekinscaleh_nhc), cr);
1311 gmx_bcast(sizeof(ekind->tcstat[i].vscale_nhc),
1312 &(ekind->tcstat[i].vscale_nhc), cr);
1314 gmx_bcast(DIM*DIM*sizeof(ekind->ekin[0][0]),
1315 ekind->ekin[0], cr);
1317 gmx_bcast(sizeof(ekind->dekindl), &ekind->dekindl, cr);
1318 gmx_bcast(sizeof(ekind->cosacc.mvcos), &ekind->cosacc.mvcos, cr);
1322 void update_tcouple(int64_t step,
1323 const t_inputrec *inputrec,
1325 gmx_ekindata_t *ekind,
1326 const t_extmass *MassQ,
1327 const t_mdatoms *md)
1330 // This condition was explicitly checked in previous version, but should have never been satisfied
1331 GMX_ASSERT(!(EI_VV(inputrec->eI) &&
1332 (inputrecNvtTrotter(inputrec) || inputrecNptTrotter(inputrec) || inputrecNphTrotter(inputrec))),
1333 "Temperature coupling was requested with velocity verlet and trotter");
1335 bool doTemperatureCoupling = false;
1337 // For VV temperature coupling parameters are updated on the current
1338 // step, for the others - one step before.
1339 if (inputrec->etc == etcNO)
1341 doTemperatureCoupling = false;
1343 else if (EI_VV(inputrec->eI))
1345 doTemperatureCoupling = do_per_step(step, inputrec->nsttcouple);
1349 doTemperatureCoupling = do_per_step(step + inputrec->nsttcouple - 1, inputrec->nsttcouple);
1352 if (doTemperatureCoupling)
1354 real dttc = inputrec->nsttcouple*inputrec->delta_t;
1356 //TODO: berendsen_tcoupl(...), nosehoover_tcoupl(...) and vrescale_tcoupl(...) update
1357 // temperature coupling parameters, which should be reflected in the name of these
1359 switch (inputrec->etc)
1364 berendsen_tcoupl(inputrec, ekind, dttc, state->therm_integral);
1367 nosehoover_tcoupl(&(inputrec->opts), ekind, dttc,
1368 state->nosehoover_xi.data(), state->nosehoover_vxi.data(), MassQ);
1371 vrescale_tcoupl(inputrec, step, ekind, dttc,
1372 state->therm_integral.data());
1375 /* rescale in place here */
1376 if (EI_VV(inputrec->eI))
1378 rescale_velocities(ekind, md, 0, md->homenr, state->v.rvec_array());
1383 // Set the T scaling lambda to 1 to have no scaling
1384 // TODO: Do we have to do it on every non-t-couple step?
1385 for (int i = 0; (i < inputrec->opts.ngtc); i++)
1387 ekind->tcstat[i].lambda = 1.0;
1392 /*! \brief Computes the atom range for a thread to operate on, ensured SIMD aligned ranges
1394 * \param[in] numThreads The number of threads to divide atoms over
1395 * \param[in] threadIndex The thread to get the range for
1396 * \param[in] numAtoms The total number of atoms (on this rank)
1397 * \param[out] startAtom The start of the atom range
1398 * \param[out] endAtom The end of the atom range, note that this is in general not a multiple of the SIMD width
1400 static void getThreadAtomRange(int numThreads, int threadIndex, int numAtoms,
1401 int *startAtom, int *endAtom)
1403 #if GMX_HAVE_SIMD_UPDATE
1404 constexpr int blockSize = GMX_SIMD_REAL_WIDTH;
1406 constexpr int blockSize = 1;
1408 int numBlocks = (numAtoms + blockSize - 1)/blockSize;
1410 *startAtom = ((numBlocks* threadIndex )/numThreads)*blockSize;
1411 *endAtom = ((numBlocks*(threadIndex + 1))/numThreads)*blockSize;
1412 if (threadIndex == numThreads - 1)
1414 *endAtom = numAtoms;
1418 void update_pcouple_before_coordinates(FILE *fplog,
1420 const t_inputrec *inputrec,
1422 matrix parrinellorahmanMu,
1426 /* Berendsen P-coupling is completely handled after the coordinate update.
1427 * Trotter P-coupling is handled by separate calls to trotter_update().
1429 if (inputrec->epc == epcPARRINELLORAHMAN &&
1430 do_per_step(step + inputrec->nstpcouple - 1, inputrec->nstpcouple))
1432 real dtpc = inputrec->nstpcouple*inputrec->delta_t;
1434 parrinellorahman_pcoupl(fplog, step, inputrec, dtpc, state->pres_prev,
1435 state->box, state->box_rel, state->boxv,
1436 M, parrinellorahmanMu, bInitStep);
1440 void constrain_velocities(int64_t step,
1441 real *dvdlambda, /* the contribution to be added to the bonded interactions */
1444 gmx::Constraints *constr,
1456 * APPLY CONSTRAINTS:
1463 /* clear out constraints before applying */
1464 clear_mat(vir_part);
1466 /* Constrain the coordinates upd->xp */
1467 constr->apply(do_log, do_ene,
1469 state->x.rvec_array(), state->v.rvec_array(), state->v.rvec_array(),
1471 state->lambda[efptBONDED], dvdlambda,
1472 nullptr, bCalcVir ? &vir_con : nullptr, ConstraintVariable::Velocities);
1476 m_add(vir_part, vir_con, vir_part);
1481 void constrain_coordinates(int64_t step,
1482 real *dvdlambda, /* the contribution to be added to the bonded interactions */
1486 gmx::Constraints *constr,
1499 /* clear out constraints before applying */
1500 clear_mat(vir_part);
1502 /* Constrain the coordinates upd->xp */
1503 constr->apply(do_log, do_ene,
1505 state->x.rvec_array(), upd->xp()->rvec_array(), nullptr,
1507 state->lambda[efptBONDED], dvdlambda,
1508 as_rvec_array(state->v.data()), bCalcVir ? &vir_con : nullptr, ConstraintVariable::Positions);
1512 m_add(vir_part, vir_con, vir_part);
1518 update_sd_second_half(int64_t step,
1519 real *dvdlambda, /* the contribution to be added to the bonded interactions */
1520 const t_inputrec *inputrec, /* input record and box stuff */
1521 const t_mdatoms *md,
1523 const t_commrec *cr,
1525 gmx_wallcycle_t wcycle,
1527 gmx::Constraints *constr,
1535 if (inputrec->eI == eiSD1)
1537 int homenr = md->homenr;
1539 /* Cast delta_t from double to real to make the integrators faster.
1540 * The only reason for having delta_t double is to get accurate values
1541 * for t=delta_t*step when step is larger than float precision.
1542 * For integration dt the accuracy of real suffices, since with
1543 * integral += dt*integrand the increment is nearly always (much) smaller
1544 * than the integral (and the integrand has real precision).
1546 real dt = inputrec->delta_t;
1548 wallcycle_start(wcycle, ewcUPDATE);
1550 int nth = gmx_omp_nthreads_get(emntUpdate);
1552 #pragma omp parallel for num_threads(nth) schedule(static)
1553 for (int th = 0; th < nth; th++)
1557 int start_th, end_th;
1558 getThreadAtomRange(nth, th, homenr, &start_th, &end_th);
1560 doSDUpdateGeneral<SDUpdate::FrictionAndNoiseOnly>
1562 start_th, end_th, dt,
1563 inputrec->opts.acc, inputrec->opts.nFreeze,
1564 md->invmass, md->ptype,
1565 md->cFREEZE, nullptr, md->cTC,
1566 state->x.rvec_array(), upd->xp()->rvec_array(),
1567 state->v.rvec_array(), nullptr,
1568 step, inputrec->ld_seed,
1569 DOMAINDECOMP(cr) ? cr->dd->globalAtomIndices.data() : nullptr);
1571 GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
1573 inc_nrnb(nrnb, eNR_UPDATE, homenr);
1574 wallcycle_stop(wcycle, ewcUPDATE);
1576 /* Constrain the coordinates upd->xp for half a time step */
1577 constr->apply(do_log, do_ene,
1579 state->x.rvec_array(), upd->xp()->rvec_array(), nullptr,
1581 state->lambda[efptBONDED], dvdlambda,
1582 as_rvec_array(state->v.data()), nullptr, ConstraintVariable::Positions);
1586 void finish_update(const t_inputrec *inputrec, /* input record and box stuff */
1587 const t_mdatoms *md,
1589 const t_graph *graph,
1591 gmx_wallcycle_t wcycle,
1593 const gmx::Constraints *constr)
1595 int homenr = md->homenr;
1597 /* We must always unshift after updating coordinates; if we did not shake
1598 x was shifted in do_force */
1600 /* NOTE Currently we always integrate to a temporary buffer and
1601 * then copy the results back. */
1603 wallcycle_start_nocount(wcycle, ewcUPDATE);
1605 if (md->cFREEZE != nullptr && constr != nullptr)
1607 /* If we have atoms that are frozen along some, but not all
1608 * dimensions, then any constraints will have moved them also along
1609 * the frozen dimensions. To freeze such degrees of freedom
1610 * we copy them back here to later copy them forward. It would
1611 * be more elegant and slightly more efficient to copies zero
1612 * times instead of twice, but the graph case below prevents this.
1614 const ivec *nFreeze = inputrec->opts.nFreeze;
1615 bool partialFreezeAndConstraints = false;
1616 for (int g = 0; g < inputrec->opts.ngfrz; g++)
1618 int numFreezeDim = nFreeze[g][XX] + nFreeze[g][YY] + nFreeze[g][ZZ];
1619 if (numFreezeDim > 0 && numFreezeDim < 3)
1621 partialFreezeAndConstraints = true;
1624 if (partialFreezeAndConstraints)
1626 auto xp = makeArrayRef(*upd->xp()).subArray(0, homenr);
1627 auto x = makeConstArrayRef(state->x).subArray(0, homenr);
1628 for (int i = 0; i < homenr; i++)
1630 int g = md->cFREEZE[i];
1632 for (int d = 0; d < DIM; d++)
1643 if (graph && (graph->nnodes > 0))
1645 unshift_x(graph, state->box, state->x.rvec_array(), upd->xp()->rvec_array());
1646 if (TRICLINIC(state->box))
1648 inc_nrnb(nrnb, eNR_SHIFTX, 2*graph->nnodes);
1652 inc_nrnb(nrnb, eNR_SHIFTX, graph->nnodes);
1657 auto xp = makeConstArrayRef(*upd->xp()).subArray(0, homenr);
1658 auto x = makeArrayRef(state->x).subArray(0, homenr);
1659 #ifndef __clang_analyzer__
1660 int gmx_unused nth = gmx_omp_nthreads_get(emntUpdate);
1662 #pragma omp parallel for num_threads(nth) schedule(static)
1663 for (int i = 0; i < homenr; i++)
1665 // Trivial statement, does not throw
1669 wallcycle_stop(wcycle, ewcUPDATE);
1671 /* ############# END the update of velocities and positions ######### */
1674 void update_pcouple_after_coordinates(FILE *fplog,
1676 const t_inputrec *inputrec,
1677 const t_mdatoms *md,
1678 const matrix pressure,
1679 const matrix forceVirial,
1680 const matrix constraintVirial,
1681 const matrix parrinellorahmanMu,
1687 int homenr = md->homenr;
1689 /* Cast to real for faster code, no loss in precision (see comment above) */
1690 real dt = inputrec->delta_t;
1693 /* now update boxes */
1694 switch (inputrec->epc)
1698 case (epcBERENDSEN):
1699 if (do_per_step(step, inputrec->nstpcouple))
1701 real dtpc = inputrec->nstpcouple*dt;
1703 berendsen_pcoupl(fplog, step, inputrec, dtpc,
1704 pressure, state->box,
1705 forceVirial, constraintVirial,
1706 mu, &state->baros_integral);
1707 berendsen_pscale(inputrec, mu, state->box, state->box_rel,
1708 start, homenr, state->x.rvec_array(),
1712 case (epcPARRINELLORAHMAN):
1713 if (do_per_step(step + inputrec->nstpcouple - 1, inputrec->nstpcouple))
1715 /* The box velocities were updated in do_pr_pcoupl,
1716 * but we dont change the box vectors until we get here
1717 * since we need to be able to shift/unshift above.
1719 real dtpc = inputrec->nstpcouple*dt;
1720 for (int i = 0; i < DIM; i++)
1722 for (int m = 0; m <= i; m++)
1724 state->box[i][m] += dtpc*state->boxv[i][m];
1727 preserve_box_shape(inputrec, state->box_rel, state->box);
1729 /* Scale the coordinates */
1730 auto x = state->x.rvec_array();
1731 for (int n = start; n < start + homenr; n++)
1733 tmvmul_ur0(parrinellorahmanMu, x[n], x[n]);
1738 switch (inputrec->epct)
1740 case (epctISOTROPIC):
1741 /* DIM * eta = ln V. so DIM*eta_new = DIM*eta_old + DIM*dt*veta =>
1742 ln V_new = ln V_old + 3*dt*veta => V_new = V_old*exp(3*dt*veta) =>
1743 Side length scales as exp(veta*dt) */
1745 msmul(state->box, std::exp(state->veta*dt), state->box);
1747 /* Relate veta to boxv. veta = d(eta)/dT = (1/DIM)*1/V dV/dT.
1748 o If we assume isotropic scaling, and box length scaling
1749 factor L, then V = L^DIM (det(M)). So dV/dt = DIM
1750 L^(DIM-1) dL/dt det(M), and veta = (1/L) dL/dt. The
1751 determinant of B is L^DIM det(M), and the determinant
1752 of dB/dt is (dL/dT)^DIM det (M). veta will be
1753 (det(dB/dT)/det(B))^(1/3). Then since M =
1754 B_new*(vol_new)^(1/3), dB/dT_new = (veta_new)*B(new). */
1756 msmul(state->box, state->veta, state->boxv);
1768 auto localX = makeArrayRef(state->x).subArray(start, homenr);
1769 upd->deform()->apply(localX, state->box, step);
1773 void update_coords(int64_t step,
1774 const t_inputrec *inputrec, /* input record and box stuff */
1775 const t_mdatoms *md,
1777 gmx::ArrayRefWithPadding<const gmx::RVec> f,
1778 const t_fcdata *fcd,
1779 const gmx_ekindata_t *ekind,
1783 const t_commrec *cr, /* these shouldn't be here -- need to think about it */
1784 const gmx::Constraints *constr)
1786 gmx_bool bDoConstr = (nullptr != constr);
1788 /* Running the velocity half does nothing except for velocity verlet */
1789 if ((UpdatePart == etrtVELOCITY1 || UpdatePart == etrtVELOCITY2) &&
1790 !EI_VV(inputrec->eI))
1792 gmx_incons("update_coords called for velocity without VV integrator");
1795 int homenr = md->homenr;
1797 /* Cast to real for faster code, no loss in precision (see comment above) */
1798 real dt = inputrec->delta_t;
1800 /* We need to update the NMR restraint history when time averaging is used */
1801 if (state->flags & (1<<estDISRE_RM3TAV))
1803 update_disres_history(fcd, &state->hist);
1805 if (state->flags & (1<<estORIRE_DTAV))
1807 update_orires_history(fcd, &state->hist);
1810 /* ############# START The update of velocities and positions ######### */
1811 int nth = gmx_omp_nthreads_get(emntUpdate);
1813 #pragma omp parallel for num_threads(nth) schedule(static)
1814 for (int th = 0; th < nth; th++)
1818 int start_th, end_th;
1819 getThreadAtomRange(nth, th, homenr, &start_th, &end_th);
1821 const rvec *x_rvec = state->x.rvec_array();
1822 rvec *xp_rvec = upd->xp()->rvec_array();
1823 rvec *v_rvec = state->v.rvec_array();
1824 const rvec *f_rvec = as_rvec_array(f.unpaddedArrayRef().data());
1826 switch (inputrec->eI)
1829 do_update_md(start_th, end_th, step, dt,
1830 inputrec, md, ekind, state->box,
1831 x_rvec, xp_rvec, v_rvec, f_rvec,
1832 state->nosehoover_vxi.data(), M);
1837 // With constraints, the SD update is done in 2 parts
1838 doSDUpdateGeneral<SDUpdate::ForcesOnly>
1840 start_th, end_th, dt,
1841 inputrec->opts.acc, inputrec->opts.nFreeze,
1842 md->invmass, md->ptype,
1843 md->cFREEZE, md->cACC, nullptr,
1844 x_rvec, xp_rvec, v_rvec, f_rvec,
1845 step, inputrec->ld_seed, nullptr);
1849 doSDUpdateGeneral<SDUpdate::Combined>
1851 start_th, end_th, dt,
1852 inputrec->opts.acc, inputrec->opts.nFreeze,
1853 md->invmass, md->ptype,
1854 md->cFREEZE, md->cACC, md->cTC,
1855 x_rvec, xp_rvec, v_rvec, f_rvec,
1856 step, inputrec->ld_seed,
1857 DOMAINDECOMP(cr) ? cr->dd->globalAtomIndices.data() : nullptr);
1861 do_update_bd(start_th, end_th, dt,
1862 inputrec->opts.nFreeze, md->invmass, md->ptype,
1863 md->cFREEZE, md->cTC,
1864 x_rvec, xp_rvec, v_rvec, f_rvec,
1866 upd->sd()->bd_rf.data(),
1867 step, inputrec->ld_seed, DOMAINDECOMP(cr) ? cr->dd->globalAtomIndices.data() : nullptr);
1872 gmx_bool bExtended = (inputrec->etc == etcNOSEHOOVER ||
1873 inputrec->epc == epcPARRINELLORAHMAN ||
1874 inputrec->epc == epcMTTK);
1876 /* assuming barostat coupled to group 0 */
1877 real alpha = 1.0 + DIM/static_cast<real>(inputrec->opts.nrdf[0]);
1882 do_update_vv_vel(start_th, end_th, dt,
1883 inputrec->opts.acc, inputrec->opts.nFreeze,
1884 md->invmass, md->ptype,
1885 md->cFREEZE, md->cACC,
1887 bExtended, state->veta, alpha);
1890 do_update_vv_pos(start_th, end_th, dt,
1891 inputrec->opts.nFreeze,
1892 md->ptype, md->cFREEZE,
1893 x_rvec, xp_rvec, v_rvec,
1894 bExtended, state->veta);
1900 gmx_fatal(FARGS, "Don't know how to update coordinates");
1903 GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
1908 extern gmx_bool update_randomize_velocities(const t_inputrec *ir, int64_t step, const t_commrec *cr,
1909 const t_mdatoms *md,
1910 gmx::ArrayRef<gmx::RVec> v,
1912 const gmx::Constraints *constr)
1915 real rate = (ir->delta_t)/ir->opts.tau_t[0];
1917 if (ir->etc == etcANDERSEN && constr != nullptr)
1919 /* Currently, Andersen thermostat does not support constrained
1920 systems. Functionality exists in the andersen_tcoupl
1921 function in GROMACS 4.5.7 to allow this combination. That
1922 code could be ported to the current random-number
1923 generation approach, but has not yet been done because of
1924 lack of time and resources. */
1925 gmx_fatal(FARGS, "Normal Andersen is currently not supported with constraints, use massive Andersen instead");
1928 /* proceed with andersen if 1) it's fixed probability per
1929 particle andersen or 2) it's massive andersen and it's tau_t/dt */
1930 if ((ir->etc == etcANDERSEN) || do_per_step(step, roundToInt(1.0/rate)))
1932 andersen_tcoupl(ir, step, cr, md, v, rate,
1933 upd->sd()->randomize_group,
1934 upd->sd()->boltzfac);