src/gromacs/mdlib/stat.c

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