2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2010, The GROMACS development team.
6 * Copyright (c) 2012,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.
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.
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.
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.
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.
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.
40 #include "gromacs/utility/enumerationhelpers.h"
51 #include "gromacs/applied_forces/awh/read_params.h"
52 #include "gromacs/math/veccompare.h"
53 #include "gromacs/math/vecdump.h"
54 #include "gromacs/mdlib/vcm.h"
55 #include "gromacs/mdtypes/awh_params.h"
56 #include "gromacs/mdtypes/md_enums.h"
57 #include "gromacs/mdtypes/multipletimestepping.h"
58 #include "gromacs/mdtypes/pull_params.h"
59 #include "gromacs/pbcutil/pbc.h"
60 #include "gromacs/utility/compare.h"
61 #include "gromacs/utility/cstringutil.h"
62 #include "gromacs/utility/fatalerror.h"
63 #include "gromacs/utility/keyvaluetree.h"
64 #include "gromacs/utility/smalloc.h"
65 #include "gromacs/utility/snprintf.h"
66 #include "gromacs/utility/strconvert.h"
67 #include "gromacs/utility/stringutil.h"
68 #include "gromacs/utility/textwriter.h"
69 #include "gromacs/utility/txtdump.h"
71 //! Macro to select a bool name
72 #define EBOOL(e) gmx::boolToString(e)
74 /* Default values for nstcalcenergy, used when the are no other restrictions. */
75 constexpr int c_defaultNstCalcEnergy = 10;
77 /* The minimum number of integration steps required for reasonably accurate
78 * integration of first and second order coupling algorithms.
80 const int nstmin_berendsen_tcouple = 5;
81 const int nstmin_berendsen_pcouple = 10;
82 const int nstmin_harmonic = 20;
84 /* Default values for T- and P- coupling intervals, used when the are no other
87 constexpr int c_defaultNstTCouple = 10;
88 constexpr int c_defaultNstPCouple = 10;
90 t_inputrec::t_inputrec()
92 // TODO When this memset is removed, remove the suppression of
93 // gcc -Wno-class-memaccess in a CMakeLists.txt file.
94 std::memset(this, 0, sizeof(*this)); // NOLINT(bugprone-undefined-memory-manipulation)
95 fepvals = std::make_unique<t_lambda>();
96 expandedvals = std::make_unique<t_expanded>();
97 simtempvals = std::make_unique<t_simtemp>();
100 t_inputrec::~t_inputrec()
105 int ir_optimal_nstcalcenergy(const t_inputrec* ir)
115 nst = c_defaultNstCalcEnergy;
120 nst = std::lcm(nst, ir->mtsLevels.back().stepFactor);
126 int tcouple_min_integration_steps(TemperatureCoupling etc)
132 case TemperatureCoupling::No: n = 0; break;
133 case TemperatureCoupling::Berendsen:
134 case TemperatureCoupling::Yes: n = nstmin_berendsen_tcouple; break;
135 case TemperatureCoupling::VRescale:
136 /* V-rescale supports instantaneous rescaling */
139 case TemperatureCoupling::NoseHoover: n = nstmin_harmonic; break;
140 case TemperatureCoupling::Andersen:
141 case TemperatureCoupling::AndersenMassive: n = 1; break;
142 default: gmx_incons("Unknown etc value");
148 int ir_optimal_nsttcouple(const t_inputrec* ir)
150 int nmin, nwanted, n;
154 nmin = tcouple_min_integration_steps(ir->etc);
156 nwanted = c_defaultNstTCouple;
159 if (ir->etc != TemperatureCoupling::No)
161 for (g = 0; g < ir->opts.ngtc; g++)
163 if (ir->opts.tau_t[g] > 0)
165 tau_min = std::min(tau_min, ir->opts.tau_t[g]);
170 if (nmin == 0 || ir->delta_t * nwanted <= tau_min)
176 n = static_cast<int>(tau_min / (ir->delta_t * nmin) + 0.001);
181 while (nwanted % n != 0)
190 int pcouple_min_integration_steps(PressureCoupling epc)
196 case PressureCoupling::No: n = 0; break;
197 case PressureCoupling::Berendsen:
198 case PressureCoupling::CRescale:
199 case PressureCoupling::Isotropic: n = nstmin_berendsen_pcouple; break;
200 case PressureCoupling::ParrinelloRahman:
201 case PressureCoupling::Mttk: n = nstmin_harmonic; break;
202 default: gmx_incons("Unknown epc value");
208 int ir_optimal_nstpcouple(const t_inputrec* ir)
210 const int minIntegrationSteps = pcouple_min_integration_steps(ir->epc);
212 const int nwanted = c_defaultNstPCouple;
214 // With multiple time-stepping we can only compute the pressure at slowest steps
215 const int minNstPCouple = (ir->useMts ? ir->mtsLevels.back().stepFactor : 1);
218 if (minIntegrationSteps == 0 || ir->delta_t * nwanted <= ir->tau_p)
224 n = static_cast<int>(ir->tau_p / (ir->delta_t * minIntegrationSteps) + 0.001);
225 if (n < minNstPCouple)
229 // Without MTS we try to make nstpcouple a "nice" number
232 while (nwanted % n != 0)
239 // With MTS, nstpcouple should be a multiple of the slowest MTS interval
242 n = n - (n % minNstPCouple);
248 gmx_bool ir_coulomb_switched(const t_inputrec* ir)
250 return (ir->coulombtype == CoulombInteractionType::Switch
251 || ir->coulombtype == CoulombInteractionType::Shift
252 || ir->coulombtype == CoulombInteractionType::PmeSwitch
253 || ir->coulombtype == CoulombInteractionType::PmeUserSwitch
254 || ir->coulomb_modifier == InteractionModifiers::PotSwitch
255 || ir->coulomb_modifier == InteractionModifiers::ForceSwitch);
258 gmx_bool ir_coulomb_is_zero_at_cutoff(const t_inputrec* ir)
260 return (ir->cutoff_scheme == CutoffScheme::Verlet || ir_coulomb_switched(ir)
261 || ir->coulomb_modifier != InteractionModifiers::None
262 || ir->coulombtype == CoulombInteractionType::RFZero);
265 gmx_bool ir_coulomb_might_be_zero_at_cutoff(const t_inputrec* ir)
267 return (ir_coulomb_is_zero_at_cutoff(ir) || ir->coulombtype == CoulombInteractionType::User
268 || ir->coulombtype == CoulombInteractionType::PmeUser);
271 gmx_bool ir_vdw_switched(const t_inputrec* ir)
273 return (ir->vdwtype == VanDerWaalsType::Switch || ir->vdwtype == VanDerWaalsType::Shift
274 || ir->vdw_modifier == InteractionModifiers::PotSwitch
275 || ir->vdw_modifier == InteractionModifiers::ForceSwitch);
278 gmx_bool ir_vdw_is_zero_at_cutoff(const t_inputrec* ir)
280 return (ir->cutoff_scheme == CutoffScheme::Verlet || ir_vdw_switched(ir)
281 || ir->vdw_modifier != InteractionModifiers::None);
284 gmx_bool ir_vdw_might_be_zero_at_cutoff(const t_inputrec* ir)
286 return (ir_vdw_is_zero_at_cutoff(ir) || ir->vdwtype == VanDerWaalsType::User);
289 static void done_t_rot(t_rot* rot)
295 if (rot->grp != nullptr)
297 for (int i = 0; i < rot->ngrp; i++)
299 sfree(rot->grp[i].ind);
300 sfree(rot->grp[i].x_ref);
307 static void done_t_swapCoords(t_swapcoords* swapCoords)
309 if (swapCoords == nullptr)
313 for (int i = 0; i < swapCoords->ngrp; i++)
315 sfree(swapCoords->grp[i].ind);
316 sfree(swapCoords->grp[i].molname);
318 sfree(swapCoords->grp);
322 void done_inputrec(t_inputrec* ir)
324 sfree(ir->opts.nrdf);
325 sfree(ir->opts.ref_t);
326 for (int i = 0; i < ir->opts.ngtc; i++)
328 sfree(ir->opts.anneal_time[i]);
329 sfree(ir->opts.anneal_temp[i]);
331 sfree(ir->opts.annealing);
332 sfree(ir->opts.anneal_npoints);
333 sfree(ir->opts.anneal_time);
334 sfree(ir->opts.anneal_temp);
335 sfree(ir->opts.tau_t);
336 sfree(ir->opts.nFreeze);
337 sfree(ir->opts.egp_flags);
339 done_t_swapCoords(ir->swap);
344 static void pr_grp_opts(FILE* out, int indent, const char* title, const t_grpopts* opts, gmx_bool bMDPformat)
350 fprintf(out, "%s:\n", title);
353 pr_indent(out, indent);
354 fprintf(out, "nrdf%s", bMDPformat ? " = " : ":");
355 for (i = 0; (i < opts->ngtc); i++)
357 fprintf(out, " %10g", opts->nrdf[i]);
361 pr_indent(out, indent);
362 fprintf(out, "ref-t%s", bMDPformat ? " = " : ":");
363 for (i = 0; (i < opts->ngtc); i++)
365 fprintf(out, " %10g", opts->ref_t[i]);
369 pr_indent(out, indent);
370 fprintf(out, "tau-t%s", bMDPformat ? " = " : ":");
371 for (i = 0; (i < opts->ngtc); i++)
373 fprintf(out, " %10g", opts->tau_t[i]);
377 /* Pretty-print the simulated annealing info */
378 fprintf(out, "annealing%s", bMDPformat ? " = " : ":");
379 for (i = 0; (i < opts->ngtc); i++)
381 fprintf(out, " %10s", enumValueToString(opts->annealing[i]));
385 fprintf(out, "annealing-npoints%s", bMDPformat ? " = " : ":");
386 for (i = 0; (i < opts->ngtc); i++)
388 fprintf(out, " %10d", opts->anneal_npoints[i]);
392 for (i = 0; (i < opts->ngtc); i++)
394 if (opts->anneal_npoints[i] > 0)
396 fprintf(out, "annealing-time [%d]:\t", i);
397 for (j = 0; (j < opts->anneal_npoints[i]); j++)
399 fprintf(out, " %10.1f", opts->anneal_time[i][j]);
402 fprintf(out, "annealing-temp [%d]:\t", i);
403 for (j = 0; (j < opts->anneal_npoints[i]); j++)
405 fprintf(out, " %10.1f", opts->anneal_temp[i][j]);
411 pr_indent(out, indent);
412 fprintf(out, "nfreeze:");
413 for (i = 0; (i < opts->ngfrz); i++)
415 for (m = 0; (m < DIM); m++)
417 fprintf(out, " %10s", opts->nFreeze[i][m] ? "Y" : "N");
423 for (i = 0; (i < opts->ngener); i++)
425 pr_indent(out, indent);
426 fprintf(out, "energygrp-flags[%3d]:", i);
427 for (m = 0; (m < opts->ngener); m++)
429 fprintf(out, " %d", opts->egp_flags[opts->ngener * i + m]);
437 static void pr_matrix(FILE* fp, int indent, const char* title, const rvec* m, gmx_bool bMDPformat)
442 "%-10s = %g %g %g %g %g %g\n",
453 pr_rvecs(fp, indent, title, m, DIM);
457 #define PS(t, s) pr_str(fp, indent, t, s)
458 #define PI(t, s) pr_int(fp, indent, t, s)
459 #define PSTEP(t, s) pr_int64(fp, indent, t, s)
460 #define PR(t, s) pr_real(fp, indent, t, s)
461 #define PD(t, s) pr_double(fp, indent, t, s)
463 static void pr_pull_group(FILE* fp, int indent, int g, const t_pull_group* pgrp)
465 pr_indent(fp, indent);
466 fprintf(fp, "pull-group %d:\n", g);
468 pr_ivec_block(fp, indent, "atom", pgrp->ind.data(), pgrp->ind.size(), TRUE);
469 pr_rvec(fp, indent, "weight", pgrp->weight.data(), pgrp->weight.size(), TRUE);
470 PI("pbcatom", pgrp->pbcatom);
473 static void pr_pull_coord(FILE* fp, int indent, int c, const t_pull_coord* pcrd)
475 pr_indent(fp, indent);
476 fprintf(fp, "pull-coord %d:\n", c);
477 PS("type", enumValueToString(pcrd->eType));
478 if (pcrd->eType == PullingAlgorithm::External)
480 PS("potential-provider", pcrd->externalPotentialProvider.c_str());
482 PS("geometry", enumValueToString(pcrd->eGeom));
483 for (int g = 0; g < pcrd->ngroup; g++)
485 std::string buffer = gmx::formatString("group[%d]", g);
486 PI(buffer.c_str(), pcrd->group[g]);
488 pr_ivec(fp, indent, "dim", pcrd->dim, DIM, TRUE);
489 pr_rvec(fp, indent, "origin", pcrd->origin, DIM, TRUE);
490 pr_rvec(fp, indent, "vec", pcrd->vec, DIM, TRUE);
491 PS("start", EBOOL(pcrd->bStart));
492 PR("init", pcrd->init);
493 PR("rate", pcrd->rate);
498 static void pr_simtempvals(FILE* fp, int indent, const t_simtemp* simtemp, int n_lambda)
500 PS("simulated-tempering-scaling", enumValueToString(simtemp->eSimTempScale));
501 PR("sim-temp-low", simtemp->simtemp_low);
502 PR("sim-temp-high", simtemp->simtemp_high);
503 pr_rvec(fp, indent, "simulated tempering temperatures", simtemp->temperatures.data(), n_lambda, TRUE);
506 static void pr_expandedvals(FILE* fp, int indent, const t_expanded* expand, int n_lambda)
509 PI("nstexpanded", expand->nstexpanded);
510 PS("lmc-stats", enumValueToString(expand->elamstats));
511 PS("lmc-move", enumValueToString(expand->elmcmove));
512 PS("lmc-weights-equil", enumValueToString(expand->elmceq));
513 if (expand->elmceq == LambdaWeightWillReachEquilibrium::NumAtLambda)
515 PI("weight-equil-number-all-lambda", expand->equil_n_at_lam);
517 if (expand->elmceq == LambdaWeightWillReachEquilibrium::Samples)
519 PI("weight-equil-number-samples", expand->equil_samples);
521 if (expand->elmceq == LambdaWeightWillReachEquilibrium::Steps)
523 PI("weight-equil-number-steps", expand->equil_steps);
525 if (expand->elmceq == LambdaWeightWillReachEquilibrium::WLDelta)
527 PR("weight-equil-wl-delta", expand->equil_wl_delta);
529 if (expand->elmceq == LambdaWeightWillReachEquilibrium::Ratio)
531 PR("weight-equil-count-ratio", expand->equil_ratio);
533 PI("lmc-seed", expand->lmc_seed);
534 PR("mc-temperature", expand->mc_temp);
535 PI("lmc-repeats", expand->lmc_repeats);
536 PI("lmc-gibbsdelta", expand->gibbsdeltalam);
537 PI("lmc-forced-nstart", expand->lmc_forced_nstart);
538 PS("symmetrized-transition-matrix", EBOOL(expand->bSymmetrizedTMatrix));
539 PI("nst-transition-matrix", expand->nstTij);
540 PI("mininum-var-min", expand->minvarmin); /*default is reasonable */
541 PI("weight-c-range", expand->c_range); /* default is just C=0 */
542 PR("wl-scale", expand->wl_scale);
543 PR("wl-ratio", expand->wl_ratio);
544 PR("init-wl-delta", expand->init_wl_delta);
545 PS("wl-oneovert", EBOOL(expand->bWLoneovert));
547 pr_indent(fp, indent);
548 pr_rvec(fp, indent, "init-lambda-weights", expand->init_lambda_weights.data(), n_lambda, TRUE);
549 PS("init-weights", EBOOL(expand->bInit_weights));
552 static void pr_fepvals(FILE* fp, int indent, const t_lambda* fep, gmx_bool bMDPformat)
556 PR("init-lambda", fep->init_lambda);
557 PI("init-lambda-state", fep->init_fep_state);
558 PR("delta-lambda", fep->delta_lambda);
559 PI("nstdhdl", fep->nstdhdl);
563 PI("n-lambdas", fep->n_lambda);
565 if (fep->n_lambda > 0)
567 pr_indent(fp, indent);
568 fprintf(fp, "separate-dvdl%s\n", bMDPformat ? " = " : ":");
569 for (auto i : gmx::EnumerationArray<FreeEnergyPerturbationCouplingType, bool>::keys())
571 fprintf(fp, "%18s = ", enumValueToString(i));
572 if (fep->separate_dvdl[i])
574 fprintf(fp, " TRUE");
578 fprintf(fp, " FALSE");
582 fprintf(fp, "all-lambdas%s\n", bMDPformat ? " = " : ":");
583 for (auto key : gmx::EnumerationArray<FreeEnergyPerturbationCouplingType, bool>::keys())
585 fprintf(fp, "%18s = ", enumValueToString(key));
586 int i = static_cast<int>(key);
587 for (j = 0; j < fep->n_lambda; j++)
589 fprintf(fp, " %10g", fep->all_lambda[i][j]);
594 PI("calc-lambda-neighbors", fep->lambda_neighbors);
595 PS("dhdl-print-energy", enumValueToString(fep->edHdLPrintEnergy));
596 PR("sc-alpha", fep->sc_alpha);
597 PI("sc-power", fep->sc_power);
598 PR("sc-r-power", fep->sc_r_power);
599 PR("sc-sigma", fep->sc_sigma);
600 PR("sc-sigma-min", fep->sc_sigma_min);
601 PS("sc-coul", EBOOL(fep->bScCoul));
602 PI("dh-hist-size", fep->dh_hist_size);
603 PD("dh-hist-spacing", fep->dh_hist_spacing);
604 PS("separate-dhdl-file", enumValueToString(fep->separate_dhdl_file));
605 PS("dhdl-derivatives", enumValueToString(fep->dhdl_derivatives));
608 static void pr_pull(FILE* fp, int indent, const pull_params_t& pull)
612 PR("pull-cylinder-r", pull.cylinder_r);
613 PR("pull-constr-tol", pull.constr_tol);
614 PS("pull-print-COM", EBOOL(pull.bPrintCOM));
615 PS("pull-print-ref-value", EBOOL(pull.bPrintRefValue));
616 PS("pull-print-components", EBOOL(pull.bPrintComp));
617 PI("pull-nstxout", pull.nstxout);
618 PI("pull-nstfout", pull.nstfout);
619 PS("pull-pbc-ref-prev-step-com", EBOOL(pull.bSetPbcRefToPrevStepCOM));
620 PS("pull-xout-average", EBOOL(pull.bXOutAverage));
621 PS("pull-fout-average", EBOOL(pull.bFOutAverage));
622 PI("pull-ngroups", pull.ngroup);
623 for (g = 0; g < pull.ngroup; g++)
625 pr_pull_group(fp, indent, g, &pull.group[g]);
627 PI("pull-ncoords", pull.ncoord);
628 for (g = 0; g < pull.ncoord; g++)
630 pr_pull_coord(fp, indent, g, &pull.coord[g]);
634 static void pr_awh_bias_dim(FILE* fp, int indent, const gmx::AwhDimParams& awhDimParams, const char* prefix)
636 pr_indent(fp, indent);
638 fprintf(fp, "%s:\n", prefix);
639 PS("coord-provider", enumValueToString(awhDimParams.coordinateProvider()));
640 PI("coord-index", awhDimParams.coordinateIndex() + 1);
641 PR("start", awhDimParams.origin());
642 PR("end", awhDimParams.end());
643 PR("period", awhDimParams.period());
644 PR("force-constant", awhDimParams.forceConstant());
645 PR("diffusion", awhDimParams.diffusion());
646 PR("cover-diameter", awhDimParams.coverDiameter());
649 static void pr_awh_bias(FILE* fp, int indent, const gmx::AwhBiasParams& awhBiasParams, const char* prefix)
653 sprintf(opt, "%s-error-init", prefix);
654 PR(opt, awhBiasParams.initialErrorEstimate());
655 sprintf(opt, "%s-growth", prefix);
656 PS(opt, enumValueToString(awhBiasParams.growthType()));
657 sprintf(opt, "%s-target", prefix);
658 PS(opt, enumValueToString(awhBiasParams.targetDistribution()));
659 sprintf(opt, "%s-target-beta-scalng", prefix);
660 PR(opt, awhBiasParams.targetBetaScaling());
661 sprintf(opt, "%s-target-cutoff", prefix);
662 PR(opt, awhBiasParams.targetCutoff());
663 sprintf(opt, "%s-user-data", prefix);
664 PS(opt, EBOOL(awhBiasParams.userPMFEstimate()));
665 sprintf(opt, "%s-share-group", prefix);
666 PI(opt, awhBiasParams.shareGroup());
667 sprintf(opt, "%s-equilibrate-histogram", prefix);
668 PS(opt, EBOOL(awhBiasParams.equilibrateHistogram()));
669 sprintf(opt, "%s-ndim", prefix);
670 PI(opt, awhBiasParams.ndim());
673 for (const auto& dimParam : awhBiasParams.dimParams())
675 char prefixdim[STRLEN];
676 sprintf(prefixdim, "%s-dim%d", prefix, d + 1);
677 pr_awh_bias_dim(fp, indent, dimParam, prefixdim);
682 static void pr_awh(FILE* fp, int indent, gmx::AwhParams* awhParams)
684 PS("awh-potential", enumValueToString(awhParams->potential()));
685 PI("awh-seed", awhParams->seed());
686 PI("awh-nstout", awhParams->nstout());
687 PI("awh-nstsample", awhParams->nstSampleCoord());
688 PI("awh-nsamples-update", awhParams->numSamplesUpdateFreeEnergy());
689 PS("awh-share-bias-multisim", EBOOL(awhParams->shareBiasMultisim()));
690 PI("awh-nbias", awhParams->numBias());
693 for (const auto& awhBiasParam : awhParams->awhBiasParams())
695 auto prefix = gmx::formatString("awh%d", k + 1);
696 pr_awh_bias(fp, indent, awhBiasParam, prefix.c_str());
701 static void pr_rotgrp(FILE* fp, int indent, int g, const t_rotgrp* rotg)
703 pr_indent(fp, indent);
704 fprintf(fp, "rot-group %d:\n", g);
706 PS("rot-type", enumValueToString(rotg->eType));
707 PS("rot-massw", EBOOL(rotg->bMassW));
708 pr_ivec_block(fp, indent, "atom", rotg->ind, rotg->nat, TRUE);
709 pr_rvecs(fp, indent, "x-ref", rotg->x_ref, rotg->nat);
710 pr_rvec(fp, indent, "rot-vec", rotg->inputVec, DIM, TRUE);
711 pr_rvec(fp, indent, "rot-pivot", rotg->pivot, DIM, TRUE);
712 PR("rot-rate", rotg->rate);
713 PR("rot-k", rotg->k);
714 PR("rot-slab-dist", rotg->slab_dist);
715 PR("rot-min-gauss", rotg->min_gaussian);
716 PR("rot-eps", rotg->eps);
717 PS("rot-fit-method", enumValueToString(rotg->eFittype));
718 PI("rot-potfit-nstep", rotg->PotAngle_nstep);
719 PR("rot-potfit-step", rotg->PotAngle_step);
722 static void pr_rot(FILE* fp, int indent, const t_rot* rot)
726 PI("rot-nstrout", rot->nstrout);
727 PI("rot-nstsout", rot->nstsout);
728 PI("rot-ngroups", rot->ngrp);
729 for (g = 0; g < rot->ngrp; g++)
731 pr_rotgrp(fp, indent, g, &rot->grp[g]);
736 static void pr_swap(FILE* fp, int indent, const t_swapcoords* swap)
740 /* Enums for better readability of the code */
748 PI("swap-frequency", swap->nstswap);
750 /* The split groups that define the compartments */
751 for (int j = 0; j < 2; j++)
753 snprintf(str, STRLEN, "massw_split%d", j);
754 PS(str, EBOOL(swap->massw_split[j]));
755 snprintf(str, STRLEN, "split atoms group %d", j);
756 pr_ivec_block(fp, indent, str, swap->grp[j].ind, swap->grp[j].nat, TRUE);
759 /* The solvent group */
763 swap->grp[static_cast<int>(SwapGroupSplittingType::Solvent)].molname);
767 swap->grp[static_cast<int>(SwapGroupSplittingType::Solvent)].ind,
768 swap->grp[static_cast<int>(SwapGroupSplittingType::Solvent)].nat,
771 /* Now print the indices for all the ion groups: */
772 for (int ig = static_cast<int>(SwapGroupSplittingType::Count); ig < swap->ngrp; ig++)
774 snprintf(str, STRLEN, "ion group %s", swap->grp[ig].molname);
775 pr_ivec_block(fp, indent, str, swap->grp[ig].ind, swap->grp[ig].nat, TRUE);
778 PR("cyl0-r", swap->cyl0r);
779 PR("cyl0-up", swap->cyl0u);
780 PR("cyl0-down", swap->cyl0l);
781 PR("cyl1-r", swap->cyl1r);
782 PR("cyl1-up", swap->cyl1u);
783 PR("cyl1-down", swap->cyl1l);
784 PI("coupl-steps", swap->nAverage);
786 /* Print the requested ion counts for both compartments */
787 for (int ic = eCompA; ic <= eCompB; ic++)
789 for (int ig = static_cast<int>(SwapGroupSplittingType::Count); ig < swap->ngrp; ig++)
791 snprintf(str, STRLEN, "%s-in-%c", swap->grp[ig].molname, 'A' + ic);
792 PI(str, swap->grp[ig].nmolReq[ic]);
796 PR("threshold", swap->threshold);
797 PR("bulk-offsetA", swap->bulkOffset[eCompA]);
798 PR("bulk-offsetB", swap->bulkOffset[eCompB]);
802 static void pr_imd(FILE* fp, int indent, const t_IMD* imd)
804 PI("IMD-atoms", imd->nat);
805 pr_ivec_block(fp, indent, "atom", imd->ind, imd->nat, TRUE);
809 void pr_inputrec(FILE* fp, int indent, const char* title, const t_inputrec* ir, gmx_bool bMDPformat)
811 const char* infbuf = "inf";
813 if (available(fp, ir, indent, title))
817 indent = pr_title(fp, indent, title);
819 /* Try to make this list appear in the same order as the
820 * options are written in the default mdout.mdp, and with
821 * the same user-exposed names to facilitate debugging.
823 PS("integrator", enumValueToString(ir->eI));
824 PR("tinit", ir->init_t);
825 PR("dt", ir->delta_t);
826 PSTEP("nsteps", ir->nsteps);
827 PSTEP("init-step", ir->init_step);
828 PI("simulation-part", ir->simulation_part);
829 PS("mts", EBOOL(ir->useMts));
832 for (int mtsIndex = 1; mtsIndex < static_cast<int>(ir->mtsLevels.size()); mtsIndex++)
834 const auto& mtsLevel = ir->mtsLevels[mtsIndex];
835 const std::string forceKey = gmx::formatString("mts-level%d-forces", mtsIndex + 1);
836 std::string forceGroups;
837 for (int i = 0; i < static_cast<int>(gmx::MtsForceGroups::Count); i++)
839 if (mtsLevel.forceGroups[i])
841 if (!forceGroups.empty())
845 forceGroups += gmx::mtsForceGroupNames[i];
848 PS(forceKey.c_str(), forceGroups.c_str());
849 const std::string factorKey = gmx::formatString("mts-level%d-factor", mtsIndex + 1);
850 PI(factorKey.c_str(), mtsLevel.stepFactor);
853 PS("comm-mode", enumValueToString(ir->comm_mode));
854 PI("nstcomm", ir->nstcomm);
856 /* Langevin dynamics */
857 PR("bd-fric", ir->bd_fric);
858 PSTEP("ld-seed", ir->ld_seed);
860 /* Energy minimization */
861 PR("emtol", ir->em_tol);
862 PR("emstep", ir->em_stepsize);
863 PI("niter", ir->niter);
864 PR("fcstep", ir->fc_stepsize);
865 PI("nstcgsteep", ir->nstcgsteep);
866 PI("nbfgscorr", ir->nbfgscorr);
868 /* Test particle insertion */
869 PR("rtpi", ir->rtpi);
872 PI("nstxout", ir->nstxout);
873 PI("nstvout", ir->nstvout);
874 PI("nstfout", ir->nstfout);
875 PI("nstlog", ir->nstlog);
876 PI("nstcalcenergy", ir->nstcalcenergy);
877 PI("nstenergy", ir->nstenergy);
878 PI("nstxout-compressed", ir->nstxout_compressed);
879 PR("compressed-x-precision", ir->x_compression_precision);
881 /* Neighborsearching parameters */
882 PS("cutoff-scheme", enumValueToString(ir->cutoff_scheme));
883 PI("nstlist", ir->nstlist);
884 PS("pbc", c_pbcTypeNames[ir->pbcType].c_str());
885 PS("periodic-molecules", EBOOL(ir->bPeriodicMols));
886 PR("verlet-buffer-tolerance", ir->verletbuf_tol);
887 PR("rlist", ir->rlist);
889 /* Options for electrostatics and VdW */
890 PS("coulombtype", enumValueToString(ir->coulombtype));
891 PS("coulomb-modifier", enumValueToString(ir->coulomb_modifier));
892 PR("rcoulomb-switch", ir->rcoulomb_switch);
893 PR("rcoulomb", ir->rcoulomb);
894 if (ir->epsilon_r != 0)
896 PR("epsilon-r", ir->epsilon_r);
900 PS("epsilon-r", infbuf);
902 if (ir->epsilon_rf != 0)
904 PR("epsilon-rf", ir->epsilon_rf);
908 PS("epsilon-rf", infbuf);
910 PS("vdw-type", enumValueToString(ir->vdwtype));
911 PS("vdw-modifier", enumValueToString(ir->vdw_modifier));
912 PR("rvdw-switch", ir->rvdw_switch);
913 PR("rvdw", ir->rvdw);
914 PS("DispCorr", enumValueToString(ir->eDispCorr));
915 PR("table-extension", ir->tabext);
917 PR("fourierspacing", ir->fourier_spacing);
918 PI("fourier-nx", ir->nkx);
919 PI("fourier-ny", ir->nky);
920 PI("fourier-nz", ir->nkz);
921 PI("pme-order", ir->pme_order);
922 PR("ewald-rtol", ir->ewald_rtol);
923 PR("ewald-rtol-lj", ir->ewald_rtol_lj);
924 PS("lj-pme-comb-rule", enumValueToString(ir->ljpme_combination_rule));
925 PS("ewald-geometry", enumValueToString(ir->ewald_geometry));
926 PR("epsilon-surface", ir->epsilon_surface);
928 /* Options for weak coupling algorithms */
929 PS("tcoupl", enumValueToString(ir->etc));
930 PI("nsttcouple", ir->nsttcouple);
931 PI("nh-chain-length", ir->opts.nhchainlength);
932 PS("print-nose-hoover-chain-variables", EBOOL(ir->bPrintNHChains));
934 PS("pcoupl", enumValueToString(ir->epc));
935 PS("pcoupltype", enumValueToString(ir->epct));
936 PI("nstpcouple", ir->nstpcouple);
937 PR("tau-p", ir->tau_p);
938 pr_matrix(fp, indent, "compressibility", ir->compress, bMDPformat);
939 pr_matrix(fp, indent, "ref-p", ir->ref_p, bMDPformat);
940 PS("refcoord-scaling", enumValueToString(ir->refcoord_scaling));
944 fprintf(fp, "posres-com = %g %g %g\n", ir->posres_com[XX], ir->posres_com[YY], ir->posres_com[ZZ]);
945 fprintf(fp, "posres-comB = %g %g %g\n", ir->posres_comB[XX], ir->posres_comB[YY], ir->posres_comB[ZZ]);
949 pr_rvec(fp, indent, "posres-com", ir->posres_com, DIM, TRUE);
950 pr_rvec(fp, indent, "posres-comB", ir->posres_comB, DIM, TRUE);
954 PS("QMMM", EBOOL(ir->bQMMM));
955 fprintf(fp, "%s:\n", "qm-opts");
956 pr_int(fp, indent, "ngQM", ir->opts.ngQM);
958 /* CONSTRAINT OPTIONS */
959 PS("constraint-algorithm", enumValueToString(ir->eConstrAlg));
960 PS("continuation", EBOOL(ir->bContinuation));
962 PS("Shake-SOR", EBOOL(ir->bShakeSOR));
963 PR("shake-tol", ir->shake_tol);
964 PI("lincs-order", ir->nProjOrder);
965 PI("lincs-iter", ir->nLincsIter);
966 PR("lincs-warnangle", ir->LincsWarnAngle);
969 PI("nwall", ir->nwall);
970 PS("wall-type", enumValueToString(ir->wall_type));
971 PR("wall-r-linpot", ir->wall_r_linpot);
973 PI("wall-atomtype[0]", ir->wall_atomtype[0]);
974 PI("wall-atomtype[1]", ir->wall_atomtype[1]);
976 PR("wall-density[0]", ir->wall_density[0]);
977 PR("wall-density[1]", ir->wall_density[1]);
978 PR("wall-ewald-zfac", ir->wall_ewald_zfac);
981 PS("pull", EBOOL(ir->bPull));
984 pr_pull(fp, indent, *ir->pull);
988 PS("awh", EBOOL(ir->bDoAwh));
991 pr_awh(fp, indent, ir->awhParams.get());
994 /* ENFORCED ROTATION */
995 PS("rotation", EBOOL(ir->bRot));
998 pr_rot(fp, indent, ir->rot);
1001 /* INTERACTIVE MD */
1002 PS("interactiveMD", EBOOL(ir->bIMD));
1005 pr_imd(fp, indent, ir->imd);
1008 /* NMR refinement stuff */
1009 PS("disre", enumValueToString(ir->eDisre));
1010 PS("disre-weighting", enumValueToString(ir->eDisreWeighting));
1011 PS("disre-mixed", EBOOL(ir->bDisreMixed));
1012 PR("dr-fc", ir->dr_fc);
1013 PR("dr-tau", ir->dr_tau);
1014 PR("nstdisreout", ir->nstdisreout);
1016 PR("orire-fc", ir->orires_fc);
1017 PR("orire-tau", ir->orires_tau);
1018 PR("nstorireout", ir->nstorireout);
1020 /* FREE ENERGY VARIABLES */
1021 PS("free-energy", enumValueToString(ir->efep));
1022 if (ir->efep != FreeEnergyPerturbationType::No || ir->bSimTemp)
1024 pr_fepvals(fp, indent, ir->fepvals.get(), bMDPformat);
1028 pr_expandedvals(fp, indent, ir->expandedvals.get(), ir->fepvals->n_lambda);
1031 /* NON-equilibrium MD stuff */
1032 PR("cos-acceleration", ir->cos_accel);
1033 pr_matrix(fp, indent, "deform", ir->deform, bMDPformat);
1035 /* SIMULATED TEMPERING */
1036 PS("simulated-tempering", EBOOL(ir->bSimTemp));
1039 pr_simtempvals(fp, indent, ir->simtempvals.get(), ir->fepvals->n_lambda);
1042 /* ION/WATER SWAPPING FOR COMPUTATIONAL ELECTROPHYSIOLOGY */
1043 PS("swapcoords", enumValueToString(ir->eSwapCoords));
1044 if (ir->eSwapCoords != SwapType::No)
1046 pr_swap(fp, indent, ir->swap);
1049 /* USER-DEFINED THINGIES */
1050 PI("userint1", ir->userint1);
1051 PI("userint2", ir->userint2);
1052 PI("userint3", ir->userint3);
1053 PI("userint4", ir->userint4);
1054 PR("userreal1", ir->userreal1);
1055 PR("userreal2", ir->userreal2);
1056 PR("userreal3", ir->userreal3);
1057 PR("userreal4", ir->userreal4);
1061 gmx::TextWriter writer(fp);
1062 writer.wrapperSettings().setIndent(indent);
1063 gmx::dumpKeyValueTree(&writer, *ir->params);
1066 pr_grp_opts(fp, indent, "grpopts", &(ir->opts), bMDPformat);
1073 static void cmp_grpopts(FILE* fp, const t_grpopts* opt1, const t_grpopts* opt2, real ftol, real abstol)
1076 char buf1[256], buf2[256];
1078 cmp_int(fp, "inputrec->grpopts.ngtc", -1, opt1->ngtc, opt2->ngtc);
1079 cmp_int(fp, "inputrec->grpopts.ngfrz", -1, opt1->ngfrz, opt2->ngfrz);
1080 cmp_int(fp, "inputrec->grpopts.ngener", -1, opt1->ngener, opt2->ngener);
1081 for (i = 0; (i < std::min(opt1->ngtc, opt2->ngtc)); i++)
1083 cmp_real(fp, "inputrec->grpopts.nrdf", i, opt1->nrdf[i], opt2->nrdf[i], ftol, abstol);
1084 cmp_real(fp, "inputrec->grpopts.ref_t", i, opt1->ref_t[i], opt2->ref_t[i], ftol, abstol);
1085 cmp_real(fp, "inputrec->grpopts.tau_t", i, opt1->tau_t[i], opt2->tau_t[i], ftol, abstol);
1086 cmpEnum(fp, "inputrec->grpopts.annealing", opt1->annealing[i], opt2->annealing[i]);
1087 cmp_int(fp, "inputrec->grpopts.anneal_npoints", i, opt1->anneal_npoints[i], opt2->anneal_npoints[i]);
1088 if (opt1->anneal_npoints[i] == opt2->anneal_npoints[i])
1090 sprintf(buf1, "inputrec->grpopts.anneal_time[%d]", i);
1091 sprintf(buf2, "inputrec->grpopts.anneal_temp[%d]", i);
1092 for (j = 0; j < opt1->anneal_npoints[i]; j++)
1094 cmp_real(fp, buf1, j, opt1->anneal_time[i][j], opt2->anneal_time[i][j], ftol, abstol);
1095 cmp_real(fp, buf2, j, opt1->anneal_temp[i][j], opt2->anneal_temp[i][j], ftol, abstol);
1099 if (opt1->ngener == opt2->ngener)
1101 for (i = 0; i < opt1->ngener; i++)
1103 for (j = i; j < opt1->ngener; j++)
1105 sprintf(buf1, "inputrec->grpopts.egp_flags[%d]", i);
1106 cmp_int(fp, buf1, j, opt1->egp_flags[opt1->ngener * i + j], opt2->egp_flags[opt1->ngener * i + j]);
1110 for (i = 0; (i < std::min(opt1->ngfrz, opt2->ngfrz)); i++)
1112 cmp_ivec(fp, "inputrec->grpopts.nFreeze", i, opt1->nFreeze[i], opt2->nFreeze[i]);
1116 static void cmp_pull(FILE* fp)
1119 "WARNING: Both files use COM pulling, but comparing of the pull struct is not "
1120 "implemented (yet). The pull parameters could be the same or different.\n");
1123 static void cmp_awhDimParams(FILE* fp,
1124 const gmx::AwhDimParams& dimp1,
1125 const gmx::AwhDimParams& dimp2,
1130 /* Note that we have double index here, but the compare functions only
1131 * support one index, so here we only print the dim index and not the bias.
1134 "inputrec.awhParams->bias?->dim->coord_index",
1136 dimp1.coordinateIndex(),
1137 dimp2.coordinateIndex());
1138 cmp_double(fp, "inputrec->awhParams->bias?->dim->period", dimIndex, dimp1.period(), dimp2.period(), ftol, abstol);
1140 "inputrec->awhParams->bias?->dim->diffusion",
1146 cmp_double(fp, "inputrec->awhParams->bias?->dim->origin", dimIndex, dimp1.origin(), dimp2.origin(), ftol, abstol);
1147 cmp_double(fp, "inputrec->awhParams->bias?->dim->end", dimIndex, dimp1.end(), dimp2.end(), ftol, abstol);
1149 "inputrec->awhParams->bias?->dim->coord_value_init",
1151 dimp1.initialCoordinate(),
1152 dimp2.initialCoordinate(),
1156 "inputrec->awhParams->bias?->dim->coverDiameter",
1158 dimp1.coverDiameter(),
1159 dimp2.coverDiameter(),
1164 static void cmp_awhBiasParams(FILE* fp,
1165 const gmx::AwhBiasParams& bias1,
1166 const gmx::AwhBiasParams& bias2,
1171 cmp_int(fp, "inputrec->awhParams->ndim", biasIndex, bias1.ndim(), bias2.ndim());
1172 cmpEnum<gmx::AwhTargetType>(
1173 fp, "inputrec->awhParams->biaseTarget", bias1.targetDistribution(), bias2.targetDistribution());
1175 "inputrec->awhParams->biastargetBetaScaling",
1177 bias1.targetBetaScaling(),
1178 bias2.targetBetaScaling(),
1182 "inputrec->awhParams->biastargetCutoff",
1184 bias1.targetCutoff(),
1185 bias2.targetCutoff(),
1188 cmpEnum<gmx::AwhHistogramGrowthType>(
1189 fp, "inputrec->awhParams->biaseGrowth", bias1.growthType(), bias2.growthType());
1190 cmp_bool(fp, "inputrec->awhParams->biasbUserData", biasIndex, bias1.userPMFEstimate(), bias2.userPMFEstimate());
1192 "inputrec->awhParams->biaserror_initial",
1194 bias1.initialErrorEstimate(),
1195 bias2.initialErrorEstimate(),
1198 cmp_int(fp, "inputrec->awhParams->biasShareGroup", biasIndex, bias1.shareGroup(), bias2.shareGroup());
1200 const auto dimParams1 = bias1.dimParams();
1201 const auto dimParams2 = bias2.dimParams();
1202 for (int dim = 0; dim < std::min(bias1.ndim(), bias2.ndim()); dim++)
1204 cmp_awhDimParams(fp, dimParams1[dim], dimParams2[dim], dim, ftol, abstol);
1208 static void cmp_awhParams(FILE* fp, const gmx::AwhParams& awh1, const gmx::AwhParams& awh2, real ftol, real abstol)
1210 cmp_int(fp, "inputrec->awhParams->nbias", -1, awh1.numBias(), awh2.numBias());
1211 cmp_int64(fp, "inputrec->awhParams->seed", awh1.seed(), awh2.seed());
1212 cmp_int(fp, "inputrec->awhParams->nstout", -1, awh1.nstout(), awh2.nstout());
1213 cmp_int(fp, "inputrec->awhParams->nstsample_coord", -1, awh1.nstSampleCoord(), awh2.nstSampleCoord());
1215 "inputrec->awhParams->nsamples_update_free_energy",
1217 awh1.numSamplesUpdateFreeEnergy(),
1218 awh2.numSamplesUpdateFreeEnergy());
1219 cmpEnum<gmx::AwhPotentialType>(
1220 fp, "inputrec->awhParams->ePotential", awh1.potential(), awh2.potential());
1221 cmp_bool(fp, "inputrec->awhParams->shareBiasMultisim", -1, awh1.shareBiasMultisim(), awh2.shareBiasMultisim());
1223 if (awh1.numBias() == awh2.numBias())
1225 const auto awhBiasParams1 = awh1.awhBiasParams();
1226 const auto awhBiasParams2 = awh2.awhBiasParams();
1227 for (int bias = 0; bias < awh1.numBias(); bias++)
1229 cmp_awhBiasParams(fp, awhBiasParams1[bias], awhBiasParams2[bias], bias, ftol, abstol);
1234 static void cmp_simtempvals(FILE* fp,
1235 const t_simtemp* simtemp1,
1236 const t_simtemp* simtemp2,
1242 cmpEnum(fp, "inputrec->simtempvals->eSimTempScale", simtemp1->eSimTempScale, simtemp2->eSimTempScale);
1243 cmp_real(fp, "inputrec->simtempvals->simtemp_high", -1, simtemp1->simtemp_high, simtemp2->simtemp_high, ftol, abstol);
1244 cmp_real(fp, "inputrec->simtempvals->simtemp_low", -1, simtemp1->simtemp_low, simtemp2->simtemp_low, ftol, abstol);
1245 for (i = 0; i < n_lambda; i++)
1248 "inputrec->simtempvals->temperatures",
1250 simtemp1->temperatures[i],
1251 simtemp2->temperatures[i],
1257 static void cmp_expandedvals(FILE* fp,
1258 const t_expanded* expand1,
1259 const t_expanded* expand2,
1266 cmp_bool(fp, "inputrec->fepvals->bInit_weights", -1, expand1->bInit_weights, expand2->bInit_weights);
1267 cmp_bool(fp, "inputrec->fepvals->bWLoneovert", -1, expand1->bWLoneovert, expand2->bWLoneovert);
1269 for (i = 0; i < n_lambda; i++)
1272 "inputrec->expandedvals->init_lambda_weights",
1274 expand1->init_lambda_weights[i],
1275 expand2->init_lambda_weights[i],
1280 cmpEnum(fp, "inputrec->expandedvals->lambda-stats", expand1->elamstats, expand2->elamstats);
1281 cmpEnum(fp, "inputrec->expandedvals->lambda-mc-move", expand1->elmcmove, expand2->elmcmove);
1282 cmp_int(fp, "inputrec->expandedvals->lmc-repeats", -1, expand1->lmc_repeats, expand2->lmc_repeats);
1283 cmp_int(fp, "inputrec->expandedvals->lmc-gibbsdelta", -1, expand1->gibbsdeltalam, expand2->gibbsdeltalam);
1284 cmp_int(fp, "inputrec->expandedvals->lmc-forced-nstart", -1, expand1->lmc_forced_nstart, expand2->lmc_forced_nstart);
1285 cmpEnum(fp, "inputrec->expandedvals->lambda-weights-equil", expand1->elmceq, expand2->elmceq);
1287 "inputrec->expandedvals->,weight-equil-number-all-lambda",
1289 expand1->equil_n_at_lam,
1290 expand2->equil_n_at_lam);
1291 cmp_int(fp, "inputrec->expandedvals->weight-equil-number-samples", -1, expand1->equil_samples, expand2->equil_samples);
1292 cmp_int(fp, "inputrec->expandedvals->weight-equil-number-steps", -1, expand1->equil_steps, expand2->equil_steps);
1294 "inputrec->expandedvals->weight-equil-wl-delta",
1296 expand1->equil_wl_delta,
1297 expand2->equil_wl_delta,
1301 "inputrec->expandedvals->weight-equil-count-ratio",
1303 expand1->equil_ratio,
1304 expand2->equil_ratio,
1308 "inputrec->expandedvals->symmetrized-transition-matrix",
1310 expand1->bSymmetrizedTMatrix,
1311 expand2->bSymmetrizedTMatrix);
1312 cmp_int(fp, "inputrec->expandedvals->nstTij", -1, expand1->nstTij, expand2->nstTij);
1313 cmp_int(fp, "inputrec->expandedvals->mininum-var-min", -1, expand1->minvarmin, expand2->minvarmin); /*default is reasonable */
1314 cmp_int(fp, "inputrec->expandedvals->weight-c-range", -1, expand1->c_range, expand2->c_range); /* default is just C=0 */
1315 cmp_real(fp, "inputrec->expandedvals->wl-scale", -1, expand1->wl_scale, expand2->wl_scale, ftol, abstol);
1316 cmp_real(fp, "inputrec->expandedvals->init-wl-delta", -1, expand1->init_wl_delta, expand2->init_wl_delta, ftol, abstol);
1317 cmp_real(fp, "inputrec->expandedvals->wl-ratio", -1, expand1->wl_ratio, expand2->wl_ratio, ftol, abstol);
1318 cmp_int(fp, "inputrec->expandedvals->nstexpanded", -1, expand1->nstexpanded, expand2->nstexpanded);
1319 cmp_int(fp, "inputrec->expandedvals->lmc-seed", -1, expand1->lmc_seed, expand2->lmc_seed);
1320 cmp_real(fp, "inputrec->expandedvals->mc-temperature", -1, expand1->mc_temp, expand2->mc_temp, ftol, abstol);
1323 static void cmp_fepvals(FILE* fp, const t_lambda* fep1, const t_lambda* fep2, real ftol, real abstol)
1326 cmp_int(fp, "inputrec->nstdhdl", -1, fep1->nstdhdl, fep2->nstdhdl);
1327 cmp_double(fp, "inputrec->fepvals->init_fep_state", -1, fep1->init_fep_state, fep2->init_fep_state, ftol, abstol);
1328 cmp_double(fp, "inputrec->fepvals->delta_lambda", -1, fep1->delta_lambda, fep2->delta_lambda, ftol, abstol);
1329 cmp_int(fp, "inputrec->fepvals->n_lambda", -1, fep1->n_lambda, fep2->n_lambda);
1330 for (i = 0; i < static_cast<int>(FreeEnergyPerturbationCouplingType::Count); i++)
1332 for (j = 0; j < std::min(fep1->n_lambda, fep2->n_lambda); j++)
1335 "inputrec->fepvals->all_lambda",
1337 fep1->all_lambda[i][j],
1338 fep2->all_lambda[i][j],
1343 cmp_int(fp, "inputrec->fepvals->lambda_neighbors", 1, fep1->lambda_neighbors, fep2->lambda_neighbors);
1344 cmp_real(fp, "inputrec->fepvals->sc_alpha", -1, fep1->sc_alpha, fep2->sc_alpha, ftol, abstol);
1345 cmp_int(fp, "inputrec->fepvals->sc_power", -1, fep1->sc_power, fep2->sc_power);
1346 cmp_real(fp, "inputrec->fepvals->sc_r_power", -1, fep1->sc_r_power, fep2->sc_r_power, ftol, abstol);
1347 cmp_real(fp, "inputrec->fepvals->sc_sigma", -1, fep1->sc_sigma, fep2->sc_sigma, ftol, abstol);
1348 cmpEnum(fp, "inputrec->fepvals->edHdLPrintEnergy", fep1->edHdLPrintEnergy, fep1->edHdLPrintEnergy);
1349 cmp_bool(fp, "inputrec->fepvals->bScCoul", -1, fep1->bScCoul, fep1->bScCoul);
1350 cmpEnum(fp, "inputrec->separate_dhdl_file", fep1->separate_dhdl_file, fep2->separate_dhdl_file);
1351 cmpEnum(fp, "inputrec->dhdl_derivatives", fep1->dhdl_derivatives, fep2->dhdl_derivatives);
1352 cmp_int(fp, "inputrec->dh_hist_size", -1, fep1->dh_hist_size, fep2->dh_hist_size);
1353 cmp_double(fp, "inputrec->dh_hist_spacing", -1, fep1->dh_hist_spacing, fep2->dh_hist_spacing, ftol, abstol);
1356 void cmp_inputrec(FILE* fp, const t_inputrec* ir1, const t_inputrec* ir2, real ftol, real abstol)
1358 fprintf(fp, "comparing inputrec\n");
1360 /* gcc 2.96 doesnt like these defines at all, but issues a huge list
1361 * of warnings. Maybe it will change in future versions, but for the
1362 * moment I've spelled them out instead. /EL 000820
1363 * #define CIB(s) cmp_int(fp,"inputrec->"#s,0,ir1->##s,ir2->##s)
1364 * #define CII(s) cmp_int(fp,"inputrec->"#s,0,ir1->##s,ir2->##s)
1365 * #define CIR(s) cmp_real(fp,"inputrec->"#s,0,ir1->##s,ir2->##s,ftol)
1367 cmpEnum(fp, "inputrec->eI", ir1->eI, ir2->eI);
1368 cmp_int64(fp, "inputrec->nsteps", ir1->nsteps, ir2->nsteps);
1369 cmp_int64(fp, "inputrec->init_step", ir1->init_step, ir2->init_step);
1370 cmp_int(fp, "inputrec->simulation_part", -1, ir1->simulation_part, ir2->simulation_part);
1371 cmp_int(fp, "inputrec->mts", -1, static_cast<int>(ir1->useMts), static_cast<int>(ir2->useMts));
1372 if (ir1->useMts && ir2->useMts)
1374 cmp_int(fp, "inputrec->mts-levels", -1, ir1->mtsLevels.size(), ir2->mtsLevels.size());
1376 "inputrec->mts-level2-forces",
1378 ir1->mtsLevels[1].forceGroups.to_ulong(),
1379 ir2->mtsLevels[1].forceGroups.to_ulong());
1381 "inputrec->mts-level2-factor",
1383 ir1->mtsLevels[1].stepFactor,
1384 ir2->mtsLevels[1].stepFactor);
1386 cmp_int(fp, "inputrec->pbcType", -1, static_cast<int>(ir1->pbcType), static_cast<int>(ir2->pbcType));
1387 cmp_bool(fp, "inputrec->bPeriodicMols", -1, ir1->bPeriodicMols, ir2->bPeriodicMols);
1388 cmpEnum(fp, "inputrec->cutoff_scheme", ir1->cutoff_scheme, ir2->cutoff_scheme);
1389 cmp_int(fp, "inputrec->nstlist", -1, ir1->nstlist, ir2->nstlist);
1390 cmp_int(fp, "inputrec->nstcomm", -1, ir1->nstcomm, ir2->nstcomm);
1391 cmpEnum(fp, "inputrec->comm_mode", ir1->comm_mode, ir2->comm_mode);
1392 cmp_int(fp, "inputrec->nstlog", -1, ir1->nstlog, ir2->nstlog);
1393 cmp_int(fp, "inputrec->nstxout", -1, ir1->nstxout, ir2->nstxout);
1394 cmp_int(fp, "inputrec->nstvout", -1, ir1->nstvout, ir2->nstvout);
1395 cmp_int(fp, "inputrec->nstfout", -1, ir1->nstfout, ir2->nstfout);
1396 cmp_int(fp, "inputrec->nstcalcenergy", -1, ir1->nstcalcenergy, ir2->nstcalcenergy);
1397 cmp_int(fp, "inputrec->nstenergy", -1, ir1->nstenergy, ir2->nstenergy);
1398 cmp_int(fp, "inputrec->nstxout_compressed", -1, ir1->nstxout_compressed, ir2->nstxout_compressed);
1399 cmp_double(fp, "inputrec->init_t", -1, ir1->init_t, ir2->init_t, ftol, abstol);
1400 cmp_double(fp, "inputrec->delta_t", -1, ir1->delta_t, ir2->delta_t, ftol, abstol);
1402 "inputrec->x_compression_precision",
1404 ir1->x_compression_precision,
1405 ir2->x_compression_precision,
1408 cmp_real(fp, "inputrec->fourierspacing", -1, ir1->fourier_spacing, ir2->fourier_spacing, ftol, abstol);
1409 cmp_int(fp, "inputrec->nkx", -1, ir1->nkx, ir2->nkx);
1410 cmp_int(fp, "inputrec->nky", -1, ir1->nky, ir2->nky);
1411 cmp_int(fp, "inputrec->nkz", -1, ir1->nkz, ir2->nkz);
1412 cmp_int(fp, "inputrec->pme_order", -1, ir1->pme_order, ir2->pme_order);
1413 cmp_real(fp, "inputrec->ewald_rtol", -1, ir1->ewald_rtol, ir2->ewald_rtol, ftol, abstol);
1414 cmpEnum(fp, "inputrec->ewald_geometry", ir1->ewald_geometry, ir2->ewald_geometry);
1415 cmp_real(fp, "inputrec->epsilon_surface", -1, ir1->epsilon_surface, ir2->epsilon_surface, ftol, abstol);
1417 "inputrec->bContinuation",
1419 static_cast<int>(ir1->bContinuation),
1420 static_cast<int>(ir2->bContinuation));
1421 cmp_int(fp, "inputrec->bShakeSOR", -1, static_cast<int>(ir1->bShakeSOR), static_cast<int>(ir2->bShakeSOR));
1422 cmpEnum(fp, "inputrec->etc", ir1->etc, ir2->etc);
1424 "inputrec->bPrintNHChains",
1426 static_cast<int>(ir1->bPrintNHChains),
1427 static_cast<int>(ir2->bPrintNHChains));
1428 cmpEnum(fp, "inputrec->epc", ir1->epc, ir2->epc);
1429 cmpEnum(fp, "inputrec->epct", ir1->epct, ir2->epct);
1430 cmp_real(fp, "inputrec->tau_p", -1, ir1->tau_p, ir2->tau_p, ftol, abstol);
1431 cmp_rvec(fp, "inputrec->ref_p(x)", -1, ir1->ref_p[XX], ir2->ref_p[XX], ftol, abstol);
1432 cmp_rvec(fp, "inputrec->ref_p(y)", -1, ir1->ref_p[YY], ir2->ref_p[YY], ftol, abstol);
1433 cmp_rvec(fp, "inputrec->ref_p(z)", -1, ir1->ref_p[ZZ], ir2->ref_p[ZZ], ftol, abstol);
1434 cmp_rvec(fp, "inputrec->compress(x)", -1, ir1->compress[XX], ir2->compress[XX], ftol, abstol);
1435 cmp_rvec(fp, "inputrec->compress(y)", -1, ir1->compress[YY], ir2->compress[YY], ftol, abstol);
1436 cmp_rvec(fp, "inputrec->compress(z)", -1, ir1->compress[ZZ], ir2->compress[ZZ], ftol, abstol);
1437 cmpEnum(fp, "refcoord_scaling", ir1->refcoord_scaling, ir2->refcoord_scaling);
1438 cmp_rvec(fp, "inputrec->posres_com", -1, ir1->posres_com, ir2->posres_com, ftol, abstol);
1439 cmp_rvec(fp, "inputrec->posres_comB", -1, ir1->posres_comB, ir2->posres_comB, ftol, abstol);
1440 cmp_real(fp, "inputrec->verletbuf_tol", -1, ir1->verletbuf_tol, ir2->verletbuf_tol, ftol, abstol);
1441 cmp_real(fp, "inputrec->rlist", -1, ir1->rlist, ir2->rlist, ftol, abstol);
1442 cmp_real(fp, "inputrec->rtpi", -1, ir1->rtpi, ir2->rtpi, ftol, abstol);
1443 cmpEnum(fp, "inputrec->coulombtype", ir1->coulombtype, ir2->coulombtype);
1444 cmpEnum(fp, "inputrec->coulomb_modifier", ir1->coulomb_modifier, ir2->coulomb_modifier);
1445 cmp_real(fp, "inputrec->rcoulomb_switch", -1, ir1->rcoulomb_switch, ir2->rcoulomb_switch, ftol, abstol);
1446 cmp_real(fp, "inputrec->rcoulomb", -1, ir1->rcoulomb, ir2->rcoulomb, ftol, abstol);
1447 cmpEnum(fp, "inputrec->vdwtype", ir1->vdwtype, ir2->vdwtype);
1448 cmpEnum(fp, "inputrec->vdw_modifier", ir1->vdw_modifier, ir2->vdw_modifier);
1449 cmp_real(fp, "inputrec->rvdw_switch", -1, ir1->rvdw_switch, ir2->rvdw_switch, ftol, abstol);
1450 cmp_real(fp, "inputrec->rvdw", -1, ir1->rvdw, ir2->rvdw, ftol, abstol);
1451 cmp_real(fp, "inputrec->epsilon_r", -1, ir1->epsilon_r, ir2->epsilon_r, ftol, abstol);
1452 cmp_real(fp, "inputrec->epsilon_rf", -1, ir1->epsilon_rf, ir2->epsilon_rf, ftol, abstol);
1453 cmp_real(fp, "inputrec->tabext", -1, ir1->tabext, ir2->tabext, ftol, abstol);
1455 cmpEnum(fp, "inputrec->eDispCorr", ir1->eDispCorr, ir2->eDispCorr);
1456 cmp_real(fp, "inputrec->shake_tol", -1, ir1->shake_tol, ir2->shake_tol, ftol, abstol);
1457 cmpEnum(fp, "inputrec->efep", ir1->efep, ir2->efep);
1458 cmp_fepvals(fp, ir1->fepvals.get(), ir2->fepvals.get(), ftol, abstol);
1459 cmp_int(fp, "inputrec->bSimTemp", -1, static_cast<int>(ir1->bSimTemp), static_cast<int>(ir2->bSimTemp));
1460 if ((ir1->bSimTemp == ir2->bSimTemp) && (ir1->bSimTemp))
1463 ir1->simtempvals.get(),
1464 ir2->simtempvals.get(),
1465 std::min(ir1->fepvals->n_lambda, ir2->fepvals->n_lambda),
1469 cmp_int(fp, "inputrec->bExpanded", -1, static_cast<int>(ir1->bExpanded), static_cast<int>(ir2->bExpanded));
1470 if ((ir1->bExpanded == ir2->bExpanded) && (ir1->bExpanded))
1472 cmp_expandedvals(fp,
1473 ir1->expandedvals.get(),
1474 ir2->expandedvals.get(),
1475 std::min(ir1->fepvals->n_lambda, ir2->fepvals->n_lambda),
1479 cmp_int(fp, "inputrec->nwall", -1, ir1->nwall, ir2->nwall);
1480 cmpEnum(fp, "inputrec->wall_type", ir1->wall_type, ir2->wall_type);
1481 cmp_int(fp, "inputrec->wall_atomtype[0]", -1, ir1->wall_atomtype[0], ir2->wall_atomtype[0]);
1482 cmp_int(fp, "inputrec->wall_atomtype[1]", -1, ir1->wall_atomtype[1], ir2->wall_atomtype[1]);
1483 cmp_real(fp, "inputrec->wall_density[0]", -1, ir1->wall_density[0], ir2->wall_density[0], ftol, abstol);
1484 cmp_real(fp, "inputrec->wall_density[1]", -1, ir1->wall_density[1], ir2->wall_density[1], ftol, abstol);
1485 cmp_real(fp, "inputrec->wall_ewald_zfac", -1, ir1->wall_ewald_zfac, ir2->wall_ewald_zfac, ftol, abstol);
1487 cmp_bool(fp, "inputrec->bPull", -1, ir1->bPull, ir2->bPull);
1488 if (ir1->bPull && ir2->bPull)
1493 cmp_bool(fp, "inputrec->bDoAwh", -1, ir1->bDoAwh, ir2->bDoAwh);
1494 if (ir1->bDoAwh && ir2->bDoAwh)
1496 cmp_awhParams(fp, *ir1->awhParams, *ir2->awhParams, ftol, abstol);
1499 cmpEnum(fp, "inputrec->eDisre", ir1->eDisre, ir2->eDisre);
1500 cmp_real(fp, "inputrec->dr_fc", -1, ir1->dr_fc, ir2->dr_fc, ftol, abstol);
1501 cmpEnum(fp, "inputrec->eDisreWeighting", ir1->eDisreWeighting, ir2->eDisreWeighting);
1502 cmp_int(fp, "inputrec->bDisreMixed", -1, static_cast<int>(ir1->bDisreMixed), static_cast<int>(ir2->bDisreMixed));
1503 cmp_int(fp, "inputrec->nstdisreout", -1, ir1->nstdisreout, ir2->nstdisreout);
1504 cmp_real(fp, "inputrec->dr_tau", -1, ir1->dr_tau, ir2->dr_tau, ftol, abstol);
1505 cmp_real(fp, "inputrec->orires_fc", -1, ir1->orires_fc, ir2->orires_fc, ftol, abstol);
1506 cmp_real(fp, "inputrec->orires_tau", -1, ir1->orires_tau, ir2->orires_tau, ftol, abstol);
1507 cmp_int(fp, "inputrec->nstorireout", -1, ir1->nstorireout, ir2->nstorireout);
1508 cmp_real(fp, "inputrec->em_stepsize", -1, ir1->em_stepsize, ir2->em_stepsize, ftol, abstol);
1509 cmp_real(fp, "inputrec->em_tol", -1, ir1->em_tol, ir2->em_tol, ftol, abstol);
1510 cmp_int(fp, "inputrec->niter", -1, ir1->niter, ir2->niter);
1511 cmp_real(fp, "inputrec->fc_stepsize", -1, ir1->fc_stepsize, ir2->fc_stepsize, ftol, abstol);
1512 cmp_int(fp, "inputrec->nstcgsteep", -1, ir1->nstcgsteep, ir2->nstcgsteep);
1513 cmp_int(fp, "inputrec->nbfgscorr", 0, ir1->nbfgscorr, ir2->nbfgscorr);
1514 cmpEnum(fp, "inputrec->eConstrAlg", ir1->eConstrAlg, ir2->eConstrAlg);
1515 cmp_int(fp, "inputrec->nProjOrder", -1, ir1->nProjOrder, ir2->nProjOrder);
1516 cmp_real(fp, "inputrec->LincsWarnAngle", -1, ir1->LincsWarnAngle, ir2->LincsWarnAngle, ftol, abstol);
1517 cmp_int(fp, "inputrec->nLincsIter", -1, ir1->nLincsIter, ir2->nLincsIter);
1518 cmp_real(fp, "inputrec->bd_fric", -1, ir1->bd_fric, ir2->bd_fric, ftol, abstol);
1519 cmp_int64(fp, "inputrec->ld_seed", ir1->ld_seed, ir2->ld_seed);
1520 cmp_real(fp, "inputrec->cos_accel", -1, ir1->cos_accel, ir2->cos_accel, ftol, abstol);
1521 cmp_rvec(fp, "inputrec->deform(a)", -1, ir1->deform[XX], ir2->deform[XX], ftol, abstol);
1522 cmp_rvec(fp, "inputrec->deform(b)", -1, ir1->deform[YY], ir2->deform[YY], ftol, abstol);
1523 cmp_rvec(fp, "inputrec->deform(c)", -1, ir1->deform[ZZ], ir2->deform[ZZ], ftol, abstol);
1526 cmp_int(fp, "inputrec->userint1", -1, ir1->userint1, ir2->userint1);
1527 cmp_int(fp, "inputrec->userint2", -1, ir1->userint2, ir2->userint2);
1528 cmp_int(fp, "inputrec->userint3", -1, ir1->userint3, ir2->userint3);
1529 cmp_int(fp, "inputrec->userint4", -1, ir1->userint4, ir2->userint4);
1530 cmp_real(fp, "inputrec->userreal1", -1, ir1->userreal1, ir2->userreal1, ftol, abstol);
1531 cmp_real(fp, "inputrec->userreal2", -1, ir1->userreal2, ir2->userreal2, ftol, abstol);
1532 cmp_real(fp, "inputrec->userreal3", -1, ir1->userreal3, ir2->userreal3, ftol, abstol);
1533 cmp_real(fp, "inputrec->userreal4", -1, ir1->userreal4, ir2->userreal4, ftol, abstol);
1534 cmp_grpopts(fp, &(ir1->opts), &(ir2->opts), ftol, abstol);
1535 gmx::TextWriter writer(fp);
1536 gmx::compareKeyValueTrees(&writer, *ir1->params, *ir2->params, ftol, abstol);
1539 void comp_pull_AB(FILE* fp, const pull_params_t& pull, real ftol, real abstol)
1541 for (int i = 0; i < pull.ncoord; i++)
1543 fprintf(fp, "comparing pull coord %d\n", i);
1544 cmp_real(fp, "pull-coord->k", -1, pull.coord[i].k, pull.coord[i].kB, ftol, abstol);
1548 gmx_bool inputrecDeform(const t_inputrec* ir)
1550 return (ir->deform[XX][XX] != 0 || ir->deform[YY][YY] != 0 || ir->deform[ZZ][ZZ] != 0
1551 || ir->deform[YY][XX] != 0 || ir->deform[ZZ][XX] != 0 || ir->deform[ZZ][YY] != 0);
1554 gmx_bool inputrecDynamicBox(const t_inputrec* ir)
1556 return (ir->epc != PressureCoupling::No || ir->eI == IntegrationAlgorithm::TPI || inputrecDeform(ir));
1559 gmx_bool inputrecPreserveShape(const t_inputrec* ir)
1561 return (ir->epc != PressureCoupling::No && ir->deform[XX][XX] == 0
1562 && (ir->epct == PressureCouplingType::Isotropic
1563 || ir->epct == PressureCouplingType::SemiIsotropic));
1566 gmx_bool inputrecNeedMutot(const t_inputrec* ir)
1568 return ((ir->coulombtype == CoulombInteractionType::Ewald || EEL_PME(ir->coulombtype))
1569 && (ir->ewald_geometry == EwaldGeometry::ThreeDC || ir->epsilon_surface != 0));
1572 gmx_bool inputrecExclForces(const t_inputrec* ir)
1574 return (EEL_FULL(ir->coulombtype) || (EEL_RF(ir->coulombtype)));
1577 gmx_bool inputrecNptTrotter(const t_inputrec* ir)
1579 return (((ir->eI == IntegrationAlgorithm::VV) || (ir->eI == IntegrationAlgorithm::VVAK))
1580 && (ir->epc == PressureCoupling::Mttk) && (ir->etc == TemperatureCoupling::NoseHoover));
1583 gmx_bool inputrecNvtTrotter(const t_inputrec* ir)
1585 return (((ir->eI == IntegrationAlgorithm::VV) || (ir->eI == IntegrationAlgorithm::VVAK))
1586 && (ir->epc != PressureCoupling::Mttk) && (ir->etc == TemperatureCoupling::NoseHoover));
1589 gmx_bool inputrecNphTrotter(const t_inputrec* ir)
1591 return (((ir->eI == IntegrationAlgorithm::VV) || (ir->eI == IntegrationAlgorithm::VVAK))
1592 && (ir->epc == PressureCoupling::Mttk) && (ir->etc != TemperatureCoupling::NoseHoover));
1595 bool inputrecPbcXY2Walls(const t_inputrec* ir)
1597 return (ir->pbcType == PbcType::XY && ir->nwall == 2);
1600 bool inputrecFrozenAtoms(const t_inputrec* ir)
1602 return ((ir->opts.nFreeze != nullptr)
1603 && (ir->opts.ngfrz > 1 || ir->opts.nFreeze[0][XX] != 0 || ir->opts.nFreeze[0][YY] != 0
1604 || ir->opts.nFreeze[0][ZZ] != 0));
1607 bool integratorHasConservedEnergyQuantity(const t_inputrec* ir)
1610 { // NOLINT bugprone-branch-clone
1611 // Energy minimization or stochastic integrator: no conservation
1614 else if (ir->etc == TemperatureCoupling::No && ir->epc == PressureCoupling::No)
1616 // The total energy is conserved, no additional conserved quanitity
1621 // Shear stress with Parrinello-Rahman is not supported (tedious)
1623 ((ir->epc == PressureCoupling::ParrinelloRahman || ir->epc == PressureCoupling::Mttk)
1624 && (ir->ref_p[YY][XX] != 0 || ir->ref_p[ZZ][XX] != 0 || ir->ref_p[ZZ][YY] != 0));
1626 return !ETC_ANDERSEN(ir->etc) && !shearWithPR;
1630 bool integratorHasReferenceTemperature(const t_inputrec* ir)
1632 return ((ir->etc != TemperatureCoupling::No) || EI_SD(ir->eI)
1633 || (ir->eI == IntegrationAlgorithm::BD) || EI_TPI(ir->eI));
1636 int inputrec2nboundeddim(const t_inputrec* ir)
1638 if (inputrecPbcXY2Walls(ir))
1644 return numPbcDimensions(ir->pbcType);
1648 int ndof_com(const t_inputrec* ir)
1652 switch (ir->pbcType)
1655 case PbcType::No: n = 3; break;
1656 case PbcType::XY: n = (ir->nwall == 0 ? 3 : 2); break;
1657 case PbcType::Screw: n = 1; break;
1658 default: gmx_incons("Unknown pbc in calc_nrdf");
1664 real maxReferenceTemperature(const t_inputrec& ir)
1666 if (EI_ENERGY_MINIMIZATION(ir.eI) || ir.eI == IntegrationAlgorithm::NM)
1671 if (EI_MD(ir.eI) && ir.etc == TemperatureCoupling::No)
1676 /* SD and BD also use ref_t and tau_t for setting the reference temperature.
1677 * TPI can be treated as MD, since it needs an ensemble temperature.
1680 real maxTemperature = 0;
1681 for (int i = 0; i < ir.opts.ngtc; i++)
1683 if (ir.opts.tau_t[i] >= 0)
1685 maxTemperature = std::max(maxTemperature, ir.opts.ref_t[i]);
1689 return maxTemperature;
1692 bool haveEwaldSurfaceContribution(const t_inputrec& ir)
1694 return EEL_PME_EWALD(ir.coulombtype)
1695 && (ir.ewald_geometry == EwaldGeometry::ThreeDC || ir.epsilon_surface != 0);
1698 bool haveFreeEnergyType(const t_inputrec& ir, const int fepType)
1700 for (int i = 0; i < ir.fepvals->n_lambda; i++)
1702 if (ir.fepvals->all_lambda[fepType][i] > 0)