src/gromacs/mdlib/stat.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,2021, 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 #include "gmxpre.h"
  39
  40 #include "stat.h"
  41
  42 #include <cstdio>
  43 #include <cstring>
  44
  45 #include "gromacs/domdec/domdec.h"
  46 #include "gromacs/domdec/domdec_struct.h"
  47 #include "gromacs/fileio/checkpoint.h"
  48 #include "gromacs/fileio/xtcio.h"
  49 #include "gromacs/gmxlib/network.h"
  50 #include "gromacs/math/utilities.h"
  51 #include "gromacs/math/vec.h"
  52 #include "gromacs/mdlib/md_support.h"
  53 #include "gromacs/mdlib/rbin.h"
  54 #include "gromacs/mdlib/tgroup.h"
  55 #include "gromacs/mdlib/vcm.h"
  56 #include "gromacs/mdtypes/commrec.h"
  57 #include "gromacs/mdtypes/enerdata.h"
  58 #include "gromacs/mdtypes/group.h"
  59 #include "gromacs/mdtypes/inputrec.h"
  60 #include "gromacs/mdtypes/md_enums.h"
  61 #include "gromacs/utility/fatalerror.h"
  62 #include "gromacs/utility/futil.h"
  63 #include "gromacs/utility/smalloc.h"
  64
  65 typedef struct gmx_global_stat
  66 {
  67     t_bin* rb;
  68     int*   itc0;
  69     int*   itc1;
  70 } t_gmx_global_stat;
  71
  72 gmx_global_stat_t global_stat_init(const t_inputrec* ir)
  73 {
  74     gmx_global_stat_t gs;
  75
  76     snew(gs, 1);
  77
  78     gs->rb = mk_bin();
  79     snew(gs->itc0, ir->opts.ngtc);
  80     snew(gs->itc1, ir->opts.ngtc);
  81
  82     return gs;
  83 }
  84
  85 void global_stat_destroy(gmx_global_stat_t gs)
  86 {
  87     destroy_bin(gs->rb);
  88     sfree(gs->itc0);
  89     sfree(gs->itc1);
  90     sfree(gs);
  91 }
  92
  93 static int filter_enerdterm(const real* afrom, gmx_bool bToBuffer, real* ato, gmx_bool bTemp, gmx_bool bPres, gmx_bool bEner)
  94 {
  95     int i, to, from;
  96
  97     from = 0;
  98     to   = 0;
  99     for (i = 0; i < F_NRE; i++)
 100     {
 101         if (bToBuffer)
 102         {
 103             from = i;
 104         }
 105         else
 106         {
 107             to = i;
 108         }
 109         switch (i)
 110         {
 111             case F_EKIN:
 112             case F_TEMP:
 113             case F_DKDL:
 114                 if (bTemp)
 115                 {
 116                     ato[to++] = afrom[from++];
 117                 }
 118                 break;
 119             case F_PRES:
 120             case F_PDISPCORR:
 121                 if (bPres)
 122                 {
 123                     ato[to++] = afrom[from++];
 124                 }
 125                 break;
 126             default:
 127                 if (bEner)
 128                 {
 129                     ato[to++] = afrom[from++];
 130                 }
 131                 break;
 132         }
 133     }
 134
 135     return to;
 136 }
 137
 138 void global_stat(const gmx_global_stat* gs,
 139                  const t_commrec*       cr,
 140                  gmx_enerdata_t*        enerd,
 141                  tensor                 fvir,
 142                  tensor                 svir,
 143                  const t_inputrec*      inputrec,
 144                  gmx_ekindata_t*        ekind,
 145                  gmx::ArrayRef<real>    constraintsRmsdData,
 146                  t_vcm*                 vcm,
 147                  int                    nsig,
 148                  real*                  sig,
 149                  bool                   bSumEkinhOld,
 150                  int                    flags)
 151 /* instead of current system, gmx_booleans for summing virial, kinetic energy, and other terms */
 152 {
 153     t_bin* rb;
 154     int *  itc0, *itc1;
 155     int    ie = 0, ifv = 0, isv = 0, irmsd = 0;
 156     int idedl = 0, idedlo = 0, idvdll = 0, idvdlnl = 0, iepl = 0, icm = 0, imass = 0, ica = 0, inb = 0;
 157     int      isig = -1;
 158     int      icj = -1, ici = -1, icx = -1;
 159     int      inn[static_cast<int>(NonBondedEnergyTerms::Count)];
 160     real     copyenerd[F_NRE];
 161     int      nener, j;
 162     double   nb;
 163     gmx_bool bVV, bTemp, bEner, bPres, bConstrVir, bEkinAveVel, bReadEkin;
 164     bool checkNumberOfBondedInteractions = (flags & CGLO_CHECK_NUMBER_OF_BONDED_INTERACTIONS) != 0;
 165
 166     bVV         = EI_VV(inputrec->eI);
 167     bTemp       = ((flags & CGLO_TEMPERATURE) != 0);
 168     bEner       = ((flags & CGLO_ENERGY) != 0);
 169     bPres       = ((flags & CGLO_PRESSURE) != 0);
 170     bConstrVir  = ((flags & CGLO_CONSTRAINT) != 0);
 171     bEkinAveVel = (inputrec->eI == IntegrationAlgorithm::VV
 172                    || (inputrec->eI == IntegrationAlgorithm::VVAK && bPres));
 173     bReadEkin   = ((flags & CGLO_READEKIN) != 0);
 174
 175     rb   = gs->rb;
 176     itc0 = gs->itc0;
 177     itc1 = gs->itc1;
 178
 179
 180     reset_bin(rb);
 181     /* This routine copies all the data to be summed to one big buffer
 182      * using the t_bin struct.
 183      */
 184
 185     /* First, we neeed to identify which enerd->term should be
 186        communicated.  Temperature and pressure terms should only be
 187        communicated and summed when they need to be, to avoid repeating
 188        the sums and overcounting. */
 189
 190     nener = filter_enerdterm(enerd->term, TRUE, copyenerd, bTemp, bPres, bEner);
 191
 192     /* First, the data that needs to be communicated with velocity verlet every time
 193        This is just the constraint virial.*/
 194     if (bConstrVir)
 195     {
 196         isv = add_binr(rb, DIM * DIM, svir[0]);
 197     }
 198
 199     /* We need the force virial and the kinetic energy for the first time through with velocity verlet */
 200     if (bTemp || !bVV)
 201     {
 202         if (ekind)
 203         {
 204             for (j = 0; (j < inputrec->opts.ngtc); j++)
 205             {
 206                 if (bSumEkinhOld)
 207                 {
 208                     itc0[j] = add_binr(rb, DIM * DIM, ekind->tcstat[j].ekinh_old[0]);
 209                 }
 210                 if (bEkinAveVel && !bReadEkin)
 211                 {
 212                     itc1[j] = add_binr(rb, DIM * DIM, ekind->tcstat[j].ekinf[0]);
 213                 }
 214                 else if (!bReadEkin)
 215                 {
 216                     itc1[j] = add_binr(rb, DIM * DIM, ekind->tcstat[j].ekinh[0]);
 217                 }
 218             }
 219             /* these probably need to be put into one of these categories */
 220             idedl = add_binr(rb, 1, &(ekind->dekindl));
 221             if (bSumEkinhOld)
 222             {
 223                 idedlo = add_binr(rb, 1, &(ekind->dekindl_old));
 224             }
 225             if (ekind->cosacc.cos_accel != 0)
 226             {
 227                 ica = add_binr(rb, 1, &(ekind->cosacc.mvcos));
 228             }
 229         }
 230     }
 231
 232     if (bPres)
 233     {
 234         ifv = add_binr(rb, DIM * DIM, fvir[0]);
 235     }
 236
 237     if (bEner)
 238     {
 239         ie = add_binr(rb, nener, copyenerd);
 240         if (!constraintsRmsdData.empty())
 241         {
 242             irmsd = add_binr(rb, 2, constraintsRmsdData.data());
 243         }
 244
 245         for (j = 0; (j < static_cast<int>(NonBondedEnergyTerms::Count)); j++)
 246         {
 247             inn[j] = add_binr(rb, enerd->grpp.nener, enerd->grpp.energyGroupPairTerms[j].data());
 248         }
 249         if (inputrec->efep != FreeEnergyPerturbationType::No)
 250         {
 251             idvdll  = add_bind(rb, enerd->dvdl_lin);
 252             idvdlnl = add_bind(rb, enerd->dvdl_nonlin);
 253             if (enerd->foreignLambdaTerms.numLambdas() > 0)
 254             {
 255                 iepl = add_bind(rb,
 256                                 enerd->foreignLambdaTerms.energies().size(),
 257                                 enerd->foreignLambdaTerms.energies().data());
 258             }
 259         }
 260     }
 261
 262     if (vcm)
 263     {
 264         icm   = add_binr(rb, DIM * vcm->nr, vcm->group_p[0]);
 265         imass = add_binr(rb, vcm->nr, vcm->group_mass.data());
 266         if (vcm->mode == ComRemovalAlgorithm::Angular)
 267         {
 268             icj = add_binr(rb, DIM * vcm->nr, vcm->group_j[0]);
 269             icx = add_binr(rb, DIM * vcm->nr, vcm->group_x[0]);
 270             ici = add_binr(rb, DIM * DIM * vcm->nr, vcm->group_i[0][0]);
 271         }
 272     }
 273
 274     if (checkNumberOfBondedInteractions)
 275     {
 276         GMX_RELEASE_ASSERT(DOMAINDECOMP(cr),
 277                            "No need to check number of bonded interactions when not using domain "
 278                            "decomposition");
 279         nb  = numBondedInteractions(*cr->dd);
 280         inb = add_bind(rb, 1, &nb);
 281     }
 282     if (nsig > 0)
 283     {
 284         isig = add_binr(rb, nsig, sig);
 285     }
 286
 287     /* Global sum it all */
 288     if (debug)
 289     {
 290         fprintf(debug, "Summing %d energies\n", rb->maxreal);
 291     }
 292     sum_bin(rb, cr);
 293
 294     /* Extract all the data locally */
 295
 296     if (bConstrVir)
 297     {
 298         extract_binr(rb, isv, DIM * DIM, svir[0]);
 299     }
 300
 301     /* We need the force virial and the kinetic energy for the first time through with velocity verlet */
 302     if (bTemp || !bVV)
 303     {
 304         if (ekind)
 305         {
 306             for (j = 0; (j < inputrec->opts.ngtc); j++)
 307             {
 308                 if (bSumEkinhOld)
 309                 {
 310                     extract_binr(rb, itc0[j], DIM * DIM, ekind->tcstat[j].ekinh_old[0]);
 311                 }
 312                 if (bEkinAveVel && !bReadEkin)
 313                 {
 314                     extract_binr(rb, itc1[j], DIM * DIM, ekind->tcstat[j].ekinf[0]);
 315                 }
 316                 else if (!bReadEkin)
 317                 {
 318                     extract_binr(rb, itc1[j], DIM * DIM, ekind->tcstat[j].ekinh[0]);
 319                 }
 320             }
 321             extract_binr(rb, idedl, 1, &(ekind->dekindl));
 322             if (bSumEkinhOld)
 323             {
 324                 extract_binr(rb, idedlo, 1, &(ekind->dekindl_old));
 325             }
 326             if (ekind->cosacc.cos_accel != 0)
 327             {
 328                 extract_binr(rb, ica, 1, &(ekind->cosacc.mvcos));
 329             }
 330         }
 331     }
 332     if (bPres)
 333     {
 334         extract_binr(rb, ifv, DIM * DIM, fvir[0]);
 335     }
 336
 337     if (bEner)
 338     {
 339         extract_binr(rb, ie, nener, copyenerd);
 340         if (!constraintsRmsdData.empty())
 341         {
 342             extract_binr(rb, irmsd, constraintsRmsdData);
 343         }
 344
 345         for (j = 0; (j < static_cast<int>(NonBondedEnergyTerms::Count)); j++)
 346         {
 347             extract_binr(rb, inn[j], enerd->grpp.nener, enerd->grpp.energyGroupPairTerms[j].data());
 348         }
 349         if (inputrec->efep != FreeEnergyPerturbationType::No)
 350         {
 351             extract_bind(rb, idvdll, enerd->dvdl_lin);
 352             extract_bind(rb, idvdlnl, enerd->dvdl_nonlin);
 353             if (enerd->foreignLambdaTerms.numLambdas() > 0)
 354             {
 355                 extract_bind(rb,
 356                              iepl,
 357                              enerd->foreignLambdaTerms.energies().size(),
 358                              enerd->foreignLambdaTerms.energies().data());
 359             }
 360         }
 361
 362         filter_enerdterm(copyenerd, FALSE, enerd->term, bTemp, bPres, bEner);
 363     }
 364
 365     if (vcm)
 366     {
 367         extract_binr(rb, icm, DIM * vcm->nr, vcm->group_p[0]);
 368         extract_binr(rb, imass, vcm->nr, vcm->group_mass.data());
 369         if (vcm->mode == ComRemovalAlgorithm::Angular)
 370         {
 371             extract_binr(rb, icj, DIM * vcm->nr, vcm->group_j[0]);
 372             extract_binr(rb, icx, DIM * vcm->nr, vcm->group_x[0]);
 373             extract_binr(rb, ici, DIM * DIM * vcm->nr, vcm->group_i[0][0]);
 374         }
 375     }
 376
 377     if (checkNumberOfBondedInteractions)
 378     {
 379         extract_bind(rb, inb, 1, &nb);
 380         GMX_RELEASE_ASSERT(DOMAINDECOMP(cr),
 381                            "No need to check number of bonded interactions when not using domain "
 382                            "decomposition");
 383         setNumberOfBondedInteractionsOverAllDomains(*cr->dd, gmx::roundToInt(nb));
 384     }
 385
 386     if (nsig > 0)
 387     {
 388         extract_binr(rb, isig, nsig, sig);
 389     }
 390 }