src/gromacs/mdlib/tests/energyoutput.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Tests for energy output to log and .edr files.
  38  *
  39  * \todo Position and orientation restraints tests.
  40  * \todo Average and sum in edr file test.
  41  * \todo AWH output tests.
  42  * \todo The log and edr outputs are currently saved to the file on the disk and then read
  43  *       to compare with the reference data. This will be more elegant (and run faster) when we
  44  *       refactor the output routines to write to a stream interface, which can already be handled
  45  *       in-memory when running tests.
  46  *
  47  * \author Mark Abraham <mark.j.abraham@gmail.com>
  48  * \author Artem Zhmurov <zhmurov@gmail.com>
  49  *
  50  * \ingroup module_mdlib
  51  */
  52 #include "gmxpre.h"
  53
  54 #include "gromacs/mdlib/energyoutput.h"
  55
  56 #include <cstdio>
  57
  58 #include <gtest/gtest.h>
  59
  60 #include "gromacs/mdlib/ebin.h"
  61 #include "gromacs/mdlib/makeconstraints.h"
  62 #include "gromacs/mdrunutility/handlerestart.h"
  63 #include "gromacs/mdtypes/commrec.h"
  64 #include "gromacs/mdtypes/fcdata.h"
  65 #include "gromacs/mdtypes/group.h"
  66 #include "gromacs/mdtypes/inputrec.h"
  67 #include "gromacs/mdtypes/mdatom.h"
  68 #include "gromacs/mdtypes/state.h"
  69 #include "gromacs/topology/topology.h"
  70 #include "gromacs/utility/cstringutil.h"
  71 #include "gromacs/utility/mdmodulenotification.h"
  72 #include "gromacs/utility/stringutil.h"
  73 #include "gromacs/utility/textreader.h"
  74 #include "gromacs/utility/unique_cptr.h"
  75
  76 #include "testutils/refdata.h"
  77 #include "testutils/setenv.h"
  78 #include "testutils/testasserts.h"
  79 #include "testutils/testfilemanager.h"
  80
  81 namespace gmx
  82 {
  83 namespace test
  84 {
  85 namespace
  86 {
  87
  88 //! Wraps fclose to discard the return value to use it as a deleter with gmx::unique_cptr.
  89 void fcloseWrapper(FILE* fp)
  90 {
  91     fclose(fp);
  92 }
  93
  94 /*! \brief Test parameters space.
  95  *
  96  * The test will run on a set of combinations of this steucture parameters.
  97  */
  98 struct EnergyOutputTestParameters
  99 {
 100     //! Thermostat (enum)
 101     int temperatureCouplingScheme;
 102     //! Barostat (enum)
 103     int pressureCouplingScheme;
 104     //! Integrator
 105     int integrator;
 106     //! Number of saved energy frames (to test averages output).
 107     int numFrames;
 108     //! If output should be initialized as a rerun.
 109     bool isRerun;
 110     //! Is box triclinic (off-diagonal elements will be printed).
 111     bool isBoxTriclinic;
 112 };
 113
 114 /*! \brief Sets of parameters on which to run the tests.
 115  *
 116  * Only several combinations of the parameters are used. Using all possible combinations will
 117  * require ~10 MB of test data and ~2 sec to run the tests.
 118  */
 119 const EnergyOutputTestParameters parametersSets[] = { { etcNO, epcNO, eiMD, 1, false, false },
 120                                                       { etcNO, epcNO, eiMD, 1, true, false },
 121                                                       { etcNO, epcNO, eiMD, 1, false, true },
 122                                                       { etcNO, epcNO, eiMD, 0, false, false },
 123                                                       { etcNO, epcNO, eiMD, 10, false, false },
 124                                                       { etcVRESCALE, epcNO, eiMD, 1, false, false },
 125                                                       { etcNOSEHOOVER, epcNO, eiMD, 1, false, false },
 126                                                       { etcNO, epcPARRINELLORAHMAN, eiMD, 1, false, false },
 127                                                       { etcNO, epcMTTK, eiMD, 1, false, false },
 128                                                       { etcNO, epcNO, eiVV, 1, false, false },
 129                                                       { etcNO, epcMTTK, eiVV, 1, false, false } };
 130
 131 /*! \brief Test fixture to test energy output.
 132  *
 133  * The class is initialized to maximize amount of energy terms printed.
 134  * The test is run for different combinations of temperature and pressure control
 135  * schemes. Different number of printed steps is also tested.
 136  */
 137 class EnergyOutputTest : public ::testing::TestWithParam<EnergyOutputTestParameters>
 138 {
 139 public:
 140     //! File manager
 141     TestFileManager fileManager_;
 142     //! Energy (.edr) file
 143     ener_file_t energyFile_;
 144     //! Input data
 145     t_inputrec inputrec_;
 146     //! Topology
 147     gmx_mtop_t mtop_;
 148     //! Simulation time
 149     double time_;
 150     //! Total mass
 151     real tmass_;
 152     //! Potential energy data
 153     std::unique_ptr<gmx_enerdata_t> enerdata_;
 154     //! Kinetic energy data (for temperatures output)
 155     gmx_ekindata_t ekindata_;
 156     //! System state
 157     t_state state_;
 158     //! PBC box
 159     matrix box_;
 160     //! Virial from constraints
 161     tensor constraintsVirial_;
 162     //! Virial from force computation
 163     tensor forceVirial_;
 164     //! Total virial
 165     tensor totalVirial_;
 166     //! Pressure
 167     tensor pressure_;
 168     //! Names for the groups.
 169     std::vector<std::string> groupNameStrings_ = { "Protein", "Water", "Lipid" };
 170     //! Names for the groups as C strings.
 171     std::vector<std::vector<char>> groupNameCStrings_;
 172     //! Handles to the names as C strings in the way needed for SimulationGroups.
 173     std::vector<char*> groupNameHandles_;
 174     //! Total dipole momentum
 175     rvec muTotal_;
 176     //! Communication record
 177     t_commrec cr_;
 178     //! Constraints object (for constraints RMSD output in case of LINCS)
 179     std::unique_ptr<Constraints> constraints_;
 180     //! Temporary output filename
 181     std::string logFilename_;
 182     //! Temporary energy output filename
 183     std::string edrFilename_;
 184     //! Pointer to a temporary output file
 185     FILE* log_;
 186     //! Log file wrapper
 187     unique_cptr<FILE, fcloseWrapper> logFileGuard_;
 188     //! Reference data
 189     TestReferenceData refData_;
 190     //! Checker for reference data
 191     TestReferenceChecker checker_;
 192
 193     EnergyOutputTest() :
 194         logFilename_(fileManager_.getTemporaryFilePath(".log")),
 195         edrFilename_(fileManager_.getTemporaryFilePath(".edr")),
 196         log_(std::fopen(logFilename_.c_str(), "w")),
 197         logFileGuard_(log_),
 198         checker_(refData_.rootChecker())
 199     {
 200         // Input record
 201         inputrec_.delta_t = 0.001;
 202
 203         // F_EQM
 204         inputrec_.bQMMM = true;
 205         // F_RF_EXCL will not be tested - group scheme is not supported any more
 206         inputrec_.cutoff_scheme = ecutsVERLET;
 207         // F_COUL_RECIP
 208         inputrec_.coulombtype = eelPME;
 209         // F_LJ_RECIP
 210         inputrec_.vdwtype = evdwPME;
 211
 212         // F_DVDL_COUL, F_DVDL_VDW, F_DVDL_BONDED, F_DVDL_RESTRAINT, F_DKDL and F_DVDL
 213         inputrec_.efep                                  = efepYES;
 214         inputrec_.fepvals->separate_dvdl[efptCOUL]      = true;
 215         inputrec_.fepvals->separate_dvdl[efptVDW]       = true;
 216         inputrec_.fepvals->separate_dvdl[efptBONDED]    = true;
 217         inputrec_.fepvals->separate_dvdl[efptRESTRAINT] = true;
 218         inputrec_.fepvals->separate_dvdl[efptMASS]      = true;
 219         inputrec_.fepvals->separate_dvdl[efptCOUL]      = true;
 220         inputrec_.fepvals->separate_dvdl[efptFEP]       = true;
 221
 222         // F_DISPCORR and F_PDISPCORR
 223         inputrec_.eDispCorr = edispcEner;
 224         inputrec_.bRot      = true;
 225
 226         // F_ECONSERVED
 227         inputrec_.ref_p[YY][XX] = 0.0;
 228         inputrec_.ref_p[ZZ][XX] = 0.0;
 229         inputrec_.ref_p[ZZ][YY] = 0.0;
 230
 231         // Dipole (mu)
 232         inputrec_.ewald_geometry = eewg3DC;
 233
 234         // GMX_CONSTRAINTVIR environment variable should also be
 235         // set to print constraints and force virials separately.
 236         gmxSetenv("GMX_CONSTRAINTVIR", "true", 1);
 237         // To print constrain RMSD, constraints algorithm should be set to LINCS.
 238         inputrec_.eConstrAlg = econtLINCS;
 239
 240         mtop_.bIntermolecularInteractions = false;
 241
 242         // Constructing molecular topology
 243         gmx_moltype_t molType;
 244
 245         molType.atoms.nr = 2;
 246
 247         // F_CONSTR
 248         // This must be initialized so that Constraints object can be created below.
 249         InteractionList interactionListConstr;
 250         interactionListConstr.iatoms.resize(NRAL(F_CONSTR) + 1);
 251         interactionListConstr.iatoms[0] = 0;
 252         interactionListConstr.iatoms[1] = 0;
 253         interactionListConstr.iatoms[2] = 1;
 254         molType.ilist.at(F_CONSTR)      = interactionListConstr;
 255
 256         InteractionList interactionListEmpty;
 257         interactionListEmpty.iatoms.resize(0);
 258         molType.ilist.at(F_CONSTRNC) = interactionListEmpty;
 259         molType.ilist.at(F_SETTLE)   = interactionListEmpty;
 260
 261         // F_LJ14 and F_COUL14
 262         InteractionList interactionListLJ14;
 263         interactionListLJ14.iatoms.resize(NRAL(F_LJ14) + 1);
 264         molType.ilist.at(F_LJ14) = interactionListLJ14;
 265
 266         // F_LJC14_Q
 267         InteractionList interactionListLJC14Q;
 268         interactionListLJC14Q.iatoms.resize(NRAL(F_LJC14_Q) + 1);
 269         molType.ilist.at(F_LJC14_Q) = interactionListLJC14Q;
 270
 271         // TODO Do proper initialization for distance and orientation
 272         //      restraints and remove comments to enable their output
 273         // F_DISRES
 274         // InteractionList interactionListDISRES;
 275         // interactionListDISRES.iatoms.resize(NRAL(F_DISRES) + 1);
 276         // molType.ilist.at(F_DISRES)   = interactionListDISRES;
 277         //
 278         // F_ORIRES
 279         // InteractionList interactionListORIRES;
 280         // interactionListORIRES.iatoms.resize(NRAL(F_ORIRES) + 1);
 281         // molType.ilist.at(F_ORIRES)   = interactionListORIRES;
 282
 283         mtop_.moltype.push_back(molType);
 284
 285         gmx_molblock_t molBlock;
 286         molBlock.type = 0;
 287         molBlock.nmol = 1;
 288         mtop_.molblock.push_back(molBlock);
 289
 290         // This is to keep constraints initialization happy
 291         mtop_.natoms = 2;
 292         mtop_.ffparams.iparams.resize(F_NRE);
 293         mtop_.ffparams.functype.resize(F_NRE);
 294         mtop_.ffparams.iparams.at(F_CONSTR).constr.dA   = 1.0;
 295         mtop_.ffparams.iparams.at(F_CONSTR).constr.dB   = 1.0;
 296         mtop_.ffparams.iparams.at(F_CONSTRNC).constr.dA = 1.0;
 297         mtop_.ffparams.iparams.at(F_CONSTRNC).constr.dB = 1.0;
 298
 299         // Groups for energy output, temperature coupling and acceleration
 300         for (const auto& string : groupNameStrings_)
 301         {
 302             std::vector<char> cString(string.begin(), string.end());
 303             // Need to add null termination
 304             cString.push_back('\0');
 305             groupNameCStrings_.emplace_back(cString);
 306             groupNameHandles_.emplace_back(groupNameCStrings_.back().data());
 307         }
 308         for (auto& handle : groupNameHandles_)
 309         {
 310             mtop_.groups.groupNames.emplace_back(&handle);
 311         }
 312
 313         mtop_.groups.groups[SimulationAtomGroupType::EnergyOutput].resize(3);
 314         mtop_.groups.groups[SimulationAtomGroupType::EnergyOutput][0] = 0;
 315         mtop_.groups.groups[SimulationAtomGroupType::EnergyOutput][1] = 1;
 316         mtop_.groups.groups[SimulationAtomGroupType::EnergyOutput][2] = 2;
 317
 318         mtop_.groups.groups[SimulationAtomGroupType::TemperatureCoupling].resize(3);
 319         mtop_.groups.groups[SimulationAtomGroupType::TemperatureCoupling][0] = 0;
 320         mtop_.groups.groups[SimulationAtomGroupType::TemperatureCoupling][1] = 1;
 321         mtop_.groups.groups[SimulationAtomGroupType::TemperatureCoupling][2] = 2;
 322
 323         mtop_.groups.groups[SimulationAtomGroupType::Acceleration].resize(2);
 324         mtop_.groups.groups[SimulationAtomGroupType::Acceleration][0] = 0;
 325         mtop_.groups.groups[SimulationAtomGroupType::Acceleration][1] = 2;
 326
 327         // Nose-Hoover chains
 328         inputrec_.bPrintNHChains     = true;
 329         inputrec_.opts.nhchainlength = 2;
 330         state_.nosehoover_xi.resize(
 331                 mtop_.groups.groups[SimulationAtomGroupType::TemperatureCoupling].size()
 332                 * inputrec_.opts.nhchainlength);
 333         state_.nosehoover_vxi.resize(
 334                 mtop_.groups.groups[SimulationAtomGroupType::TemperatureCoupling].size()
 335                 * inputrec_.opts.nhchainlength);
 336
 337         // This will be needed only with MTTK barostat
 338         state_.nhpres_xi.resize(1 * inputrec_.opts.nhchainlength);
 339         state_.nhpres_vxi.resize(1 * inputrec_.opts.nhchainlength);
 340
 341         // Group pairs
 342         enerdata_ = std::make_unique<gmx_enerdata_t>(
 343                 mtop_.groups.groups[SimulationAtomGroupType::EnergyOutput].size(), 0);
 344
 345         // Kinetic energy and related data
 346         ekindata_.tcstat.resize(mtop_.groups.groups[SimulationAtomGroupType::TemperatureCoupling].size());
 347         ekindata_.grpstat.resize(mtop_.groups.groups[SimulationAtomGroupType::Acceleration].size());
 348
 349         // This is needed so that the ebin space will be allocated
 350         inputrec_.cos_accel = 1.0;
 351         // This is to keep the destructor happy (otherwise sfree() segfaults)
 352         ekindata_.nthreads = 0;
 353         snew(ekindata_.ekin_work_alloc, 1);
 354         snew(ekindata_.ekin_work, 1);
 355         snew(ekindata_.dekindl_work, 1);
 356
 357         // Group options for annealing output
 358         inputrec_.opts.ngtc = 3;
 359         snew(inputrec_.opts.ref_t, inputrec_.opts.ngtc);
 360         snew(inputrec_.opts.annealing, inputrec_.opts.ngtc);
 361         inputrec_.opts.annealing[0] = eannNO;
 362         inputrec_.opts.annealing[1] = eannSINGLE;
 363         inputrec_.opts.annealing[2] = eannPERIODIC;
 364
 365         // This is to keep done_inputrec happy (otherwise sfree() segfaults)
 366         snew(inputrec_.opts.anneal_time, inputrec_.opts.ngtc);
 367         snew(inputrec_.opts.anneal_temp, inputrec_.opts.ngtc);
 368
 369         // Communication record (for Constraints constructor)
 370         cr_.nnodes = 1;
 371         cr_.dd     = nullptr;
 372
 373         // Constraints object (to get constraints RMSD from)
 374         // TODO EnergyOutput should not take Constraints object
 375         // TODO This object will always return zero as RMSD value.
 376         //      It is more relevant to have non-zero value for testing.
 377         constraints_ = makeConstraints(mtop_, inputrec_, nullptr, false, nullptr, &cr_, nullptr,
 378                                        nullptr, nullptr, false);
 379     }
 380
 381     /*! \brief Helper function to generate synthetic data to output
 382      *
 383      * \param[in,out] testValue    Base value fr energy data.
 384      */
 385     void setStepData(double* testValue)
 386     {
 387
 388         time_  = (*testValue += 0.1);
 389         tmass_ = (*testValue += 0.1);
 390
 391         enerdata_->term[F_LJ]      = (*testValue += 0.1);
 392         enerdata_->term[F_COUL_SR] = (*testValue += 0.1);
 393         enerdata_->term[F_EPOT]    = (*testValue += 0.1);
 394         enerdata_->term[F_EKIN]    = (*testValue += 0.1);
 395         enerdata_->term[F_ETOT]    = (*testValue += 0.1);
 396         enerdata_->term[F_TEMP]    = (*testValue += 0.1);
 397         enerdata_->term[F_PRES]    = (*testValue += 0.1);
 398
 399         enerdata_->term[F_BHAM]         = (*testValue += 0.1);
 400         enerdata_->term[F_EQM]          = (*testValue += 0.1);
 401         enerdata_->term[F_RF_EXCL]      = (*testValue += 0.1);
 402         enerdata_->term[F_COUL_RECIP]   = (*testValue += 0.1);
 403         enerdata_->term[F_LJ_RECIP]     = (*testValue += 0.1);
 404         enerdata_->term[F_LJ14]         = (*testValue += 0.1);
 405         enerdata_->term[F_COUL14]       = (*testValue += 0.1);
 406         enerdata_->term[F_LJC14_Q]      = (*testValue += 0.1);
 407         enerdata_->term[F_LJC_PAIRS_NB] = (*testValue += 0.1);
 408
 409         enerdata_->term[F_DVDL_COUL]      = (*testValue += 0.1);
 410         enerdata_->term[F_DVDL_VDW]       = (*testValue += 0.1);
 411         enerdata_->term[F_DVDL_BONDED]    = (*testValue += 0.1);
 412         enerdata_->term[F_DVDL_RESTRAINT] = (*testValue += 0.1);
 413         enerdata_->term[F_DKDL]           = (*testValue += 0.1);
 414         enerdata_->term[F_DVDL]           = (*testValue += 0.1);
 415
 416         enerdata_->term[F_DISPCORR]   = (*testValue += 0.1);
 417         enerdata_->term[F_PDISPCORR]  = (*testValue += 0.1);
 418         enerdata_->term[F_DISRESVIOL] = (*testValue += 0.1);
 419         enerdata_->term[F_ORIRESDEV]  = (*testValue += 0.1);
 420         enerdata_->term[F_COM_PULL]   = (*testValue += 0.1);
 421         enerdata_->term[F_ECONSERVED] = (*testValue += 0.1);
 422
 423         // Group pairs
 424         for (int i = 0; i < enerdata_->grpp.nener; i++)
 425         {
 426             for (int k = 0; k < egNR; k++)
 427             {
 428                 enerdata_->grpp.ener[k][i] = (*testValue += 0.1);
 429             }
 430         }
 431
 432         // Kinetic energy and related data
 433         for (auto& tcstat : ekindata_.tcstat)
 434         {
 435             tcstat.T      = (*testValue += 0.1);
 436             tcstat.lambda = (*testValue += 0.1);
 437         }
 438         for (auto& grpstat : ekindata_.grpstat)
 439         {
 440             grpstat.u[XX] = (*testValue += 0.1);
 441             grpstat.u[YY] = (*testValue += 0.1);
 442             grpstat.u[ZZ] = (*testValue += 0.1);
 443         }
 444
 445         // This conditional is to check whether the ebin was allocated.
 446         // Otherwise it will print cosacc data into the first bin.
 447         if (inputrec_.cos_accel != 0)
 448         {
 449             ekindata_.cosacc.cos_accel = (*testValue += 0.1);
 450             ekindata_.cosacc.vcos      = (*testValue += 0.1);
 451         }
 452
 453         state_.box[XX][XX] = (*testValue += 0.1);
 454         state_.box[XX][YY] = (*testValue += 0.1);
 455         state_.box[XX][ZZ] = (*testValue += 0.1);
 456         state_.box[YY][XX] = (*testValue += 0.1);
 457         state_.box[YY][YY] = (*testValue += 0.1);
 458         state_.box[YY][ZZ] = (*testValue += 0.1);
 459         state_.box[ZZ][XX] = (*testValue += 0.1);
 460         state_.box[ZZ][YY] = (*testValue += 0.1);
 461         state_.box[ZZ][ZZ] = (*testValue += 0.1);
 462
 463         box_[XX][XX] = (*testValue += 0.1);
 464         box_[XX][YY] = (*testValue += 0.1);
 465         box_[XX][ZZ] = (*testValue += 0.1);
 466         box_[YY][XX] = (*testValue += 0.1);
 467         box_[YY][YY] = (*testValue += 0.1);
 468         box_[YY][ZZ] = (*testValue += 0.1);
 469         box_[ZZ][XX] = (*testValue += 0.1);
 470         box_[ZZ][YY] = (*testValue += 0.1);
 471         box_[ZZ][ZZ] = (*testValue += 0.1);
 472
 473         constraintsVirial_[XX][XX] = (*testValue += 0.1);
 474         constraintsVirial_[XX][YY] = (*testValue += 0.1);
 475         constraintsVirial_[XX][ZZ] = (*testValue += 0.1);
 476         constraintsVirial_[YY][XX] = (*testValue += 0.1);
 477         constraintsVirial_[YY][YY] = (*testValue += 0.1);
 478         constraintsVirial_[YY][ZZ] = (*testValue += 0.1);
 479         constraintsVirial_[ZZ][XX] = (*testValue += 0.1);
 480         constraintsVirial_[ZZ][YY] = (*testValue += 0.1);
 481         constraintsVirial_[ZZ][ZZ] = (*testValue += 0.1);
 482
 483         forceVirial_[XX][XX] = (*testValue += 0.1);
 484         forceVirial_[XX][YY] = (*testValue += 0.1);
 485         forceVirial_[XX][ZZ] = (*testValue += 0.1);
 486         forceVirial_[YY][XX] = (*testValue += 0.1);
 487         forceVirial_[YY][YY] = (*testValue += 0.1);
 488         forceVirial_[YY][ZZ] = (*testValue += 0.1);
 489         forceVirial_[ZZ][XX] = (*testValue += 0.1);
 490         forceVirial_[ZZ][YY] = (*testValue += 0.1);
 491         forceVirial_[ZZ][ZZ] = (*testValue += 0.1);
 492
 493         totalVirial_[XX][XX] = (*testValue += 0.1);
 494         totalVirial_[XX][YY] = (*testValue += 0.1);
 495         totalVirial_[XX][ZZ] = (*testValue += 0.1);
 496         totalVirial_[YY][XX] = (*testValue += 0.1);
 497         totalVirial_[YY][YY] = (*testValue += 0.1);
 498         totalVirial_[YY][ZZ] = (*testValue += 0.1);
 499         totalVirial_[ZZ][XX] = (*testValue += 0.1);
 500         totalVirial_[ZZ][YY] = (*testValue += 0.1);
 501         totalVirial_[ZZ][ZZ] = (*testValue += 0.1);
 502
 503         pressure_[XX][XX] = (*testValue += 0.1);
 504         pressure_[XX][YY] = (*testValue += 0.1);
 505         pressure_[XX][ZZ] = (*testValue += 0.1);
 506         pressure_[YY][XX] = (*testValue += 0.1);
 507         pressure_[YY][YY] = (*testValue += 0.1);
 508         pressure_[YY][ZZ] = (*testValue += 0.1);
 509         pressure_[ZZ][XX] = (*testValue += 0.1);
 510         pressure_[ZZ][YY] = (*testValue += 0.1);
 511         pressure_[ZZ][ZZ] = (*testValue += 0.1);
 512
 513         muTotal_[XX] = (*testValue += 0.1);
 514         muTotal_[YY] = (*testValue += 0.1);
 515         muTotal_[ZZ] = (*testValue += 0.1);
 516
 517         state_.boxv[XX][XX] = (*testValue += 0.1);
 518         state_.boxv[XX][YY] = (*testValue += 0.1);
 519         state_.boxv[XX][ZZ] = (*testValue += 0.1);
 520         state_.boxv[YY][XX] = (*testValue += 0.1);
 521         state_.boxv[YY][YY] = (*testValue += 0.1);
 522         state_.boxv[YY][ZZ] = (*testValue += 0.1);
 523         state_.boxv[ZZ][XX] = (*testValue += 0.1);
 524         state_.boxv[ZZ][YY] = (*testValue += 0.1);
 525         state_.boxv[ZZ][ZZ] = (*testValue += 0.1);
 526
 527         for (int i = 0; i < inputrec_.opts.ngtc; i++)
 528         {
 529             inputrec_.opts.ref_t[i] = (*testValue += 0.1);
 530         }
 531
 532         for (index k = 0; k < ssize(mtop_.groups.groups[SimulationAtomGroupType::TemperatureCoupling])
 533                                       * inputrec_.opts.nhchainlength;
 534              k++)
 535         {
 536             state_.nosehoover_xi[k]  = (*testValue += 0.1);
 537             state_.nosehoover_vxi[k] = (*testValue += 0.1);
 538         }
 539         for (int k = 0; k < inputrec_.opts.nhchainlength; k++)
 540         {
 541             state_.nhpres_xi[k]  = (*testValue += 0.1);
 542             state_.nhpres_vxi[k] = (*testValue += 0.1);
 543         }
 544     }
 545
 546     /*! \brief Check if the contents of the .edr file correspond to the reference data.
 547      *
 548      * The code below is based on the 'gmx dump' tool.
 549      *
 550      * \param[in] fileName    Name of the file to check.
 551      * \param[in] frameCount  Number of frames to check.
 552      */
 553     void checkEdrFile(const char* fileName, int frameCount)
 554     {
 555         ener_file_t  edrFile;
 556         gmx_enxnm_t* energyTermsEdr = nullptr;
 557         int          numEnergyTermsEdr;
 558
 559         edrFile = open_enx(fileName, "r");
 560         do_enxnms(edrFile, &numEnergyTermsEdr, &energyTermsEdr);
 561         assert(energyTermsEdr);
 562
 563         // Check header
 564         TestReferenceChecker edrFileRef(checker_.checkCompound("File", "EnergyFile"));
 565         TestReferenceChecker energyTermsRef(
 566                 edrFileRef.checkSequenceCompound("EnergyTerms", numEnergyTermsEdr));
 567         for (int i = 0; i < numEnergyTermsEdr; i++)
 568         {
 569             TestReferenceChecker energyTermRef(energyTermsRef.checkCompound("EnergyTerm", nullptr));
 570             energyTermRef.checkString(energyTermsEdr[i].name, "Name");
 571             energyTermRef.checkString(energyTermsEdr[i].unit, "Units");
 572         }
 573
 574         // Check frames
 575         TestReferenceChecker framesRef(edrFileRef.checkSequenceCompound("Frames", frameCount));
 576         t_enxframe*          frameEdr;
 577         snew(frameEdr, 1);
 578         char buffer[22];
 579         for (int frameId = 0; frameId < frameCount; frameId++)
 580         {
 581             bool bCont = do_enx(edrFile, frameEdr);
 582             EXPECT_TRUE(bCont) << gmx::formatString("Cant read frame %d from .edr file.", frameId);
 583
 584             TestReferenceChecker frameRef(framesRef.checkCompound("Frame", nullptr));
 585             frameRef.checkReal(frameEdr->t, "Time");
 586             frameRef.checkReal(frameEdr->dt, "Timestep");
 587             frameRef.checkString(gmx_step_str(frameEdr->step, buffer), "Step");
 588             frameRef.checkString(gmx_step_str(frameEdr->nsum, buffer), "NumSteps");
 589
 590             EXPECT_EQ(frameEdr->nre, numEnergyTermsEdr)
 591                     << gmx::formatString("Wrong number of energy terms in frame %d.", frameId);
 592             TestReferenceChecker energyValuesRef(
 593                     frameRef.checkSequenceCompound("EnergyTerms", numEnergyTermsEdr));
 594             for (int i = 0; i < numEnergyTermsEdr; i++)
 595             {
 596                 TestReferenceChecker energyValueRef(energyValuesRef.checkCompound("EnergyTerm", nullptr));
 597                 energyValueRef.checkString(energyTermsEdr[i].name, "Name");
 598                 energyValueRef.checkReal(frameEdr->ener[i].e, "Value");
 599             }
 600         }
 601
 602         free_enxnms(numEnergyTermsEdr, energyTermsEdr);
 603         done_ener_file(edrFile);
 604
 605         free_enxframe(frameEdr);
 606         sfree(frameEdr);
 607     }
 608 };
 609
 610 TEST_P(EnergyOutputTest, CheckOutput)
 611 {
 612     ASSERT_NE(log_, nullptr);
 613     // Binary output will be written to the temporary location
 614     energyFile_ = open_enx(edrFilename_.c_str(), "w");
 615     ASSERT_NE(energyFile_, nullptr);
 616
 617     EnergyOutputTestParameters parameters = GetParam();
 618     inputrec_.etc                         = parameters.temperatureCouplingScheme;
 619     inputrec_.epc                         = parameters.pressureCouplingScheme;
 620     inputrec_.eI                          = parameters.integrator;
 621
 622     if (parameters.isBoxTriclinic)
 623     {
 624         inputrec_.ref_p[YY][XX] = 1.0;
 625     }
 626
 627     MdModulesNotifier             mdModulesNotifier;
 628     std::unique_ptr<EnergyOutput> energyOutput = std::make_unique<EnergyOutput>(
 629             energyFile_, &mtop_, &inputrec_, nullptr, nullptr, parameters.isRerun,
 630             StartingBehavior::NewSimulation, mdModulesNotifier);
 631
 632     // Add synthetic data for a single step
 633     double testValue = 10.0;
 634     for (int frame = 0; frame < parameters.numFrames; frame++)
 635     {
 636         setStepData(&testValue);
 637         energyOutput->addDataAtEnergyStep(
 638                 false, true, time_, tmass_, enerdata_.get(), nullptr, nullptr, box_,
 639                 PTCouplingArrays({ state_.boxv, state_.nosehoover_xi, state_.nosehoover_vxi,
 640                                    state_.nhpres_xi, state_.nhpres_vxi }),
 641                 state_.fep_state, constraintsVirial_, forceVirial_, totalVirial_, pressure_,
 642                 &ekindata_, muTotal_, constraints_.get());
 643
 644         energyOutput->printAnnealingTemperatures(log_, &mtop_.groups, &inputrec_.opts);
 645         energyOutput->printStepToEnergyFile(energyFile_, true, false, false, log_, 100 * frame,
 646                                             time_, nullptr, nullptr);
 647         time_ += 1.0;
 648     }
 649
 650     energyOutput->printAnnealingTemperatures(log_, &mtop_.groups, &inputrec_.opts);
 651     energyOutput->printAverages(log_, &mtop_.groups);
 652
 653     // We need to close the file before the contents are available.
 654     logFileGuard_.reset(nullptr);
 655
 656     done_ener_file(energyFile_);
 657
 658     // Set tolerance
 659     checker_.setDefaultTolerance(relativeToleranceAsFloatingPoint(testValue, 1.0e-5));
 660
 661     if (parameters.numFrames > 0)
 662     {
 663         // Test binary output
 664         checkEdrFile(edrFilename_.c_str(), parameters.numFrames);
 665     }
 666
 667     // Test printed values
 668     checker_.checkInteger(energyOutput->numEnergyTerms(), "Number of Energy Terms");
 669     checker_.checkString(TextReader::readFileToString(logFilename_), "log");
 670 }
 671
 672 INSTANTIATE_TEST_CASE_P(WithParameters, EnergyOutputTest, ::testing::ValuesIn(parametersSets));
 673
 674 } // namespace
 675 } // namespace test
 676 } // namespace gmx