src/gromacs/mdtypes/state.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 /* This file is completely threadsafe - keep it that way! */
  39 #include "gmxpre.h"
  40
  41 #include "state.h"
  42
  43 #include <cstring>
  44
  45 #include <algorithm>
  46
  47 #include "gromacs/math/paddedvector.h"
  48 #include "gromacs/math/vec.h"
  49 #include "gromacs/math/veccompare.h"
  50 #include "gromacs/mdtypes/awh_history.h"
  51 #include "gromacs/mdtypes/df_history.h"
  52 #include "gromacs/mdtypes/inputrec.h"
  53 #include "gromacs/mdtypes/md_enums.h"
  54 #include "gromacs/mdtypes/pull_params.h"
  55 #include "gromacs/mdtypes/swaphistory.h"
  56 #include "gromacs/pbcutil/boxutilities.h"
  57 #include "gromacs/pbcutil/pbc.h"
  58 #include "gromacs/utility/compare.h"
  59 #include "gromacs/utility/gmxassert.h"
  60 #include "gromacs/utility/smalloc.h"
  61 #include "gromacs/utility/stringutil.h"
  62
  63 #include "checkpointdata.h"
  64
  65 /* The source code in this file should be thread-safe.
  66       Please keep it that way. */
  67
  68 history_t::history_t() :
  69     disre_initf(0),
  70     ndisrepairs(0),
  71     disre_rm3tav(nullptr),
  72     orire_initf(0),
  73     norire_Dtav(0),
  74     orire_Dtav(nullptr)
  75 {
  76 }
  77
  78 ekinstate_t::ekinstate_t() :
  79     bUpToDate(FALSE),
  80     ekin_n(0),
  81     ekinh(nullptr),
  82     ekinf(nullptr),
  83     ekinh_old(nullptr),
  84     ekin_total(),
  85
  86     dekindl(0),
  87     mvcos(0)
  88 {
  89     clear_mat(ekin_total);
  90 }
  91
  92 namespace
  93 {
  94 /*!
  95  * \brief Enum describing the contents ekinstate_t writes to modular checkpoint
  96  *
  97  * When changing the checkpoint content, add a new element just above Count, and adjust the
  98  * checkpoint functionality.
  99  */
 100 enum class CheckpointVersion
 101 {
 102     Base, //!< First version of modular checkpointing
 103     Count //!< Number of entries. Add new versions right above this!
 104 };
 105 constexpr auto c_currentVersion = CheckpointVersion(int(CheckpointVersion::Count) - 1);
 106 } // namespace
 107
 108 template<gmx::CheckpointDataOperation operation>
 109 void ekinstate_t::doCheckpoint(gmx::CheckpointData<operation> checkpointData)
 110 {
 111     gmx::checkpointVersion(&checkpointData, "ekinstate_t version", c_currentVersion);
 112
 113     checkpointData.scalar("bUpToDate", &bUpToDate);
 114     if (!bUpToDate)
 115     {
 116         return;
 117     }
 118     auto numOfTensors = ekin_n;
 119     checkpointData.scalar("ekin_n", &numOfTensors);
 120     if (operation == gmx::CheckpointDataOperation::Read)
 121     {
 122         // If this isn't matching, we haven't allocated the right amount of data
 123         GMX_RELEASE_ASSERT(numOfTensors == ekin_n,
 124                            "ekinstate_t checkpoint reading: Tensor size mismatch.");
 125     }
 126     for (int idx = 0; idx < numOfTensors; ++idx)
 127     {
 128         checkpointData.tensor(gmx::formatString("ekinh %d", idx), ekinh[idx]);
 129         checkpointData.tensor(gmx::formatString("ekinf %d", idx), ekinf[idx]);
 130         checkpointData.tensor(gmx::formatString("ekinh_old %d", idx), ekinh_old[idx]);
 131     }
 132     checkpointData.arrayRef("ekinscalef_nhc", gmx::makeCheckpointArrayRef<operation>(ekinscalef_nhc));
 133     checkpointData.arrayRef("ekinscaleh_nhc", gmx::makeCheckpointArrayRef<operation>(ekinscaleh_nhc));
 134     checkpointData.arrayRef("vscale_nhc", gmx::makeCheckpointArrayRef<operation>(vscale_nhc));
 135     checkpointData.scalar("dekindl", &dekindl);
 136     checkpointData.scalar("mvcos", &mvcos);
 137
 138     if (operation == gmx::CheckpointDataOperation::Read)
 139     {
 140         hasReadEkinState = true;
 141     }
 142 }
 143
 144 // Explicit template instantiation
 145 template void ekinstate_t::doCheckpoint(gmx::CheckpointData<gmx::CheckpointDataOperation::Read> checkpointData);
 146 template void ekinstate_t::doCheckpoint(gmx::CheckpointData<gmx::CheckpointDataOperation::Write> checkpointData);
 147
 148 void init_gtc_state(t_state* state, int ngtc, int nnhpres, int nhchainlength)
 149 {
 150     state->ngtc          = ngtc;
 151     state->nnhpres       = nnhpres;
 152     state->nhchainlength = nhchainlength;
 153     state->nosehoover_xi.resize(state->nhchainlength * state->ngtc, 0);
 154     state->nosehoover_vxi.resize(state->nhchainlength * state->ngtc, 0);
 155     state->therm_integral.resize(state->ngtc, 0);
 156     state->baros_integral = 0.0;
 157     state->nhpres_xi.resize(state->nhchainlength * nnhpres, 0);
 158     state->nhpres_vxi.resize(state->nhchainlength * nnhpres, 0);
 159 }
 160
 161
 162 /* Checkpoint code relies on this function having no effect if
 163    state->natoms is > 0 and passed as natoms. */
 164 void state_change_natoms(t_state* state, int natoms)
 165 {
 166     state->natoms = natoms;
 167
 168     /* We need padding, since we might use SIMD access, but the
 169      * containers here all ensure that. */
 170     if (state->flags & enumValueToBitMask(StateEntry::X))
 171     {
 172         state->x.resizeWithPadding(natoms);
 173     }
 174     if (state->flags & enumValueToBitMask(StateEntry::V))
 175     {
 176         state->v.resizeWithPadding(natoms);
 177     }
 178     if (state->flags & enumValueToBitMask(StateEntry::Cgp))
 179     {
 180         state->cg_p.resizeWithPadding(natoms);
 181     }
 182 }
 183
 184 void init_dfhist_state(t_state* state, int dfhistNumLambda)
 185 {
 186     if (dfhistNumLambda > 0)
 187     {
 188         snew(state->dfhist, 1);
 189         init_df_history(state->dfhist, dfhistNumLambda);
 190     }
 191     else
 192     {
 193         state->dfhist = nullptr;
 194     }
 195 }
 196
 197 void comp_state(const t_state* st1, const t_state* st2, gmx_bool bRMSD, real ftol, real abstol)
 198 {
 199     int i, j, nc;
 200
 201     fprintf(stdout, "comparing flags\n");
 202     cmp_int(stdout, "flags", -1, st1->flags, st2->flags);
 203     fprintf(stdout, "comparing box\n");
 204     cmp_rvecs(stdout, "box", DIM, st1->box, st2->box, FALSE, ftol, abstol);
 205     fprintf(stdout, "comparing box_rel\n");
 206     cmp_rvecs(stdout, "box_rel", DIM, st1->box_rel, st2->box_rel, FALSE, ftol, abstol);
 207     fprintf(stdout, "comparing boxv\n");
 208     cmp_rvecs(stdout, "boxv", DIM, st1->boxv, st2->boxv, FALSE, ftol, abstol);
 209     if (st1->flags & enumValueToBitMask(StateEntry::SVirPrev))
 210     {
 211         fprintf(stdout, "comparing shake vir_prev\n");
 212         cmp_rvecs(stdout, "svir_prev", DIM, st1->svir_prev, st2->svir_prev, FALSE, ftol, abstol);
 213     }
 214     if (st1->flags & enumValueToBitMask(StateEntry::FVirPrev))
 215     {
 216         fprintf(stdout, "comparing force vir_prev\n");
 217         cmp_rvecs(stdout, "fvir_prev", DIM, st1->fvir_prev, st2->fvir_prev, FALSE, ftol, abstol);
 218     }
 219     if (st1->flags & enumValueToBitMask(StateEntry::PressurePrevious))
 220     {
 221         fprintf(stdout, "comparing prev_pres\n");
 222         cmp_rvecs(stdout, "pres_prev", DIM, st1->pres_prev, st2->pres_prev, FALSE, ftol, abstol);
 223     }
 224     cmp_int(stdout, "ngtc", -1, st1->ngtc, st2->ngtc);
 225     cmp_int(stdout, "nhchainlength", -1, st1->nhchainlength, st2->nhchainlength);
 226     if (st1->ngtc == st2->ngtc && st1->nhchainlength == st2->nhchainlength)
 227     {
 228         for (i = 0; i < st1->ngtc; i++)
 229         {
 230             nc = i * st1->nhchainlength;
 231             for (j = 0; j < nc; j++)
 232             {
 233                 cmp_real(stdout, "nosehoover_xi", i, st1->nosehoover_xi[nc + j], st2->nosehoover_xi[nc + j], ftol, abstol);
 234             }
 235         }
 236     }
 237     cmp_int(stdout, "nnhpres", -1, st1->nnhpres, st2->nnhpres);
 238     if (st1->nnhpres == st2->nnhpres && st1->nhchainlength == st2->nhchainlength)
 239     {
 240         for (i = 0; i < st1->nnhpres; i++)
 241         {
 242             nc = i * st1->nhchainlength;
 243             for (j = 0; j < nc; j++)
 244             {
 245                 cmp_real(stdout, "nosehoover_xi", i, st1->nhpres_xi[nc + j], st2->nhpres_xi[nc + j], ftol, abstol);
 246             }
 247         }
 248     }
 249
 250     cmp_int(stdout, "natoms", -1, st1->natoms, st2->natoms);
 251     if (st1->natoms == st2->natoms)
 252     {
 253         if ((st1->flags & enumValueToBitMask(StateEntry::X))
 254             && (st2->flags & enumValueToBitMask(StateEntry::X)))
 255         {
 256             fprintf(stdout, "comparing x\n");
 257             cmp_rvecs(stdout, "x", st1->natoms, st1->x.rvec_array(), st2->x.rvec_array(), bRMSD, ftol, abstol);
 258         }
 259         if ((st1->flags & enumValueToBitMask(StateEntry::V))
 260             && (st2->flags & enumValueToBitMask(StateEntry::V)))
 261         {
 262             fprintf(stdout, "comparing v\n");
 263             cmp_rvecs(stdout, "v", st1->natoms, st1->v.rvec_array(), st2->v.rvec_array(), bRMSD, ftol, abstol);
 264         }
 265     }
 266 }
 267
 268 rvec* makeRvecArray(gmx::ArrayRef<const gmx::RVec> v, gmx::index n)
 269 {
 270     GMX_ASSERT(v.ssize() >= n, "We can't copy more elements than the vector size");
 271
 272     rvec* dest;
 273
 274     snew(dest, n);
 275
 276     const rvec* vPtr = as_rvec_array(v.data());
 277     for (gmx::index i = 0; i < n; i++)
 278     {
 279         copy_rvec(vPtr[i], dest[i]);
 280     }
 281
 282     return dest;
 283 }
 284
 285 t_state::t_state() :
 286     natoms(0),
 287     ngtc(0),
 288     nnhpres(0),
 289     nhchainlength(0),
 290     flags(0),
 291     fep_state(0),
 292     lambda(),
 293
 294     baros_integral(0),
 295     veta(0),
 296     vol0(0),
 297
 298     ekinstate(),
 299     hist(),
 300     dfhist(nullptr),
 301     awhHistory(nullptr),
 302     ddp_count(0),
 303     ddp_count_cg_gl(0)
 304
 305 {
 306     // It would be nicer to initialize these with {} or {{0}} in the
 307     // above initialization list, but uncrustify doesn't understand
 308     // that.
 309     // TODO Fix this if we switch to clang-format some time.
 310     lambda = { { 0 } };
 311     clear_mat(box);
 312     clear_mat(box_rel);
 313     clear_mat(boxv);
 314     clear_mat(pres_prev);
 315     clear_mat(svir_prev);
 316     clear_mat(fvir_prev);
 317 }
 318
 319 void set_box_rel(const t_inputrec* ir, t_state* state)
 320 {
 321     /* Make sure the box obeys the restrictions before we fix the ratios */
 322     correct_box(nullptr, 0, state->box);
 323
 324     clear_mat(state->box_rel);
 325
 326     if (inputrecPreserveShape(ir))
 327     {
 328         const int ndim = ir->epct == PressureCouplingType::SemiIsotropic ? 2 : 3;
 329         do_box_rel(ndim, ir->deform, state->box_rel, state->box, true);
 330     }
 331 }
 332
 333 void preserve_box_shape(const t_inputrec* ir, matrix box_rel, matrix box)
 334 {
 335     if (inputrecPreserveShape(ir))
 336     {
 337         const int ndim = ir->epct == PressureCouplingType::SemiIsotropic ? 2 : 3;
 338         do_box_rel(ndim, ir->deform, box_rel, box, false);
 339     }
 340 }
 341
 342 void printLambdaStateToLog(FILE* fplog, gmx::ArrayRef<const real> lambda, const bool isInitialOutput)
 343 {
 344     if (fplog != nullptr)
 345     {
 346         fprintf(fplog, "%s vector of lambda components:[ ", isInitialOutput ? "Initial" : "Current");
 347         for (const auto& l : lambda)
 348         {
 349             fprintf(fplog, "%10.4f ", l);
 350         }
 351         fprintf(fplog, "]\n%s", isInitialOutput ? "" : "\n");
 352     }
 353 }
 354
 355 void initialize_lambdas(FILE* fplog, const t_inputrec& ir, bool isMaster, int* fep_state, gmx::ArrayRef<real> lambda)
 356 {
 357     /* TODO: Clean up initialization of fep_state and lambda in
 358        t_state.  This function works, but could probably use a logic
 359        rewrite to keep all the different types of efep straight. */
 360
 361     if ((ir.efep == FreeEnergyPerturbationType::No) && (!ir.bSimTemp))
 362     {
 363         return;
 364     }
 365
 366     const t_lambda* fep = ir.fepvals.get();
 367     if (isMaster)
 368     {
 369         *fep_state = fep->init_fep_state; /* this might overwrite the checkpoint
 370                                              if checkpoint is set -- a kludge is in for now
 371                                              to prevent this.*/
 372     }
 373
 374     for (int i = 0; i < static_cast<int>(FreeEnergyPerturbationCouplingType::Count); i++)
 375     {
 376         double thisLambda;
 377         /* overwrite lambda state with init_lambda for now for backwards compatibility */
 378         if (fep->init_lambda >= 0) /* if it's -1, it was never initialized */
 379         {
 380             thisLambda = fep->init_lambda;
 381         }
 382         else
 383         {
 384             thisLambda = fep->all_lambda[i][fep->init_fep_state];
 385         }
 386         if (isMaster)
 387         {
 388             lambda[i] = thisLambda;
 389         }
 390     }
 391     if (ir.bSimTemp)
 392     {
 393         /* need to rescale control temperatures to match current state */
 394         for (int i = 0; i < ir.opts.ngtc; i++)
 395         {
 396             if (ir.opts.ref_t[i] > 0)
 397             {
 398                 ir.opts.ref_t[i] = ir.simtempvals->temperatures[fep->init_fep_state];
 399             }
 400         }
 401     }
 402
 403     /* Send to the log the information on the current lambdas */
 404     const bool isInitialOutput = true;
 405     printLambdaStateToLog(fplog, lambda, isInitialOutput);
 406 }