src/gromacs/mdlib/vcm.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 /* This file is completely threadsafe - keep it that way! */
  39 #include "gmxpre.h"
  40
  41 #include "vcm.h"
  42
  43 #include "gromacs/gmxlib/network.h"
  44 #include "gromacs/math/functions.h"
  45 #include "gromacs/math/invertmatrix.h"
  46 #include "gromacs/math/vec.h"
  47 #include "gromacs/math/vecdump.h"
  48 #include "gromacs/mdlib/gmx_omp_nthreads.h"
  49 #include "gromacs/mdtypes/inputrec.h"
  50 #include "gromacs/mdtypes/md_enums.h"
  51 #include "gromacs/pbcutil/pbc.h"
  52 #include "gromacs/topology/topology.h"
  53 #include "gromacs/utility/fatalerror.h"
  54 #include "gromacs/utility/gmxassert.h"
  55 #include "gromacs/utility/gmxomp.h"
  56 #include "gromacs/utility/smalloc.h"
  57
  58 t_vcm::t_vcm(const SimulationGroups& groups, const t_inputrec& ir) :
  59     integratorConservesMomentum(!EI_RANDOM(ir.eI))
  60 {
  61     mode     = (ir.nstcomm > 0) ? ir.comm_mode : ecmNO;
  62     ndim     = ndof_com(&ir);
  63     timeStep = ir.nstcomm * ir.delta_t;
  64
  65     if (mode == ecmANGULAR && ndim < 3)
  66     {
  67         gmx_fatal(FARGS, "Can not have angular comm removal with pbc=%s",
  68                   c_pbcTypeNames[ir.pbcType].c_str());
  69     }
  70
  71     if (mode != ecmNO)
  72     {
  73         nr = groups.groups[SimulationAtomGroupType::MassCenterVelocityRemoval].size();
  74         /* Allocate one extra for a possible rest group */
  75         size = nr + 1;
  76         /* We need vcm->nr+1 elements per thread, but to avoid cache
  77          * invalidation we add 2 elements to get a 152 byte separation.
  78          */
  79         stride = nr + 3;
  80         if (mode == ecmANGULAR)
  81         {
  82             snew(group_i, size);
  83
  84             group_j.resize(size);
  85             group_x.resize(size);
  86             group_w.resize(size);
  87         }
  88
  89         group_name.resize(size);
  90         group_p.resize(size);
  91         group_v.resize(size);
  92         group_mass.resize(size);
  93         group_ndf.resize(size);
  94         for (int g = 0; (g < nr); g++)
  95         {
  96             group_ndf[g] = ir.opts.nrdf[g];
  97             group_name[g] =
  98                     *groups.groupNames[groups.groups[SimulationAtomGroupType::MassCenterVelocityRemoval][g]];
  99         }
 100
 101         thread_vcm.resize(gmx_omp_nthreads_get(emntDefault) * stride);
 102     }
 103
 104     nFreeze = ir.opts.nFreeze;
 105 }
 106
 107 t_vcm::~t_vcm()
 108 {
 109     if (mode == ecmANGULAR)
 110     {
 111         sfree(group_i);
 112     }
 113 }
 114
 115 void reportComRemovalInfo(FILE* fp, const t_vcm& vcm)
 116 {
 117
 118     /* Copy pointer to group names and print it. */
 119     if (fp && vcm.mode != ecmNO)
 120     {
 121         fprintf(fp, "Center of mass motion removal mode is %s\n", ECOM(vcm.mode));
 122         fprintf(fp,
 123                 "We have the following groups for center of"
 124                 " mass motion removal:\n");
 125
 126         for (int g = 0; (g < vcm.nr); g++)
 127         {
 128
 129             fprintf(fp, "%3d:  %s\n", g, vcm.group_name[g]);
 130         }
 131     }
 132 }
 133
 134
 135 static void update_tensor(const rvec x, real m0, tensor I)
 136 {
 137     real xy, xz, yz;
 138
 139     /* Compute inertia tensor contribution due to this atom */
 140     xy = x[XX] * x[YY] * m0;
 141     xz = x[XX] * x[ZZ] * m0;
 142     yz = x[YY] * x[ZZ] * m0;
 143     I[XX][XX] += x[XX] * x[XX] * m0;
 144     I[YY][YY] += x[YY] * x[YY] * m0;
 145     I[ZZ][ZZ] += x[ZZ] * x[ZZ] * m0;
 146     I[XX][YY] += xy;
 147     I[YY][XX] += xy;
 148     I[XX][ZZ] += xz;
 149     I[ZZ][XX] += xz;
 150     I[YY][ZZ] += yz;
 151     I[ZZ][YY] += yz;
 152 }
 153
 154 /* Center of mass code for groups */
 155 void calc_vcm_grp(const t_mdatoms& md, const rvec x[], const rvec v[], t_vcm* vcm)
 156 {
 157     int nthreads = gmx_omp_nthreads_get(emntDefault);
 158     if (vcm->mode != ecmNO)
 159     {
 160 #pragma omp parallel num_threads(nthreads)
 161         {
 162             int t = gmx_omp_get_thread_num();
 163             for (int g = 0; g < vcm->size; g++)
 164             {
 165                 /* Reset linear momentum */
 166                 t_vcm_thread* vcm_t = &vcm->thread_vcm[t * vcm->stride + g];
 167                 vcm_t->mass         = 0;
 168                 clear_rvec(vcm_t->p);
 169                 if (vcm->mode == ecmANGULAR)
 170                 {
 171                     /* Reset angular momentum */
 172                     clear_rvec(vcm_t->j);
 173                     clear_rvec(vcm_t->x);
 174                     clear_mat(vcm_t->i);
 175                 }
 176             }
 177
 178 #pragma omp for schedule(static)
 179             for (int i = 0; i < md.homenr; i++)
 180             {
 181                 int  g  = 0;
 182                 real m0 = md.massT[i];
 183                 if (md.cVCM)
 184                 {
 185                     g = md.cVCM[i];
 186                 }
 187                 t_vcm_thread* vcm_t = &vcm->thread_vcm[t * vcm->stride + g];
 188                 /* Calculate linear momentum */
 189                 vcm_t->mass += m0;
 190                 int m;
 191                 for (m = 0; (m < DIM); m++)
 192                 {
 193                     vcm_t->p[m] += m0 * v[i][m];
 194                 }
 195
 196                 if (vcm->mode == ecmANGULAR)
 197                 {
 198                     /* Calculate angular momentum */
 199                     rvec j0;
 200                     cprod(x[i], v[i], j0);
 201
 202                     for (m = 0; (m < DIM); m++)
 203                     {
 204                         vcm_t->j[m] += m0 * j0[m];
 205                         vcm_t->x[m] += m0 * x[i][m];
 206                     }
 207                     /* Update inertia tensor */
 208                     update_tensor(x[i], m0, vcm_t->i);
 209                 }
 210             }
 211         }
 212         for (int g = 0; g < vcm->size; g++)
 213         {
 214             /* Reset linear momentum */
 215             vcm->group_mass[g] = 0;
 216             clear_rvec(vcm->group_p[g]);
 217             if (vcm->mode == ecmANGULAR)
 218             {
 219                 /* Reset angular momentum */
 220                 clear_rvec(vcm->group_j[g]);
 221                 clear_rvec(vcm->group_x[g]);
 222                 clear_rvec(vcm->group_w[g]);
 223                 clear_mat(vcm->group_i[g]);
 224             }
 225
 226             for (int t = 0; t < nthreads; t++)
 227             {
 228                 t_vcm_thread* vcm_t = &vcm->thread_vcm[t * vcm->stride + g];
 229                 vcm->group_mass[g] += vcm_t->mass;
 230                 rvec_inc(vcm->group_p[g], vcm_t->p);
 231                 if (vcm->mode == ecmANGULAR)
 232                 {
 233                     rvec_inc(vcm->group_j[g], vcm_t->j);
 234                     rvec_inc(vcm->group_x[g], vcm_t->x);
 235                     m_add(vcm_t->i, vcm->group_i[g], vcm->group_i[g]);
 236                 }
 237             }
 238         }
 239     }
 240 }
 241
 242 /*! \brief Remove the COM motion velocity from the velocities
 243  *
 244  * \note This routine should be called from within an OpenMP parallel region.
 245  *
 246  * \tparam numDimensions    Correct dimensions 0 to \p numDimensions-1
 247  * \param[in]     mdatoms   The atom property and group information
 248  * \param[in,out] v         The velocities to correct
 249  * \param[in]     vcm       VCM data
 250  */
 251 template<int numDimensions>
 252 static void doStopComMotionLinear(const t_mdatoms& mdatoms, rvec* v, const t_vcm& vcm)
 253 {
 254     const int             homenr   = mdatoms.homenr;
 255     const unsigned short* group_id = mdatoms.cVCM;
 256
 257     if (mdatoms.cFREEZE != nullptr)
 258     {
 259         GMX_RELEASE_ASSERT(vcm.nFreeze != nullptr, "Need freeze dimension info with freeze groups");
 260
 261 #pragma omp for schedule(static)
 262         for (int i = 0; i < homenr; i++)
 263         {
 264             unsigned short vcmGroup    = (group_id == nullptr ? 0 : group_id[i]);
 265             unsigned short freezeGroup = mdatoms.cFREEZE[i];
 266             for (int d = 0; d < numDimensions; d++)
 267             {
 268                 if (vcm.nFreeze[freezeGroup][d] == 0)
 269                 {
 270                     v[i][d] -= vcm.group_v[vcmGroup][d];
 271                 }
 272             }
 273         }
 274     }
 275     else if (group_id == nullptr)
 276     {
 277 #pragma omp for schedule(static)
 278         for (int i = 0; i < homenr; i++)
 279         {
 280             for (int d = 0; d < numDimensions; d++)
 281             {
 282                 v[i][d] -= vcm.group_v[0][d];
 283             }
 284         }
 285     }
 286     else
 287     {
 288 #pragma omp for schedule(static)
 289         for (int i = 0; i < homenr; i++)
 290         {
 291             const int g = group_id[i];
 292             for (int d = 0; d < numDimensions; d++)
 293             {
 294                 v[i][d] -= vcm.group_v[g][d];
 295             }
 296         }
 297     }
 298 }
 299
 300 /*! \brief Remove the COM motion velocity from the velocities, correct the coordinates assuming constant acceleration
 301  *
 302  * \note This routine should be called from within an OpenMP parallel region.
 303  *
 304  * \tparam numDimensions    Correct dimensions 0 to \p numDimensions-1
 305  * \param[in]     homenr    The number of atoms to correct
 306  * \param[in]     group_id  List of VCM group ids, when nullptr is passed all atoms are assumed to be in group 0
 307  * \param[in,out] x         The coordinates to correct
 308  * \param[in,out] v         The velocities to correct
 309  * \param[in]     vcm       VCM data
 310  */
 311 template<int numDimensions>
 312 static void doStopComMotionAccelerationCorrection(int                   homenr,
 313                                                   const unsigned short* group_id,
 314                                                   rvec* gmx_restrict x,
 315                                                   rvec* gmx_restrict v,
 316                                                   const t_vcm&       vcm)
 317 {
 318     const real xCorrectionFactor = 0.5 * vcm.timeStep;
 319
 320     if (group_id == nullptr)
 321     {
 322 #pragma omp for schedule(static)
 323         for (int i = 0; i < homenr; i++)
 324         {
 325             for (int d = 0; d < numDimensions; d++)
 326             {
 327                 x[i][d] -= vcm.group_v[0][d] * xCorrectionFactor;
 328                 v[i][d] -= vcm.group_v[0][d];
 329             }
 330         }
 331     }
 332     else
 333     {
 334 #pragma omp for schedule(static)
 335         for (int i = 0; i < homenr; i++)
 336         {
 337             const int g = group_id[i];
 338             for (int d = 0; d < numDimensions; d++)
 339             {
 340                 x[i][d] -= vcm.group_v[g][d] * xCorrectionFactor;
 341                 v[i][d] -= vcm.group_v[g][d];
 342             }
 343         }
 344     }
 345 }
 346
 347 static void do_stopcm_grp(const t_mdatoms& mdatoms, rvec x[], rvec v[], const t_vcm& vcm)
 348 {
 349     if (vcm.mode != ecmNO)
 350     {
 351         const int             homenr   = mdatoms.homenr;
 352         const unsigned short* group_id = mdatoms.cVCM;
 353
 354         int gmx_unused nth = gmx_omp_nthreads_get(emntDefault);
 355 #pragma omp parallel num_threads(nth)
 356         {
 357             if (vcm.mode == ecmLINEAR || vcm.mode == ecmANGULAR
 358                 || (vcm.mode == ecmLINEAR_ACCELERATION_CORRECTION && x == nullptr))
 359             {
 360                 /* Subtract linear momentum for v */
 361                 switch (vcm.ndim)
 362                 {
 363                     case 1: doStopComMotionLinear<1>(mdatoms, v, vcm); break;
 364                     case 2: doStopComMotionLinear<2>(mdatoms, v, vcm); break;
 365                     case 3: doStopComMotionLinear<3>(mdatoms, v, vcm); break;
 366                 }
 367             }
 368             else
 369             {
 370                 GMX_ASSERT(vcm.mode == ecmLINEAR_ACCELERATION_CORRECTION,
 371                            "When the mode is not linear or angular, it should be acceleration "
 372                            "correction");
 373                 /* Subtract linear momentum for v and x*/
 374                 switch (vcm.ndim)
 375                 {
 376                     case 1:
 377                         doStopComMotionAccelerationCorrection<1>(homenr, group_id, x, v, vcm);
 378                         break;
 379                     case 2:
 380                         doStopComMotionAccelerationCorrection<2>(homenr, group_id, x, v, vcm);
 381                         break;
 382                     case 3:
 383                         doStopComMotionAccelerationCorrection<3>(homenr, group_id, x, v, vcm);
 384                         break;
 385                 }
 386             }
 387             if (vcm.mode == ecmANGULAR)
 388             {
 389                 /* Subtract angular momentum */
 390                 GMX_ASSERT(x, "Need x to compute angular momentum correction");
 391
 392                 int g = 0;
 393 #pragma omp for schedule(static)
 394                 for (int i = 0; i < homenr; i++)
 395                 {
 396                     if (group_id)
 397                     {
 398                         g = group_id[i];
 399                     }
 400                     /* Compute the correction to the velocity for each atom */
 401                     rvec dv, dx;
 402                     rvec_sub(x[i], vcm.group_x[g], dx);
 403                     cprod(vcm.group_w[g], dx, dv);
 404                     rvec_dec(v[i], dv);
 405                 }
 406             }
 407         }
 408     }
 409 }
 410
 411 static void get_minv(tensor A, tensor B)
 412 {
 413     int    m, n;
 414     double fac, rfac;
 415     tensor tmp;
 416
 417     tmp[XX][XX] = A[YY][YY] + A[ZZ][ZZ];
 418     tmp[YY][XX] = -A[XX][YY];
 419     tmp[ZZ][XX] = -A[XX][ZZ];
 420     tmp[XX][YY] = -A[XX][YY];
 421     tmp[YY][YY] = A[XX][XX] + A[ZZ][ZZ];
 422     tmp[ZZ][YY] = -A[YY][ZZ];
 423     tmp[XX][ZZ] = -A[XX][ZZ];
 424     tmp[YY][ZZ] = -A[YY][ZZ];
 425     tmp[ZZ][ZZ] = A[XX][XX] + A[YY][YY];
 426
 427     /* This is a hack to prevent very large determinants */
 428     rfac = (tmp[XX][XX] + tmp[YY][YY] + tmp[ZZ][ZZ]) / 3;
 429     if (rfac == 0.0)
 430     {
 431         gmx_fatal(FARGS, "Can not stop center of mass: maybe 2dimensional system");
 432     }
 433     fac = 1.0 / rfac;
 434     for (m = 0; (m < DIM); m++)
 435     {
 436         for (n = 0; (n < DIM); n++)
 437         {
 438             tmp[m][n] *= fac;
 439         }
 440     }
 441     gmx::invertMatrix(tmp, B);
 442     for (m = 0; (m < DIM); m++)
 443     {
 444         for (n = 0; (n < DIM); n++)
 445         {
 446             B[m][n] *= fac;
 447         }
 448     }
 449 }
 450
 451 /* Processes VCM after reduction over ranks and prints warning with high VMC and fp != nullptr */
 452 static void process_and_check_cm_grp(FILE* fp, t_vcm* vcm, real Temp_Max)
 453 {
 454     int    m, g;
 455     real   ekcm, ekrot, tm, tm_1, Temp_cm;
 456     rvec   jcm;
 457     tensor Icm;
 458
 459     /* First analyse the total results */
 460     if (vcm->mode != ecmNO)
 461     {
 462         for (g = 0; (g < vcm->nr); g++)
 463         {
 464             tm = vcm->group_mass[g];
 465             if (tm != 0)
 466             {
 467                 tm_1 = 1.0 / tm;
 468                 svmul(tm_1, vcm->group_p[g], vcm->group_v[g]);
 469             }
 470             /* Else it's zero anyway! */
 471         }
 472         if (vcm->mode == ecmANGULAR)
 473         {
 474             for (g = 0; (g < vcm->nr); g++)
 475             {
 476                 tm = vcm->group_mass[g];
 477                 if (tm != 0)
 478                 {
 479                     tm_1 = 1.0 / tm;
 480
 481                     /* Compute center of mass for this group */
 482                     for (m = 0; (m < DIM); m++)
 483                     {
 484                         vcm->group_x[g][m] *= tm_1;
 485                     }
 486
 487                     /* Subtract the center of mass contribution to the
 488                      * angular momentum
 489                      */
 490                     cprod(vcm->group_x[g], vcm->group_v[g], jcm);
 491                     for (m = 0; (m < DIM); m++)
 492                     {
 493                         vcm->group_j[g][m] -= tm * jcm[m];
 494                     }
 495
 496                     /* Subtract the center of mass contribution from the inertia
 497                      * tensor (this is not as trivial as it seems, but due to
 498                      * some cancellation we can still do it, even in parallel).
 499                      */
 500                     clear_mat(Icm);
 501                     update_tensor(vcm->group_x[g], tm, Icm);
 502                     m_sub(vcm->group_i[g], Icm, vcm->group_i[g]);
 503
 504                     /* Compute angular velocity, using matrix operation
 505                      * Since J = I w
 506                      * we have
 507                      * w = I^-1 J
 508                      */
 509                     get_minv(vcm->group_i[g], Icm);
 510                     mvmul(Icm, vcm->group_j[g], vcm->group_w[g]);
 511                 }
 512                 /* Else it's zero anyway! */
 513             }
 514         }
 515     }
 516     for (g = 0; (g < vcm->nr); g++)
 517     {
 518         ekcm = 0;
 519         if (vcm->group_mass[g] != 0 && vcm->group_ndf[g] > 0)
 520         {
 521             for (m = 0; m < vcm->ndim; m++)
 522             {
 523                 ekcm += gmx::square(vcm->group_v[g][m]);
 524             }
 525             ekcm *= 0.5 * vcm->group_mass[g];
 526             Temp_cm = 2 * ekcm / vcm->group_ndf[g];
 527
 528             if ((Temp_cm > Temp_Max) && fp)
 529             {
 530                 fprintf(fp, "Large VCM(group %s): %12.5f, %12.5f, %12.5f, Temp-cm: %12.5e\n",
 531                         vcm->group_name[g], vcm->group_v[g][XX], vcm->group_v[g][YY],
 532                         vcm->group_v[g][ZZ], Temp_cm);
 533             }
 534
 535             if (vcm->mode == ecmANGULAR)
 536             {
 537                 ekrot = 0.5 * iprod(vcm->group_j[g], vcm->group_w[g]);
 538                 // TODO: Change absolute energy comparison to relative
 539                 if ((ekrot > 1) && fp && vcm->integratorConservesMomentum)
 540                 {
 541                     /* if we have an integrator that may not conserve momenta, skip */
 542                     tm = vcm->group_mass[g];
 543                     fprintf(fp, "Group %s with mass %12.5e, Ekrot %12.5e Det(I) = %12.5e\n",
 544                             vcm->group_name[g], tm, ekrot, det(vcm->group_i[g]));
 545                     fprintf(fp, "  COM: %12.5f  %12.5f  %12.5f\n", vcm->group_x[g][XX],
 546                             vcm->group_x[g][YY], vcm->group_x[g][ZZ]);
 547                     fprintf(fp, "  P:   %12.5f  %12.5f  %12.5f\n", vcm->group_p[g][XX],
 548                             vcm->group_p[g][YY], vcm->group_p[g][ZZ]);
 549                     fprintf(fp, "  V:   %12.5f  %12.5f  %12.5f\n", vcm->group_v[g][XX],
 550                             vcm->group_v[g][YY], vcm->group_v[g][ZZ]);
 551                     fprintf(fp, "  J:   %12.5f  %12.5f  %12.5f\n", vcm->group_j[g][XX],
 552                             vcm->group_j[g][YY], vcm->group_j[g][ZZ]);
 553                     fprintf(fp, "  w:   %12.5f  %12.5f  %12.5f\n", vcm->group_w[g][XX],
 554                             vcm->group_w[g][YY], vcm->group_w[g][ZZ]);
 555                     pr_rvecs(fp, 0, "Inertia tensor", vcm->group_i[g], DIM);
 556                 }
 557             }
 558         }
 559     }
 560 }
 561
 562 void process_and_stopcm_grp(FILE* fplog, t_vcm* vcm, const t_mdatoms& mdatoms, rvec x[], rvec v[])
 563 {
 564     if (vcm->mode != ecmNO)
 565     {
 566         // TODO: Replace fixed temperature of 1 by a system value
 567         process_and_check_cm_grp(fplog, vcm, 1);
 568
 569         do_stopcm_grp(mdatoms, x, v, *vcm);
 570     }
 571 }