src/gromacs/mdlib/ebin.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) 2012,2014,2015,2017,2018 by the GROMACS development team.
   7  * Copyright (c) 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 /* This file is completely threadsafe - keep it that way! */
  39 #include "gmxpre.h"
  40
  41 #include "ebin.h"
  42
  43 #include <cmath>
  44 #include <cstring>
  45
  46 #include <algorithm>
  47
  48 #include "gromacs/math/units.h"
  49 #include "gromacs/math/utilities.h"
  50 #include "gromacs/math/vec.h"
  51 #include "gromacs/topology/ifunc.h"
  52 #include "gromacs/trajectory/energyframe.h"
  53 #include "gromacs/utility/arrayref.h"
  54 #include "gromacs/utility/basedefinitions.h"
  55 #include "gromacs/utility/cstringutil.h"
  56 #include "gromacs/utility/fatalerror.h"
  57 #include "gromacs/utility/smalloc.h"
  58 #include "gromacs/utility/stringutil.h"
  59
  60 t_ebin* mk_ebin()
  61 {
  62     t_ebin* eb;
  63
  64     snew(eb, 1);
  65
  66     return eb;
  67 }
  68
  69 void done_ebin(t_ebin* eb)
  70 {
  71     for (int i = 0; i < eb->nener; i++)
  72     {
  73         sfree(eb->enm[i].name);
  74         sfree(eb->enm[i].unit);
  75     }
  76     sfree(eb->e);
  77     sfree(eb->e_sim);
  78     sfree(eb->enm);
  79     sfree(eb);
  80 }
  81
  82 int get_ebin_space(t_ebin* eb, int nener, const char* const enm[], const char* unit)
  83 {
  84     int         index;
  85     int         i, f;
  86     const char* u;
  87
  88     index = eb->nener;
  89     eb->nener += nener;
  90     srenew(eb->e, eb->nener);
  91     srenew(eb->e_sim, eb->nener);
  92     srenew(eb->enm, eb->nener);
  93     for (i = index; (i < eb->nener); i++)
  94     {
  95         eb->e[i].e        = 0;
  96         eb->e[i].eav      = 0;
  97         eb->e[i].esum     = 0;
  98         eb->e_sim[i].e    = 0;
  99         eb->e_sim[i].eav  = 0;
 100         eb->e_sim[i].esum = 0;
 101         eb->enm[i].name   = gmx_strdup(enm[i - index]);
 102         if (unit != nullptr)
 103         {
 104             eb->enm[i].unit = gmx_strdup(unit);
 105         }
 106         else
 107         {
 108             /* Determine the unit from the longname.
 109              * These units should have been defined in ifunc.c
 110              * But even better would be if all interactions functions
 111              * return energies and all non-interaction function
 112              * entries would be removed from the ifunc array.
 113              */
 114             u = unit_energy;
 115             for (f = 0; f < F_NRE; f++)
 116             {
 117                 if (strcmp(eb->enm[i].name, interaction_function[f].longname) == 0)
 118                 {
 119                     /* Only the terms in this list are not energies */
 120                     switch (f)
 121                     {
 122                         case F_DISRESVIOL: u = unit_length; break;
 123                         case F_ORIRESDEV: u = "obs"; break;
 124                         case F_TEMP: u = unit_temp_K; break;
 125                         case F_PDISPCORR:
 126                         case F_PRES: u = unit_pres_bar; break;
 127                     }
 128                 }
 129             }
 130             eb->enm[i].unit = gmx_strdup(u);
 131         }
 132     }
 133
 134     return index;
 135 }
 136
 137 void add_ebin(t_ebin* eb, int entryIndex, int nener, const real ener[], gmx_bool bSum)
 138 {
 139     int       i, m;
 140     double    e, invmm, diff;
 141     t_energy *eg, *egs;
 142
 143     if ((entryIndex + nener > eb->nener) || (entryIndex < 0))
 144     {
 145         gmx_fatal(FARGS,
 146                   "%s-%d: Energies out of range: entryIndex=%d nener=%d maxener=%d",
 147                   __FILE__,
 148                   __LINE__,
 149                   entryIndex,
 150                   nener,
 151                   eb->nener);
 152     }
 153
 154     eg = &(eb->e[entryIndex]);
 155
 156     for (i = 0; (i < nener); i++)
 157     {
 158         eg[i].e = ener[i];
 159     }
 160
 161     if (bSum)
 162     {
 163         egs = &(eb->e_sim[entryIndex]);
 164
 165         m = eb->nsum;
 166
 167         if (m == 0)
 168         {
 169             for (i = 0; (i < nener); i++)
 170             {
 171                 eg[i].eav  = 0;
 172                 eg[i].esum = ener[i];
 173                 egs[i].esum += ener[i];
 174             }
 175         }
 176         else
 177         {
 178             invmm = (1.0 / m) / (m + 1.0);
 179
 180             for (i = 0; (i < nener); i++)
 181             {
 182                 /* Value for this component */
 183                 e = ener[i];
 184
 185                 /* first update sigma, then sum */
 186                 diff = eg[i].esum - m * e;
 187                 eg[i].eav += diff * diff * invmm;
 188                 eg[i].esum += e;
 189                 egs[i].esum += e;
 190             }
 191         }
 192     }
 193 }
 194
 195 // TODO It would be faster if this function was templated on both bSum
 196 // and whether eb->nsum was zero, to lift the branches out of the loop
 197 // over all possible energy terms, but that is true for a lot of the
 198 // ebin and mdebin functionality, so we should do it all or nothing.
 199 void add_ebin_indexed(t_ebin*                   eb,
 200                       int                       entryIndex,
 201                       gmx::ArrayRef<bool>       shouldUse,
 202                       gmx::ArrayRef<const real> ener,
 203                       gmx_bool                  bSum)
 204 {
 205
 206     GMX_ASSERT(shouldUse.size() == ener.size(), "View sizes must match");
 207     GMX_ASSERT(entryIndex + std::count(shouldUse.begin(), shouldUse.end(), true) <= eb->nener,
 208                gmx::formatString("Energies out of range: entryIndex=%d nener=%td maxener=%d",
 209                                  entryIndex,
 210                                  std::count(shouldUse.begin(), shouldUse.end(), true),
 211                                  eb->nener)
 212                        .c_str());
 213     GMX_ASSERT(entryIndex >= 0, "Must have non-negative entry");
 214
 215     const int    m              = eb->nsum;
 216     const double invmm          = (m == 0) ? 0 : (1.0 / m) / (m + 1.0);
 217     t_energy*    energyEntry    = &(eb->e[entryIndex]);
 218     t_energy*    simEnergyEntry = &(eb->e_sim[entryIndex]);
 219     auto         shouldUseIter  = shouldUse.begin();
 220     for (const auto& theEnergy : ener)
 221     {
 222         if (*shouldUseIter)
 223         {
 224             energyEntry->e = theEnergy;
 225             if (bSum)
 226             {
 227                 if (m == 0)
 228                 {
 229                     energyEntry->eav  = 0;
 230                     energyEntry->esum = theEnergy;
 231                     simEnergyEntry->esum += theEnergy;
 232                 }
 233                 else
 234                 {
 235                     /* first update sigma, then sum */
 236                     double diff = energyEntry->esum - m * theEnergy;
 237                     energyEntry->eav += diff * diff * invmm;
 238                     energyEntry->esum += theEnergy;
 239                     simEnergyEntry->esum += theEnergy;
 240                 }
 241                 ++simEnergyEntry;
 242             }
 243             ++energyEntry;
 244         }
 245         ++shouldUseIter;
 246     }
 247 }
 248
 249 void ebin_increase_count(int increment, t_ebin* eb, gmx_bool bSum)
 250 {
 251     eb->nsteps += increment;
 252     eb->nsteps_sim += increment;
 253
 254     if (bSum)
 255     {
 256         eb->nsum += increment;
 257         eb->nsum_sim += increment;
 258     }
 259 }
 260
 261 void reset_ebin_sums(t_ebin* eb)
 262 {
 263     eb->nsteps = 0;
 264     eb->nsum   = 0;
 265     /* The actual sums are cleared when the next frame is stored */
 266 }
 267
 268 void pr_ebin(FILE* fp, t_ebin* eb, int entryIndex, int nener, int nperline, int prmode, gmx_bool bPrHead)
 269 {
 270     int  i, j, i0;
 271     int  rc;
 272     char buf[30];
 273
 274     rc = 0;
 275
 276     if (entryIndex < 0 || entryIndex > eb->nener)
 277     {
 278         gmx_fatal(FARGS, "Invalid entryIndex in pr_ebin: %d", entryIndex);
 279     }
 280     int start = entryIndex;
 281     if (nener > eb->nener)
 282     {
 283         gmx_fatal(FARGS, "Invalid nener in pr_ebin: %d", nener);
 284     }
 285     int end = eb->nener;
 286     if (nener != -1)
 287     {
 288         end = entryIndex + nener;
 289     }
 290     for (i = start; (i < end) && rc >= 0;)
 291     {
 292         if (bPrHead)
 293         {
 294             i0 = i;
 295             for (j = 0; (j < nperline) && (i < end) && rc >= 0; j++, i++)
 296             {
 297                 if (strncmp(eb->enm[i].name, "Pres", 4) == 0)
 298                 {
 299                     /* Print the pressure unit to avoid confusion */
 300                     sprintf(buf, "%s (%s)", eb->enm[i].name, unit_pres_bar);
 301                     rc = fprintf(fp, "%15s", buf);
 302                 }
 303                 else
 304                 {
 305                     rc = fprintf(fp, "%15s", eb->enm[i].name);
 306                 }
 307             }
 308
 309             if (rc >= 0)
 310             {
 311                 rc = fprintf(fp, "\n");
 312             }
 313
 314             i = i0;
 315         }
 316         for (j = 0; (j < nperline) && (i < end) && rc >= 0; j++, i++)
 317         {
 318             switch (prmode)
 319             {
 320                 case eprNORMAL: rc = fprintf(fp, "   %12.5e", eb->e[i].e); break;
 321                 case eprAVER:
 322                     if (eb->nsum_sim > 0)
 323                     {
 324                         rc = fprintf(fp, "   %12.5e", eb->e_sim[i].esum / eb->nsum_sim);
 325                     }
 326                     else
 327                     {
 328                         rc = fprintf(fp, "    %-12s", "N/A");
 329                     }
 330                     break;
 331                 default: gmx_fatal(FARGS, "Invalid print mode %d in pr_ebin", prmode);
 332             }
 333         }
 334         if (rc >= 0)
 335         {
 336             rc = fprintf(fp, "\n");
 337         }
 338     }
 339     if (rc < 0)
 340     {
 341         gmx_fatal(FARGS, "Cannot write to logfile; maybe you are out of disk space?");
 342     }
 343 }