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