src/gromacs/mdlib/constr.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /*! \internal \file
  39  * \brief Defines the high-level constraint code.
  40  *
  41  * \author Berk Hess <hess@kth.se>
  42  * \author Mark Abraham <mark.j.abraham@gmail.com>
  43  * \ingroup module_mdlib
  44  */
  45 #include "gmxpre.h"
  46
  47 #include "constr.h"
  48
  49 #include <cassert>
  50 #include <cmath>
  51 #include <cstdlib>
  52
  53 #include <algorithm>
  54
  55 #include "gromacs/domdec/domdec.h"
  56 #include "gromacs/domdec/domdec_struct.h"
  57 #include "gromacs/essentialdynamics/edsam.h"
  58 #include "gromacs/fileio/confio.h"
  59 #include "gromacs/fileio/gmxfio.h"
  60 #include "gromacs/fileio/pdbio.h"
  61 #include "gromacs/gmxlib/nrnb.h"
  62 #include "gromacs/math/utilities.h"
  63 #include "gromacs/math/vec.h"
  64 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  65 #include "gromacs/mdlib/lincs.h"
  66 #include "gromacs/mdlib/settle.h"
  67 #include "gromacs/mdlib/shake.h"
  68 #include "gromacs/mdtypes/commrec.h"
  69 #include "gromacs/mdtypes/inputrec.h"
  70 #include "gromacs/mdtypes/md_enums.h"
  71 #include "gromacs/mdtypes/mdatom.h"
  72 #include "gromacs/mdtypes/state.h"
  73 #include "gromacs/pbcutil/pbc.h"
  74 #include "gromacs/pulling/pull.h"
  75 #include "gromacs/timing/wallcycle.h"
  76 #include "gromacs/topology/ifunc.h"
  77 #include "gromacs/topology/mtop_lookup.h"
  78 #include "gromacs/topology/mtop_util.h"
  79 #include "gromacs/utility/arrayref.h"
  80 #include "gromacs/utility/exceptions.h"
  81 #include "gromacs/utility/fatalerror.h"
  82 #include "gromacs/utility/gmxassert.h"
  83 #include "gromacs/utility/listoflists.h"
  84 #include "gromacs/utility/pleasecite.h"
  85 #include "gromacs/utility/txtdump.h"
  86
  87 namespace gmx
  88 {
  89
  90 /* \brief Impl class for Constraints
  91  *
  92  * \todo Members like md, idef are valid only for the lifetime of a
  93  * domain, which would be good to make clearer in the structure of the
  94  * code. It should not be possible to call apply() if setConstraints()
  95  * has not been called. For example, this could be achieved if
  96  * setConstraints returned a valid object with such a method.  That
  97  * still requires that we manage the lifetime of that object
  98  * correctly, however. */
  99 class Constraints::Impl
 100 {
 101 public:
 102     Impl(const gmx_mtop_t&     mtop_p,
 103          const t_inputrec&     ir_p,
 104          pull_t*               pull_work,
 105          FILE*                 log_p,
 106          const t_mdatoms&      md_p,
 107          const t_commrec*      cr_p,
 108          const gmx_multisim_t* ms,
 109          t_nrnb*               nrnb,
 110          gmx_wallcycle*        wcycle_p,
 111          bool                  pbcHandlingRequired,
 112          int                   numConstraints,
 113          int                   numSettles);
 114     ~Impl();
 115     void setConstraints(gmx_localtop_t* top, const t_mdatoms& md);
 116     bool apply(bool                      bLog,
 117                bool                      bEner,
 118                int64_t                   step,
 119                int                       delta_step,
 120                real                      step_scaling,
 121                ArrayRefWithPadding<RVec> x,
 122                ArrayRefWithPadding<RVec> xprime,
 123                ArrayRef<RVec>            min_proj,
 124                const matrix              box,
 125                real                      lambda,
 126                real*                     dvdlambda,
 127                ArrayRefWithPadding<RVec> v,
 128                tensor*                   vir,
 129                ConstraintVariable        econq);
 130     //! The total number of constraints.
 131     int ncon_tot = 0;
 132     //! The number of flexible constraints.
 133     int nflexcon = 0;
 134     //! A list of atoms to constraints for each moleculetype.
 135     std::vector<ListOfLists<int>> at2con_mt;
 136     //! A list of atoms to settles for each moleculetype
 137     std::vector<std::vector<int>> at2settle_mt;
 138     //! LINCS data.
 139     Lincs* lincsd = nullptr; // TODO this should become a unique_ptr
 140     //! SHAKE data.
 141     std::unique_ptr<shakedata> shaked;
 142     //! SETTLE data.
 143     settledata* settled = nullptr;
 144     //! The maximum number of warnings.
 145     int maxwarn = 0;
 146     //! The number of warnings for LINCS.
 147     int warncount_lincs = 0;
 148     //! The number of warnings for SETTLE.
 149     int warncount_settle = 0;
 150     //! The essential dynamics data.
 151     gmx_edsam* ed = nullptr;
 152
 153     //! Thread-local virial contribution.
 154     tensor* vir_r_m_dr_th = { nullptr };
 155     //! Did a settle error occur?
 156     bool* bSettleErrorHasOccurred = nullptr;
 157
 158     //! Pointer to the global topology - only used for printing warnings.
 159     const gmx_mtop_t& mtop;
 160     //! Parameters for the interactions in this domain.
 161     const InteractionDefinitions* idef = nullptr;
 162     //! Data about atoms in this domain.
 163     const t_mdatoms& md;
 164     //! Whether we need to do pbc for handling bonds.
 165     bool pbcHandlingRequired_ = false;
 166
 167     //! Logging support.
 168     FILE* log = nullptr;
 169     //! Communication support.
 170     const t_commrec* cr = nullptr;
 171     //! Multi-sim support.
 172     const gmx_multisim_t* ms = nullptr;
 173     //! Pulling code object, if any.
 174     pull_t* pull_work = nullptr;
 175     /*!\brief Input options.
 176      *
 177      * \todo Replace with IMdpOptions */
 178     const t_inputrec& ir;
 179     //! Flop counting support.
 180     t_nrnb* nrnb = nullptr;
 181     //! Tracks wallcycle usage.
 182     gmx_wallcycle* wcycle;
 183 };
 184
 185 Constraints::~Constraints() = default;
 186
 187 int Constraints::numFlexibleConstraints() const
 188 {
 189     return impl_->nflexcon;
 190 }
 191
 192 bool Constraints::havePerturbedConstraints() const
 193 {
 194     const gmx_ffparams_t& ffparams = impl_->mtop.ffparams;
 195
 196     for (size_t i = 0; i < ffparams.functype.size(); i++)
 197     {
 198         if ((ffparams.functype[i] == F_CONSTR || ffparams.functype[i] == F_CONSTRNC)
 199             && ffparams.iparams[i].constr.dA != ffparams.iparams[i].constr.dB)
 200         {
 201             return true;
 202         }
 203     }
 204
 205     return false;
 206 }
 207
 208 //! Clears constraint quantities for atoms in nonlocal region.
 209 static void clear_constraint_quantity_nonlocal(gmx_domdec_t* dd, ArrayRef<RVec> q)
 210 {
 211     int nonlocal_at_start, nonlocal_at_end, at;
 212
 213     dd_get_constraint_range(dd, &nonlocal_at_start, &nonlocal_at_end);
 214
 215     for (at = nonlocal_at_start; at < nonlocal_at_end; at++)
 216     {
 217         clear_rvec(q[at]);
 218     }
 219 }
 220
 221 void too_many_constraint_warnings(int eConstrAlg, int warncount)
 222 {
 223     gmx_fatal(
 224             FARGS,
 225             "Too many %s warnings (%d)\n"
 226             "If you know what you are doing you can %s"
 227             "set the environment variable GMX_MAXCONSTRWARN to -1,\n"
 228             "but normally it is better to fix the problem",
 229             (eConstrAlg == econtLINCS) ? "LINCS" : "SETTLE", warncount,
 230             (eConstrAlg == econtLINCS) ? "adjust the lincs warning threshold in your mdp file\nor " : "\n");
 231 }
 232
 233 //! Writes out coordinates.
 234 static void write_constr_pdb(const char*          fn,
 235                              const char*          title,
 236                              const gmx_mtop_t&    mtop,
 237                              int                  start,
 238                              int                  homenr,
 239                              const t_commrec*     cr,
 240                              ArrayRef<const RVec> x,
 241                              const matrix         box)
 242 {
 243     char          fname[STRLEN];
 244     FILE*         out;
 245     int           dd_ac0 = 0, dd_ac1 = 0, i, ii, resnr;
 246     gmx_domdec_t* dd;
 247     const char *  anm, *resnm;
 248
 249     dd = nullptr;
 250     if (DOMAINDECOMP(cr))
 251     {
 252         dd = cr->dd;
 253         dd_get_constraint_range(dd, &dd_ac0, &dd_ac1);
 254         start  = 0;
 255         homenr = dd_ac1;
 256     }
 257
 258     if (PAR(cr))
 259     {
 260         sprintf(fname, "%s_n%d.pdb", fn, cr->sim_nodeid);
 261     }
 262     else
 263     {
 264         sprintf(fname, "%s.pdb", fn);
 265     }
 266
 267     out = gmx_fio_fopen(fname, "w");
 268
 269     fprintf(out, "TITLE     %s\n", title);
 270     gmx_write_pdb_box(out, PbcType::Unset, box);
 271     int molb = 0;
 272     for (i = start; i < start + homenr; i++)
 273     {
 274         if (dd != nullptr)
 275         {
 276             if (i >= dd_numHomeAtoms(*dd) && i < dd_ac0)
 277             {
 278                 continue;
 279             }
 280             ii = dd->globalAtomIndices[i];
 281         }
 282         else
 283         {
 284             ii = i;
 285         }
 286         mtopGetAtomAndResidueName(mtop, ii, &molb, &anm, &resnr, &resnm, nullptr);
 287         gmx_fprintf_pdb_atomline(out, epdbATOM, ii + 1, anm, ' ', resnm, ' ', resnr, ' ',
 288                                  10 * x[i][XX], 10 * x[i][YY], 10 * x[i][ZZ], 1.0, 0.0, "");
 289     }
 290     fprintf(out, "TER\n");
 291
 292     gmx_fio_fclose(out);
 293 }
 294
 295 //! Writes out domain contents to help diagnose crashes.
 296 static void dump_confs(FILE*                log,
 297                        int64_t              step,
 298                        const gmx_mtop_t&    mtop,
 299                        int                  start,
 300                        int                  homenr,
 301                        const t_commrec*     cr,
 302                        ArrayRef<const RVec> x,
 303                        ArrayRef<const RVec> xprime,
 304                        const matrix         box)
 305 {
 306     char buf[STRLEN], buf2[22];
 307
 308     char* env = getenv("GMX_SUPPRESS_DUMP");
 309     if (env)
 310     {
 311         return;
 312     }
 313
 314     sprintf(buf, "step%sb", gmx_step_str(step, buf2));
 315     write_constr_pdb(buf, "initial coordinates", mtop, start, homenr, cr, x, box);
 316     sprintf(buf, "step%sc", gmx_step_str(step, buf2));
 317     write_constr_pdb(buf, "coordinates after constraining", mtop, start, homenr, cr, xprime, box);
 318     if (log)
 319     {
 320         fprintf(log, "Wrote pdb files with previous and current coordinates\n");
 321     }
 322     fprintf(stderr, "Wrote pdb files with previous and current coordinates\n");
 323 }
 324
 325 bool Constraints::apply(bool                      bLog,
 326                         bool                      bEner,
 327                         int64_t                   step,
 328                         int                       delta_step,
 329                         real                      step_scaling,
 330                         ArrayRefWithPadding<RVec> x,
 331                         ArrayRefWithPadding<RVec> xprime,
 332                         ArrayRef<RVec>            min_proj,
 333                         const matrix              box,
 334                         real                      lambda,
 335                         real*                     dvdlambda,
 336                         ArrayRefWithPadding<RVec> v,
 337                         tensor*                   vir,
 338                         ConstraintVariable        econq)
 339 {
 340     return impl_->apply(bLog, bEner, step, delta_step, step_scaling, std::move(x), std::move(xprime),
 341                         min_proj, box, lambda, dvdlambda, std::move(v), vir, econq);
 342 }
 343
 344 bool Constraints::Impl::apply(bool                      bLog,
 345                               bool                      bEner,
 346                               int64_t                   step,
 347                               int                       delta_step,
 348                               real                      step_scaling,
 349                               ArrayRefWithPadding<RVec> x,
 350                               ArrayRefWithPadding<RVec> xprime,
 351                               ArrayRef<RVec>            min_proj,
 352                               const matrix              box,
 353                               real                      lambda,
 354                               real*                     dvdlambda,
 355                               ArrayRefWithPadding<RVec> v,
 356                               tensor*                   vir,
 357                               ConstraintVariable        econq)
 358 {
 359     bool   bOK, bDump;
 360     int    start, homenr;
 361     tensor vir_r_m_dr;
 362     real   scaled_delta_t;
 363     real   invdt, vir_fac = 0, t;
 364     int    nsettle;
 365     t_pbc  pbc, *pbc_null;
 366     char   buf[22];
 367     int    nth;
 368
 369     wallcycle_start(wcycle, ewcCONSTR);
 370
 371     if (econq == ConstraintVariable::ForceDispl && !EI_ENERGY_MINIMIZATION(ir.eI))
 372     {
 373         gmx_incons(
 374                 "constrain called for forces displacements while not doing energy minimization, "
 375                 "can not do this while the LINCS and SETTLE constraint connection matrices are "
 376                 "mass weighted");
 377     }
 378
 379     bOK   = TRUE;
 380     bDump = FALSE;
 381
 382     start  = 0;
 383     homenr = md.homenr;
 384
 385     scaled_delta_t = step_scaling * ir.delta_t;
 386
 387     /* Prepare time step for use in constraint implementations, and
 388        avoid generating inf when ir.delta_t = 0. */
 389     if (ir.delta_t == 0)
 390     {
 391         invdt = 0.0;
 392     }
 393     else
 394     {
 395         invdt = 1.0 / scaled_delta_t;
 396     }
 397
 398     if (ir.efep != efepNO && EI_DYNAMICS(ir.eI))
 399     {
 400         /* Set the constraint lengths for the step at which this configuration
 401          * is meant to be. The invmasses should not be changed.
 402          */
 403         lambda += delta_step * ir.fepvals->delta_lambda;
 404     }
 405
 406     if (vir != nullptr)
 407     {
 408         clear_mat(vir_r_m_dr);
 409     }
 410     const InteractionList& settle = idef->il[F_SETTLE];
 411     nsettle                       = settle.size() / (1 + NRAL(F_SETTLE));
 412
 413     if (nsettle > 0)
 414     {
 415         nth = gmx_omp_nthreads_get(emntSETTLE);
 416     }
 417     else
 418     {
 419         nth = 1;
 420     }
 421
 422     /* We do not need full pbc when constraints do not cross update groups
 423      * i.e. when dd->constraint_comm==NULL.
 424      * Note that PBC for constraints is different from PBC for bondeds.
 425      * For constraints there is both forward and backward communication.
 426      */
 427     if (ir.pbcType != PbcType::No && (cr->dd || pbcHandlingRequired_)
 428         && !(cr->dd && cr->dd->constraint_comm == nullptr))
 429     {
 430         /* With pbc=screw the screw has been changed to a shift
 431          * by the constraint coordinate communication routine,
 432          * so that here we can use normal pbc.
 433          */
 434         pbc_null = set_pbc_dd(&pbc, ir.pbcType, DOMAINDECOMP(cr) ? cr->dd->numCells : nullptr, FALSE, box);
 435     }
 436     else
 437     {
 438         pbc_null = nullptr;
 439     }
 440
 441     /* Communicate the coordinates required for the non-local constraints
 442      * for LINCS and/or SETTLE.
 443      */
 444     if (cr->dd)
 445     {
 446         dd_move_x_constraints(cr->dd, box, x.unpaddedArrayRef(), xprime.unpaddedArrayRef(),
 447                               econq == ConstraintVariable::Positions);
 448
 449         if (!v.empty())
 450         {
 451             /* We need to initialize the non-local components of v.
 452              * We never actually use these values, but we do increment them,
 453              * so we should avoid uninitialized variables and overflows.
 454              */
 455             clear_constraint_quantity_nonlocal(cr->dd, v.unpaddedArrayRef());
 456         }
 457     }
 458
 459     if (lincsd != nullptr)
 460     {
 461         bOK = constrain_lincs(bLog || bEner, ir, step, lincsd, md, cr, ms, x, xprime, min_proj, box,
 462                               pbc_null, lambda, dvdlambda, invdt, v.unpaddedArrayRef(),
 463                               vir != nullptr, vir_r_m_dr, econq, nrnb, maxwarn, &warncount_lincs);
 464         if (!bOK && maxwarn < INT_MAX)
 465         {
 466             if (log != nullptr)
 467             {
 468                 fprintf(log, "Constraint error in algorithm %s at step %s\n",
 469                         econstr_names[econtLINCS], gmx_step_str(step, buf));
 470             }
 471             bDump = TRUE;
 472         }
 473     }
 474
 475     if (shaked != nullptr)
 476     {
 477         bOK = constrain_shake(log, shaked.get(), md.invmass, *idef, ir, x.unpaddedArrayRef(),
 478                               xprime.unpaddedArrayRef(), min_proj, pbc_null, nrnb, lambda,
 479                               dvdlambda, invdt, v.unpaddedArrayRef(), vir != nullptr, vir_r_m_dr,
 480                               maxwarn < INT_MAX, econq);
 481
 482         if (!bOK && maxwarn < INT_MAX)
 483         {
 484             if (log != nullptr)
 485             {
 486                 fprintf(log, "Constraint error in algorithm %s at step %s\n",
 487                         econstr_names[econtSHAKE], gmx_step_str(step, buf));
 488             }
 489             bDump = TRUE;
 490         }
 491     }
 492
 493     if (nsettle > 0)
 494     {
 495         bool bSettleErrorHasOccurred0 = false;
 496
 497         switch (econq)
 498         {
 499             case ConstraintVariable::Positions:
 500 #pragma omp parallel for num_threads(nth) schedule(static)
 501                 for (int th = 0; th < nth; th++)
 502                 {
 503                     try
 504                     {
 505                         if (th > 0)
 506                         {
 507                             clear_mat(vir_r_m_dr_th[th]);
 508                         }
 509
 510                         csettle(settled, nth, th, pbc_null, x, xprime, invdt, v, vir != nullptr,
 511                                 th == 0 ? vir_r_m_dr : vir_r_m_dr_th[th],
 512                                 th == 0 ? &bSettleErrorHasOccurred0 : &bSettleErrorHasOccurred[th]);
 513                     }
 514                     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
 515                 }
 516                 inc_nrnb(nrnb, eNR_SETTLE, nsettle);
 517                 if (!v.empty())
 518                 {
 519                     inc_nrnb(nrnb, eNR_CONSTR_V, nsettle * 3);
 520                 }
 521                 if (vir != nullptr)
 522                 {
 523                     inc_nrnb(nrnb, eNR_CONSTR_VIR, nsettle * 3);
 524                 }
 525                 break;
 526             case ConstraintVariable::Velocities:
 527             case ConstraintVariable::Derivative:
 528             case ConstraintVariable::Force:
 529             case ConstraintVariable::ForceDispl:
 530 #pragma omp parallel for num_threads(nth) schedule(static)
 531                 for (int th = 0; th < nth; th++)
 532                 {
 533                     try
 534                     {
 535                         int calcvir_atom_end;
 536
 537                         if (vir == nullptr)
 538                         {
 539                             calcvir_atom_end = 0;
 540                         }
 541                         else
 542                         {
 543                             calcvir_atom_end = md.homenr;
 544                         }
 545
 546                         if (th > 0)
 547                         {
 548                             clear_mat(vir_r_m_dr_th[th]);
 549                         }
 550
 551                         int start_th = (nsettle * th) / nth;
 552                         int end_th   = (nsettle * (th + 1)) / nth;
 553
 554                         if (start_th >= 0 && end_th - start_th > 0)
 555                         {
 556                             settle_proj(settled, econq, end_th - start_th,
 557                                         settle.iatoms.data() + start_th * (1 + NRAL(F_SETTLE)), pbc_null,
 558                                         x.unpaddedArrayRef(), xprime.unpaddedArrayRef(), min_proj,
 559                                         calcvir_atom_end, th == 0 ? vir_r_m_dr : vir_r_m_dr_th[th]);
 560                         }
 561                     }
 562                     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR
 563                 }
 564                 /* This is an overestimate */
 565                 inc_nrnb(nrnb, eNR_SETTLE, nsettle);
 566                 break;
 567             case ConstraintVariable::Deriv_FlexCon:
 568                 /* Nothing to do, since the are no flexible constraints in settles */
 569                 break;
 570             default: gmx_incons("Unknown constraint quantity for settle");
 571         }
 572
 573         if (vir != nullptr)
 574         {
 575             /* Reduce the virial contributions over the threads */
 576             for (int th = 1; th < nth; th++)
 577             {
 578                 m_add(vir_r_m_dr, vir_r_m_dr_th[th], vir_r_m_dr);
 579             }
 580         }
 581
 582         if (econq == ConstraintVariable::Positions)
 583         {
 584             for (int th = 1; th < nth; th++)
 585             {
 586                 bSettleErrorHasOccurred0 = bSettleErrorHasOccurred0 || bSettleErrorHasOccurred[th];
 587             }
 588
 589             if (bSettleErrorHasOccurred0)
 590             {
 591                 char buf[STRLEN];
 592                 sprintf(buf,
 593                         "\nstep "
 594                         "%" PRId64
 595                         ": One or more water molecules can not be settled.\n"
 596                         "Check for bad contacts and/or reduce the timestep if appropriate.\n",
 597                         step);
 598                 if (log)
 599                 {
 600                     fprintf(log, "%s", buf);
 601                 }
 602                 fprintf(stderr, "%s", buf);
 603                 warncount_settle++;
 604                 if (warncount_settle > maxwarn)
 605                 {
 606                     too_many_constraint_warnings(-1, warncount_settle);
 607                 }
 608                 bDump = TRUE;
 609
 610                 bOK = FALSE;
 611             }
 612         }
 613     }
 614
 615     if (vir != nullptr)
 616     {
 617         /* The normal uses of constrain() pass step_scaling = 1.0.
 618          * The call to constrain() for SD1 that passes step_scaling =
 619          * 0.5 also passes vir = NULL, so cannot reach this
 620          * assertion. This assertion should remain until someone knows
 621          * that this path works for their intended purpose, and then
 622          * they can use scaled_delta_t instead of ir.delta_t
 623          * below. */
 624         assert(gmx_within_tol(step_scaling, 1.0, GMX_REAL_EPS));
 625         switch (econq)
 626         {
 627             case ConstraintVariable::Positions: vir_fac = 0.5 / (ir.delta_t * ir.delta_t); break;
 628             case ConstraintVariable::Velocities: vir_fac = 0.5 / ir.delta_t; break;
 629             case ConstraintVariable::Force:
 630             case ConstraintVariable::ForceDispl: vir_fac = 0.5; break;
 631             default: gmx_incons("Unsupported constraint quantity for virial");
 632         }
 633
 634         if (EI_VV(ir.eI))
 635         {
 636             vir_fac *= 2; /* only constraining over half the distance here */
 637         }
 638         for (int i = 0; i < DIM; i++)
 639         {
 640             for (int j = 0; j < DIM; j++)
 641             {
 642                 (*vir)[i][j] = vir_fac * vir_r_m_dr[i][j];
 643             }
 644         }
 645     }
 646
 647     if (bDump)
 648     {
 649         dump_confs(log, step, mtop, start, homenr, cr, x.unpaddedArrayRef(),
 650                    xprime.unpaddedArrayRef(), box);
 651     }
 652
 653     if (econq == ConstraintVariable::Positions)
 654     {
 655         if (ir.bPull && pull_have_constraint(pull_work))
 656         {
 657             if (EI_DYNAMICS(ir.eI))
 658             {
 659                 t = ir.init_t + (step + delta_step) * ir.delta_t;
 660             }
 661             else
 662             {
 663                 t = ir.init_t;
 664             }
 665             set_pbc(&pbc, ir.pbcType, box);
 666             pull_constraint(pull_work, &md, &pbc, cr, ir.delta_t, t,
 667                             as_rvec_array(x.unpaddedArrayRef().data()),
 668                             as_rvec_array(xprime.unpaddedArrayRef().data()),
 669                             as_rvec_array(v.unpaddedArrayRef().data()), *vir);
 670         }
 671         if (ed && delta_step > 0)
 672         {
 673             /* apply the essential dynamics constraints here */
 674             do_edsam(&ir, step, cr, as_rvec_array(xprime.unpaddedArrayRef().data()),
 675                      as_rvec_array(v.unpaddedArrayRef().data()), box, ed);
 676         }
 677     }
 678     wallcycle_stop(wcycle, ewcCONSTR);
 679
 680     if (!v.empty() && md.cFREEZE)
 681     {
 682         /* Set the velocities of frozen dimensions to zero */
 683         ArrayRef<RVec> vRef = v.unpaddedArrayRef();
 684
 685         int gmx_unused numThreads = gmx_omp_nthreads_get(emntUpdate);
 686
 687 #pragma omp parallel for num_threads(numThreads) schedule(static)
 688         for (int i = 0; i < md.homenr; i++)
 689         {
 690             int freezeGroup = md.cFREEZE[i];
 691
 692             for (int d = 0; d < DIM; d++)
 693             {
 694                 if (ir.opts.nFreeze[freezeGroup][d])
 695                 {
 696                     vRef[i][d] = 0;
 697                 }
 698             }
 699         }
 700     }
 701
 702     return bOK;
 703 }
 704
 705 ArrayRef<real> Constraints::rmsdData() const
 706 {
 707     if (impl_->lincsd)
 708     {
 709         return lincs_rmsdData(impl_->lincsd);
 710     }
 711     else
 712     {
 713         return {};
 714     }
 715 }
 716
 717 real Constraints::rmsd() const
 718 {
 719     if (impl_->lincsd)
 720     {
 721         return lincs_rmsd(impl_->lincsd);
 722     }
 723     else
 724     {
 725         return 0;
 726     }
 727 }
 728
 729 int Constraints::numConstraintsTotal()
 730 {
 731     return impl_->ncon_tot;
 732 }
 733
 734 FlexibleConstraintTreatment flexibleConstraintTreatment(bool haveDynamicsIntegrator)
 735 {
 736     if (haveDynamicsIntegrator)
 737     {
 738         return FlexibleConstraintTreatment::Include;
 739     }
 740     else
 741     {
 742         return FlexibleConstraintTreatment::Exclude;
 743     }
 744 }
 745
 746 /*! \brief Returns a block struct to go from atoms to constraints
 747  *
 748  * The block struct will contain constraint indices with lower indices
 749  * directly matching the order in F_CONSTR and higher indices matching
 750  * the order in F_CONSTRNC offset by the number of constraints in F_CONSTR.
 751  *
 752  * \param[in]  numAtoms  The number of atoms to construct the list for
 753  * \param[in]  ilists    The interaction lists, size F_NRE
 754  * \param[in]  iparams   Interaction parameters, can be null when
 755  *                       \p flexibleConstraintTreatment==Include
 756  * \param[in]  flexibleConstraintTreatment  The flexible constraint treatment,
 757  *                                          see enum above
 758  *
 759  * \returns a block struct with all constraints for each atom
 760  */
 761 static ListOfLists<int> makeAtomsToConstraintsList(int                             numAtoms,
 762                                                    ArrayRef<const InteractionList> ilists,
 763                                                    ArrayRef<const t_iparams>       iparams,
 764                                                    FlexibleConstraintTreatment flexibleConstraintTreatment)
 765 {
 766     GMX_ASSERT(flexibleConstraintTreatment == FlexibleConstraintTreatment::Include || !iparams.empty(),
 767                "With flexible constraint detection we need valid iparams");
 768
 769     std::vector<int> count(numAtoms);
 770
 771     for (int ftype = F_CONSTR; ftype <= F_CONSTRNC; ftype++)
 772     {
 773         const InteractionList& ilist  = ilists[ftype];
 774         const int              stride = 1 + NRAL(ftype);
 775         for (int i = 0; i < ilist.size(); i += stride)
 776         {
 777             if (flexibleConstraintTreatment == FlexibleConstraintTreatment::Include
 778                 || !isConstraintFlexible(iparams, ilist.iatoms[i]))
 779             {
 780                 for (int j = 1; j < 3; j++)
 781                 {
 782                     int a = ilist.iatoms[i + j];
 783                     count[a]++;
 784                 }
 785             }
 786         }
 787     }
 788
 789     std::vector<int> listRanges(numAtoms + 1);
 790     for (int a = 0; a < numAtoms; a++)
 791     {
 792         listRanges[a + 1] = listRanges[a] + count[a];
 793         count[a]          = 0;
 794     }
 795     std::vector<int> elements(listRanges[numAtoms]);
 796
 797     /* The F_CONSTRNC constraints have constraint numbers
 798      * that continue after the last F_CONSTR constraint.
 799      */
 800     int numConstraints = 0;
 801     for (int ftype = F_CONSTR; ftype <= F_CONSTRNC; ftype++)
 802     {
 803         const InteractionList& ilist  = ilists[ftype];
 804         const int              stride = 1 + NRAL(ftype);
 805         for (int i = 0; i < ilist.size(); i += stride)
 806         {
 807             if (flexibleConstraintTreatment == FlexibleConstraintTreatment::Include
 808                 || !isConstraintFlexible(iparams, ilist.iatoms[i]))
 809             {
 810                 for (int j = 1; j < 3; j++)
 811                 {
 812                     const int a                          = ilist.iatoms[i + j];
 813                     elements[listRanges[a] + count[a]++] = numConstraints;
 814                 }
 815             }
 816             numConstraints++;
 817         }
 818     }
 819
 820     return ListOfLists<int>(std::move(listRanges), std::move(elements));
 821 }
 822
 823 ListOfLists<int> make_at2con(int                             numAtoms,
 824                              ArrayRef<const InteractionList> ilist,
 825                              ArrayRef<const t_iparams>       iparams,
 826                              FlexibleConstraintTreatment     flexibleConstraintTreatment)
 827 {
 828     return makeAtomsToConstraintsList(numAtoms, ilist, iparams, flexibleConstraintTreatment);
 829 }
 830
 831 ListOfLists<int> make_at2con(const gmx_moltype_t&           moltype,
 832                              gmx::ArrayRef<const t_iparams> iparams,
 833                              FlexibleConstraintTreatment    flexibleConstraintTreatment)
 834 {
 835     return makeAtomsToConstraintsList(moltype.atoms.nr, makeConstArrayRef(moltype.ilist), iparams,
 836                                       flexibleConstraintTreatment);
 837 }
 838
 839 //! Return the number of flexible constraints in the \c ilist and \c iparams.
 840 int countFlexibleConstraints(ArrayRef<const InteractionList> ilist, ArrayRef<const t_iparams> iparams)
 841 {
 842     int nflexcon = 0;
 843     for (int ftype = F_CONSTR; ftype <= F_CONSTRNC; ftype++)
 844     {
 845         const int numIatomsPerConstraint = 3;
 846         for (int i = 0; i < ilist[ftype].size(); i += numIatomsPerConstraint)
 847         {
 848             const int type = ilist[ftype].iatoms[i];
 849             if (iparams[type].constr.dA == 0 && iparams[type].constr.dB == 0)
 850             {
 851                 nflexcon++;
 852             }
 853         }
 854     }
 855
 856     return nflexcon;
 857 }
 858
 859 //! Returns the index of the settle to which each atom belongs.
 860 static std::vector<int> make_at2settle(int natoms, const InteractionList& ilist)
 861 {
 862     /* Set all to no settle */
 863     std::vector<int> at2s(natoms, -1);
 864
 865     const int stride = 1 + NRAL(F_SETTLE);
 866
 867     for (int s = 0; s < ilist.size(); s += stride)
 868     {
 869         at2s[ilist.iatoms[s + 1]] = s / stride;
 870         at2s[ilist.iatoms[s + 2]] = s / stride;
 871         at2s[ilist.iatoms[s + 3]] = s / stride;
 872     }
 873
 874     return at2s;
 875 }
 876
 877 void Constraints::Impl::setConstraints(gmx_localtop_t* top, const t_mdatoms& md)
 878 {
 879     idef = &top->idef;
 880
 881     if (ncon_tot > 0)
 882     {
 883         /* With DD we might also need to call LINCS on a domain no constraints for
 884          * communicating coordinates to other nodes that do have constraints.
 885          */
 886         if (ir.eConstrAlg == econtLINCS)
 887         {
 888             set_lincs(*idef, md, EI_DYNAMICS(ir.eI), cr, lincsd);
 889         }
 890         if (ir.eConstrAlg == econtSHAKE)
 891         {
 892             if (cr->dd)
 893             {
 894                 // We are using the local topology, so there are only
 895                 // F_CONSTR constraints.
 896                 make_shake_sblock_dd(shaked.get(), idef->il[F_CONSTR]);
 897             }
 898             else
 899             {
 900                 make_shake_sblock_serial(shaked.get(), &top->idef, md);
 901             }
 902         }
 903     }
 904
 905     if (settled)
 906     {
 907         settle_set_constraints(settled, idef->il[F_SETTLE], md);
 908     }
 909
 910     /* Make a selection of the local atoms for essential dynamics */
 911     if (ed && cr->dd)
 912     {
 913         dd_make_local_ed_indices(cr->dd, ed);
 914     }
 915 }
 916
 917 void Constraints::setConstraints(gmx_localtop_t* top, const t_mdatoms& md)
 918 {
 919     impl_->setConstraints(top, md);
 920 }
 921
 922 /*! \brief Makes a per-moleculetype container of mappings from atom
 923  * indices to constraint indices.
 924  *
 925  * Note that flexible constraints are only enabled with a dynamical integrator. */
 926 static std::vector<ListOfLists<int>> makeAtomToConstraintMappings(const gmx_mtop_t& mtop,
 927                                                                   FlexibleConstraintTreatment flexibleConstraintTreatment)
 928 {
 929     std::vector<ListOfLists<int>> mapping;
 930     mapping.reserve(mtop.moltype.size());
 931     for (const gmx_moltype_t& moltype : mtop.moltype)
 932     {
 933         mapping.push_back(make_at2con(moltype, mtop.ffparams.iparams, flexibleConstraintTreatment));
 934     }
 935     return mapping;
 936 }
 937
 938 Constraints::Constraints(const gmx_mtop_t&     mtop,
 939                          const t_inputrec&     ir,
 940                          pull_t*               pull_work,
 941                          FILE*                 log,
 942                          const t_mdatoms&      md,
 943                          const t_commrec*      cr,
 944                          const gmx_multisim_t* ms,
 945                          t_nrnb*               nrnb,
 946                          gmx_wallcycle*        wcycle,
 947                          bool                  pbcHandlingRequired,
 948                          int                   numConstraints,
 949                          int                   numSettles) :
 950     impl_(new Impl(mtop, ir, pull_work, log, md, cr, ms, nrnb, wcycle, pbcHandlingRequired, numConstraints, numSettles))
 951 {
 952 }
 953
 954 Constraints::Impl::Impl(const gmx_mtop_t&     mtop_p,
 955                         const t_inputrec&     ir_p,
 956                         pull_t*               pull_work,
 957                         FILE*                 log_p,
 958                         const t_mdatoms&      md_p,
 959                         const t_commrec*      cr_p,
 960                         const gmx_multisim_t* ms_p,
 961                         t_nrnb*               nrnb_p,
 962                         gmx_wallcycle*        wcycle_p,
 963                         bool                  pbcHandlingRequired,
 964                         int                   numConstraints,
 965                         int                   numSettles) :
 966     ncon_tot(numConstraints),
 967     mtop(mtop_p),
 968     md(md_p),
 969     pbcHandlingRequired_(pbcHandlingRequired),
 970     log(log_p),
 971     cr(cr_p),
 972     ms(ms_p),
 973     pull_work(pull_work),
 974     ir(ir_p),
 975     nrnb(nrnb_p),
 976     wcycle(wcycle_p)
 977 {
 978     if (numConstraints + numSettles > 0 && ir.epc == epcMTTK)
 979     {
 980         gmx_fatal(FARGS, "Constraints are not implemented with MTTK pressure control.");
 981     }
 982
 983     nflexcon = 0;
 984     if (numConstraints > 0)
 985     {
 986         at2con_mt = makeAtomToConstraintMappings(mtop, flexibleConstraintTreatment(EI_DYNAMICS(ir.eI)));
 987
 988         for (const gmx_molblock_t& molblock : mtop.molblock)
 989         {
 990             int count = countFlexibleConstraints(mtop.moltype[molblock.type].ilist, mtop.ffparams.iparams);
 991             nflexcon += molblock.nmol * count;
 992         }
 993
 994         if (nflexcon > 0)
 995         {
 996             if (log)
 997             {
 998                 fprintf(log, "There are %d flexible constraints\n", nflexcon);
 999                 if (ir.fc_stepsize == 0)
1000                 {
1001                     fprintf(log,
1002                             "\n"
1003                             "WARNING: step size for flexible constraining = 0\n"
1004                             "         All flexible constraints will be rigid.\n"
1005                             "         Will try to keep all flexible constraints at their original "
1006                             "length,\n"
1007                             "         but the lengths may exhibit some drift.\n\n");
1008                     nflexcon = 0;
1009                 }
1010             }
1011             if (nflexcon > 0)
1012             {
1013                 please_cite(log, "Hess2002");
1014             }
1015         }
1016
1017         if (ir.eConstrAlg == econtLINCS)
1018         {
1019             lincsd = init_lincs(log, mtop, nflexcon, at2con_mt,
1020                                 DOMAINDECOMP(cr) && ddHaveSplitConstraints(*cr->dd), ir.nLincsIter,
1021                                 ir.nProjOrder);
1022         }
1023
1024         if (ir.eConstrAlg == econtSHAKE)
1025         {
1026             if (DOMAINDECOMP(cr) && ddHaveSplitConstraints(*cr->dd))
1027             {
1028                 gmx_fatal(FARGS,
1029                           "SHAKE is not supported with domain decomposition and constraint that "
1030                           "cross domain boundaries, use LINCS");
1031             }
1032             if (nflexcon)
1033             {
1034                 gmx_fatal(FARGS,
1035                           "For this system also velocities and/or forces need to be constrained, "
1036                           "this can not be done with SHAKE, you should select LINCS");
1037             }
1038             please_cite(log, "Ryckaert77a");
1039             if (ir.bShakeSOR)
1040             {
1041                 please_cite(log, "Barth95a");
1042             }
1043
1044             shaked = std::make_unique<shakedata>();
1045         }
1046     }
1047
1048     if (numSettles > 0)
1049     {
1050         please_cite(log, "Miyamoto92a");
1051
1052         settled = settle_init(mtop);
1053
1054         /* Make an atom to settle index for use in domain decomposition */
1055         for (size_t mt = 0; mt < mtop.moltype.size(); mt++)
1056         {
1057             at2settle_mt.emplace_back(
1058                     make_at2settle(mtop.moltype[mt].atoms.nr, mtop.moltype[mt].ilist[F_SETTLE]));
1059         }
1060
1061         /* Allocate thread-local work arrays */
1062         int nthreads = gmx_omp_nthreads_get(emntSETTLE);
1063         if (nthreads > 1 && vir_r_m_dr_th == nullptr)
1064         {
1065             snew(vir_r_m_dr_th, nthreads);
1066             snew(bSettleErrorHasOccurred, nthreads);
1067         }
1068     }
1069
1070     maxwarn   = 999;
1071     char* env = getenv("GMX_MAXCONSTRWARN");
1072     if (env)
1073     {
1074         maxwarn = 0;
1075         sscanf(env, "%8d", &maxwarn);
1076         if (maxwarn < 0)
1077         {
1078             maxwarn = INT_MAX;
1079         }
1080         if (log)
1081         {
1082             fprintf(log, "Setting the maximum number of constraint warnings to %d\n", maxwarn);
1083         }
1084         if (MASTER(cr))
1085         {
1086             fprintf(stderr, "Setting the maximum number of constraint warnings to %d\n", maxwarn);
1087         }
1088     }
1089     warncount_lincs  = 0;
1090     warncount_settle = 0;
1091 }
1092
1093 Constraints::Impl::~Impl()
1094 {
1095     if (bSettleErrorHasOccurred != nullptr)
1096     {
1097         sfree(bSettleErrorHasOccurred);
1098     }
1099     if (vir_r_m_dr_th != nullptr)
1100     {
1101         sfree(vir_r_m_dr_th);
1102     }
1103     if (settled != nullptr)
1104     {
1105         settle_free(settled);
1106     }
1107     done_lincs(lincsd);
1108 }
1109
1110 void Constraints::saveEdsamPointer(gmx_edsam* ed)
1111 {
1112     impl_->ed = ed;
1113 }
1114
1115 ArrayRef<const ListOfLists<int>> Constraints::atom2constraints_moltype() const
1116 {
1117     return impl_->at2con_mt;
1118 }
1119
1120 ArrayRef<const std::vector<int>> Constraints::atom2settle_moltype() const
1121 {
1122     return impl_->at2settle_mt;
1123 }
1124
1125 void do_constrain_first(FILE*                     fplog,
1126                         gmx::Constraints*         constr,
1127                         const t_inputrec*         ir,
1128                         const t_mdatoms*          md,
1129                         int                       natoms,
1130                         ArrayRefWithPadding<RVec> x,
1131                         ArrayRefWithPadding<RVec> v,
1132                         const matrix              box,
1133                         real                      lambda)
1134 {
1135     int     i, m, start, end;
1136     int64_t step;
1137     real    dt = ir->delta_t;
1138     real    dvdl_dum;
1139
1140     PaddedVector<RVec> savex(natoms);
1141
1142     start = 0;
1143     end   = md->homenr;
1144
1145     if (debug)
1146     {
1147         fprintf(debug, "vcm: start=%d, homenr=%d, end=%d\n", start, md->homenr, end);
1148     }
1149     /* Do a first constrain to reset particles... */
1150     step = ir->init_step;
1151     if (fplog)
1152     {
1153         char buf[STEPSTRSIZE];
1154         fprintf(fplog, "\nConstraining the starting coordinates (step %s)\n", gmx_step_str(step, buf));
1155     }
1156     dvdl_dum = 0;
1157
1158     /* constrain the current position */
1159     constr->apply(TRUE, FALSE, step, 0, 1.0, x, x, {}, box, lambda, &dvdl_dum, {}, nullptr,
1160                   gmx::ConstraintVariable::Positions);
1161     if (EI_VV(ir->eI))
1162     {
1163         /* constrain the inital velocity, and save it */
1164         /* also may be useful if we need the ekin from the halfstep for velocity verlet */
1165         constr->apply(TRUE, FALSE, step, 0, 1.0, x, v, v.unpaddedArrayRef(), box, lambda, &dvdl_dum,
1166                       {}, nullptr, gmx::ConstraintVariable::Velocities);
1167     }
1168     /* constrain the inital velocities at t-dt/2 */
1169     if (EI_STATE_VELOCITY(ir->eI) && ir->eI != eiVV)
1170     {
1171         auto subX = x.paddedArrayRef().subArray(start, end);
1172         auto subV = v.paddedArrayRef().subArray(start, end);
1173         for (i = start; (i < end); i++)
1174         {
1175             for (m = 0; (m < DIM); m++)
1176             {
1177                 /* Reverse the velocity */
1178                 subV[i][m] = -subV[i][m];
1179                 /* Store the position at t-dt in buf */
1180                 savex[i][m] = subX[i][m] + dt * subV[i][m];
1181             }
1182         }
1183         /* Shake the positions at t=-dt with the positions at t=0
1184          * as reference coordinates.
1185          */
1186         if (fplog)
1187         {
1188             char buf[STEPSTRSIZE];
1189             fprintf(fplog, "\nConstraining the coordinates at t0-dt (step %s)\n", gmx_step_str(step, buf));
1190         }
1191         dvdl_dum = 0;
1192         constr->apply(TRUE, FALSE, step, -1, 1.0, x, savex.arrayRefWithPadding(), {}, box, lambda,
1193                       &dvdl_dum, v, nullptr, gmx::ConstraintVariable::Positions);
1194
1195         for (i = start; i < end; i++)
1196         {
1197             for (m = 0; m < DIM; m++)
1198             {
1199                 /* Re-reverse the velocities */
1200                 subV[i][m] = -subV[i][m];
1201             }
1202         }
1203     }
1204 }
1205
1206 } // namespace gmx