*
* Copyright (c) 1991-2000, University of Groningen, The Netherlands.
* Copyright (c) 2001-2004, The GROMACS development team.
- * Copyright (c) 2013,2014,2015,2016,2017,2018, by the GROMACS development team, led by
+ * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
+ * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
* Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
* and including many others, as listed in the AUTHORS file in the
* top-level source directory and at http://www.gromacs.org.
*/
#include "gmxpre.h"
-#include <assert.h>
-#include <stdlib.h>
-#include <string.h>
+#include <cassert>
+#include <cstdlib>
+#include <cstring>
+#include <regex>
+#include "gromacs/domdec/localatomsetmanager.h"
#include "gromacs/fileio/readinp.h"
#include "gromacs/fileio/warninp.h"
#include "gromacs/gmxpreprocess/readir.h"
#include "gromacs/math/vec.h"
#include "gromacs/mdlib/mdatoms.h"
-#include "gromacs/mdlib/mdrun.h"
#include "gromacs/mdtypes/inputrec.h"
#include "gromacs/mdtypes/md_enums.h"
-#include "gromacs/mdtypes/pull-params.h"
+#include "gromacs/mdtypes/mdatom.h"
+#include "gromacs/mdtypes/pull_params.h"
#include "gromacs/pbcutil/pbc.h"
#include "gromacs/pulling/pull.h"
#include "gromacs/topology/topology.h"
+#include "gromacs/utility/arrayref.h"
+#include "gromacs/utility/basedefinitions.h"
#include "gromacs/utility/cstringutil.h"
+#include "gromacs/utility/exceptions.h"
#include "gromacs/utility/fatalerror.h"
#include "gromacs/utility/futil.h"
#include "gromacs/utility/smalloc.h"
+#include "gromacs/utility/stringutil.h"
static void string2dvec(const char buf[], dvec nums)
}
}
-static void init_pull_group(t_pull_group *pg,
- const char *wbuf)
+static std::vector<real> setupPullGroupWeights(const char* wbuf)
{
double d;
int n;
- pg->nweight = 0;
+ std::vector<real> weight;
while (sscanf(wbuf, "%lf %n", &d, &n) == 1)
{
- if (pg->nweight % 100 == 0)
- {
- srenew(pg->weight, pg->nweight+100);
- }
- pg->weight[pg->nweight++] = d;
+ weight.push_back(d);
wbuf += n;
}
+ return weight;
}
-static void process_pull_dim(char *dim_buf, ivec dim, const t_pull_coord *pcrd)
+static void process_pull_dim(char* dim_buf, ivec dim, const t_pull_coord* pcrd)
{
- int ndim, d, nchar;
- char *ptr, pulldim1[STRLEN];
-
- ptr = dim_buf;
- ndim = 0;
- for (d = 0; d < DIM; d++)
+ char* ptr = dim_buf;
+ int ndim = 0;
+ for (int d = 0; d < DIM; d++)
{
+ int nchar = 0;
+ char pulldim1[STRLEN];
if (sscanf(ptr, "%s%n", pulldim1, &nchar) != 1)
{
- gmx_fatal(FARGS, "Less than 3 pull dimensions given in pull_dim: '%s'",
- dim_buf);
+ gmx_fatal(FARGS, "Less than 3 pull dimensions given in pull_dim: '%s'", dim_buf);
}
- if (gmx_strncasecmp(pulldim1, "N", 1) == 0)
+ if (gmx::equalCaseInsensitive(pulldim1, "N", 1))
{
dim[d] = 0;
}
- else if (gmx_strncasecmp(pulldim1, "Y", 1) == 0)
+ else if (gmx::equalCaseInsensitive(pulldim1, "Y", 1))
{
dim[d] = 1;
ndim++;
}
else
{
- gmx_fatal(FARGS, "Please use Y(ES) or N(O) for pull_dim only (not %s)",
- pulldim1);
+ gmx_fatal(FARGS, "Please use Y(ES) or N(O) for pull_dim only (not %s)", pulldim1);
}
ptr += nchar;
}
{
gmx_fatal(FARGS, "All entries in pull dim are N");
}
- if ((pcrd->eGeom == epullgDIHEDRAL) && (ndim < 3))
+ if ((pcrd->eGeom == PullGroupGeometry::Dihedral) && (ndim < 3))
{
gmx_fatal(FARGS, "Pull geometry dihedral is only useful with pull-dim = Y Y Y");
}
- if ((pcrd->eGeom == epullgANGLE || pcrd->eGeom == epullgANGLEAXIS ) && (ndim < 2))
+ if ((pcrd->eGeom == PullGroupGeometry::Angle || pcrd->eGeom == PullGroupGeometry::AngleAxis)
+ && (ndim < 2))
{
- gmx_fatal(FARGS, "Pull geometry %s is only useful with pull-dim = Y for at least 2 dimensions",
- EPULLGEOM(pcrd->eGeom));
+ gmx_fatal(FARGS,
+ "Pull geometry %s is only useful with pull-dim = Y for at least 2 dimensions",
+ enumValueToString(pcrd->eGeom));
}
}
-static void init_pull_coord(t_pull_coord *pcrd, int coord_index_for_output,
- char *dim_buf,
- const char *origin_buf, const char *vec_buf,
- warninp_t wi)
+static void initTransformationPullCoord(t_pull_coord* pcrd, const pull_params_t& pull, warninp_t wi)
{
- int m;
- dvec origin, vec;
- char buf[STRLEN];
-
- if (pcrd->eType == epullCONSTRAINT && (pcrd->eGeom == epullgCYL ||
- pcrd->eGeom == epullgDIRRELATIVE ||
- pcrd->eGeom == epullgANGLE ||
- pcrd->eGeom == epullgANGLEAXIS ||
- pcrd->eGeom == epullgDIHEDRAL))
+ const int coord_index_for_output = pull.coord.size() + 1;
+ if (pcrd->eType == PullingAlgorithm::Constraint)
{
- gmx_fatal(FARGS, "Pulling of type %s can not be combined with geometry %s. Consider using pull type %s.",
- epull_names[pcrd->eType],
- epullg_names[pcrd->eGeom],
- epull_names[epullUMBRELLA]);
+ warning_error(
+ wi,
+ gmx::formatString(
+ "pull-coord%d cannot have type 'constraint' and geometry 'transformation'",
+ coord_index_for_output));
}
- if (pcrd->eType == epullEXTERNAL)
+ /*Validate the mathematical expression to epullgTRANSFORMATION*/
+ if (pcrd->expression.empty())
+ {
+ warning_error(
+ wi, gmx::formatString("pull-coord%d-expression not set for pull coordinate of geometry 'transformation'", coord_index_for_output));
+ }
+ else if (pcrd->expression[0] == '"' || pcrd->expression[0] == '\'')
+ {
+ GMX_THROW(gmx::InvalidInputError(gmx::formatString(
+ "pull-coord%d-expression should not start with double quote or a quote",
+ coord_index_for_output)));
+ }
+ if (pcrd->dx == 0)
+ {
+ warning_error(
+ wi,
+ gmx::formatString(
+ "pull-coord%d-dx cannot be set to zero for pull coordinate of geometry "
+ "'transformation'",
+ coord_index_for_output));
+ }
+ /* make sure that the kappa of all previous pull coords is 0*/
+ int previousCoordOutputIndex = 0;
+ for (const auto& previousPcrd : pull.coord)
+ {
+ previousCoordOutputIndex++;
+ // See if the previous variable is used by the transformation coord
+ // Note that a simple std::string::find won't work since we don't want x1 to match x11 etc.
+ std::string previousPcrdName = gmx::formatString("x%d(\\D|$)", previousCoordOutputIndex);
+ std::regex rx(previousPcrdName);
+
+ std::ptrdiff_t number_of_matches = std::distance(
+ std::sregex_iterator(pcrd->expression.begin(), pcrd->expression.end(), rx),
+ std::sregex_iterator());
+
+ if (number_of_matches == 0)
+ {
+ // This previous coordinate is not used in this transformation, do not check it
+ continue;
+ }
+
+ if (previousPcrd.eType == PullingAlgorithm::Constraint)
+ {
+ warning_error(wi,
+ gmx::formatString("pull-coord%d can not use pull-coord%d in the "
+ "transformation since this is a "
+ "constraint",
+ coord_index_for_output,
+ previousCoordOutputIndex));
+ }
+ else if (previousPcrd.k != 0 && pcrd->k != 0)
+ {
+ warning_note(
+ wi,
+ gmx::formatString("pull-coord%d has a non-zero force constant and is also "
+ "referenced in pull-coord%d-expression. "
+ "Make sure that this is intended. "
+ "In most use cases, the pull coordinates referenced by a "
+ "transformation coordinate should have their force constant "
+ "set to zero.",
+ coord_index_for_output,
+ previousCoordOutputIndex));
+ }
+ }
+}
+
+static void init_pull_coord(t_pull_coord* pcrd,
+ char* dim_buf,
+ const char* origin_buf,
+ const char* vec_buf,
+ const pull_params_t& pull,
+ warninp_t wi)
+{
+ const int coord_index_for_output = pull.coord.size() + 1;
+
+ int m;
+ dvec origin, vec;
+ char buf[STRLEN];
+
+ if (pcrd->eType == PullingAlgorithm::Constraint
+ && (pcrd->eGeom == PullGroupGeometry::Cylinder || pcrd->eGeom == PullGroupGeometry::DirectionRelative
+ || pcrd->eGeom == PullGroupGeometry::Angle || pcrd->eGeom == PullGroupGeometry::AngleAxis
+ || pcrd->eGeom == PullGroupGeometry::Dihedral))
+ {
+ gmx_fatal(FARGS,
+ "Pulling of type %s can not be combined with geometry %s. Consider using pull "
+ "type %s.",
+ enumValueToString(pcrd->eType),
+ enumValueToString(pcrd->eGeom),
+ enumValueToString(PullingAlgorithm::Umbrella));
+ }
+
+ if (pcrd->eType == PullingAlgorithm::External)
{
if (pcrd->externalPotentialProvider[0] == '\0')
{
- sprintf(buf, "The use of pull type '%s' for pull coordinate %d requires that the name of the module providing the potential external is set with the option %s%d%s",
- epull_names[pcrd->eType], coord_index_for_output,
- "pull-coord", coord_index_for_output, "-potential-provider");
+ sprintf(buf,
+ "The use of pull type '%s' for pull coordinate %d requires that the name of "
+ "the module providing the potential external is set with the option %s%d%s",
+ enumValueToString(pcrd->eType),
+ coord_index_for_output,
+ "pull-coord",
+ coord_index_for_output,
+ "-potential-provider");
warning_error(wi, buf);
}
if (pcrd->rate != 0)
{
- sprintf(buf, "The use of pull type '%s' for pull coordinate %d requires that the pull rate is zero",
- epull_names[pcrd->eType], coord_index_for_output);
+ sprintf(buf,
+ "The use of pull type '%s' for pull coordinate %d requires that the pull rate "
+ "is zero",
+ enumValueToString(pcrd->eType),
+ coord_index_for_output);
warning_error(wi, buf);
}
- if (pcrd->eGeom == epullgCYL)
+ if (pcrd->eGeom == PullGroupGeometry::Cylinder)
{
/* Warn the user of a PBC restriction, caused by the fact that
* there is no reference value with an external pull potential.
*/
- sprintf(buf, "With pull type '%s' and geometry '%s', the distance component along the cylinder axis between atoms in the cylinder group and the COM of the pull group should be smaller than half the box length",
- epull_names[pcrd->eType], epullg_names[pcrd->eGeom]);
+ sprintf(buf,
+ "With pull type '%s' and geometry '%s', the distance component along the "
+ "cylinder axis between atoms in the cylinder group and the COM of the pull "
+ "group should be smaller than half the box length",
+ enumValueToString(pcrd->eType),
+ enumValueToString(pcrd->eGeom));
warning_note(wi, buf);
}
}
}
/* Check the given initial reference value and warn for dangerous values */
- if (pcrd->eGeom == epullgDIST)
+ if (pcrd->eGeom == PullGroupGeometry::Distance)
{
if (pcrd->bStart && pcrd->init < 0)
{
- sprintf(buf, "The initial reference distance set by pull-coord-init is set to a negative value (%g) with geometry %s while distances need to be non-negative. "
- "This may work, since you have set pull-coord-start to 'yes' which modifies this value, but only for certain starting distances. "
+ sprintf(buf,
+ "The initial reference distance set by pull-coord-init is set to a negative "
+ "value (%g) with geometry %s while distances need to be non-negative. "
+ "This may work, since you have set pull-coord-start to 'yes' which modifies "
+ "this value, but only for certain starting distances. "
"If this is a mistake you may want to use geometry %s instead.",
- pcrd->init, EPULLGEOM(pcrd->eGeom), EPULLGEOM(epullgDIR));
+ pcrd->init,
+ enumValueToString(pcrd->eGeom),
+ enumValueToString(PullGroupGeometry::Direction));
warning(wi, buf);
}
}
- else if (pcrd->eGeom == epullgANGLE || pcrd->eGeom == epullgANGLEAXIS)
+ else if (pcrd->eGeom == PullGroupGeometry::Angle || pcrd->eGeom == PullGroupGeometry::AngleAxis)
{
if (pcrd->bStart && (pcrd->init < 0 || pcrd->init > 180))
{
/* This value of pcrd->init may be ok depending on pcrd->bStart which modifies pcrd->init later on */
- sprintf(buf, "The initial reference angle set by pull-coord-init (%g) is outside of the allowed range [0, 180] degrees for geometry (%s). "
- "This may work, since you have set pull-coord-start to 'yes' which modifies this value, but only for certain starting angles.",
- pcrd->init, EPULLGEOM(pcrd->eGeom));
+ sprintf(buf,
+ "The initial reference angle set by pull-coord-init (%g) is outside of the "
+ "allowed range [0, 180] degrees for geometry (%s). "
+ "This may work, since you have set pull-coord-start to 'yes' which modifies "
+ "this value, but only for certain starting angles.",
+ pcrd->init,
+ enumValueToString(pcrd->eGeom));
warning(wi, buf);
}
}
- else if (pcrd->eGeom == epullgDIHEDRAL)
+ else if (pcrd->eGeom == PullGroupGeometry::Dihedral)
{
if (pcrd->bStart && (pcrd->init < -180 || pcrd->init > 180))
{
- sprintf(buf, "The initial reference angle set by pull-coord-init (%g) is outside of the allowed range [-180, 180] degrees for geometry (%s). "
- "This may work, since you have set pull-coord-start to 'yes' which modifies this value, but only for certain starting angles.",
- pcrd->init, EPULLGEOM(pcrd->eGeom));
+ sprintf(buf,
+ "The initial reference angle set by pull-coord-init (%g) is outside of the "
+ "allowed range [-180, 180] degrees for geometry (%s). "
+ "This may work, since you have set pull-coord-start to 'yes' which modifies "
+ "this value, but only for certain starting angles.",
+ pcrd->init,
+ enumValueToString(pcrd->eGeom));
warning(wi, buf);
}
}
clear_dvec(vec);
string2dvec(vec_buf, vec);
- if (pcrd->eGeom == epullgDIR || pcrd->eGeom == epullgCYL || pcrd->eGeom == epullgDIRPBC || pcrd->eGeom == epullgANGLEAXIS)
+ if (pcrd->eGeom == PullGroupGeometry::Direction || pcrd->eGeom == PullGroupGeometry::Cylinder
+ || pcrd->eGeom == PullGroupGeometry::DirectionPBC || pcrd->eGeom == PullGroupGeometry::AngleAxis)
{
if (dnorm2(vec) == 0)
{
- gmx_fatal(FARGS, "With pull geometry %s the pull vector can not be 0,0,0",
- epullg_names[pcrd->eGeom]);
+ gmx_fatal(FARGS,
+ "With pull geometry %s the pull vector can not be 0,0,0",
+ enumValueToString(pcrd->eGeom));
}
for (int d = 0; d < DIM; d++)
{
if (vec[d] != 0 && pcrd->dim[d] == 0)
{
- gmx_fatal(FARGS, "pull-coord-vec has non-zero %c-component while pull_dim for the %c-dimension is set to N", 'x'+d, 'x'+d);
+ gmx_fatal(FARGS,
+ "pull-coord-vec has non-zero %c-component while pull_dim for the "
+ "%c-dimension is set to N",
+ 'x' + d,
+ 'x' + d);
}
}
/* Normalize the direction vector */
- dsvmul(1/dnorm(vec), vec, vec);
+ dsvmul(1 / dnorm(vec), vec, vec);
}
else /* This case is for are all the geometries where the pull vector is not used */
{
if (dnorm2(vec) > 0)
{
- sprintf(buf, "A pull vector is given (%g %g %g) but will not be used with geometry %s. If you really want to use this "
+ sprintf(buf,
+ "A pull vector is given (%g %g %g) but will not be used with geometry %s. If "
+ "you really want to use this "
"vector, consider using geometry %s instead.",
- vec[0], vec[1], vec[2], EPULLGEOM(pcrd->eGeom),
- pcrd->eGeom == epullgANGLE ? EPULLGEOM(epullgANGLEAXIS) : EPULLGEOM(epullgDIR));
+ vec[0],
+ vec[1],
+ vec[2],
+ enumValueToString(pcrd->eGeom),
+ pcrd->eGeom == PullGroupGeometry::Angle
+ ? enumValueToString(PullGroupGeometry::AngleAxis)
+ : enumValueToString(PullGroupGeometry::Direction));
warning(wi, buf);
}
}
+ if (pcrd->eGeom == PullGroupGeometry::Transformation)
+ {
+ initTransformationPullCoord(pcrd, pull, wi);
+ }
+
for (m = 0; m < DIM; m++)
{
pcrd->origin[m] = origin[m];
}
}
-char **read_pullparams(std::vector<t_inpfile> *inp,
- pull_params_t *pull,
- warninp_t wi)
+std::vector<std::string> read_pullparams(std::vector<t_inpfile>* inp, pull_params_t* pull, warninp_t wi)
{
- int nscan, idum;
- char **grpbuf;
- char buf[STRLEN];
- char provider[STRLEN], groups[STRLEN], dim_buf[STRLEN];
- char wbuf[STRLEN], origin_buf[STRLEN], vec_buf[STRLEN];
-
- t_pull_group *pgrp;
- t_pull_coord *pcrd;
+ int nscan, idum;
+ char buf[STRLEN];
+ char provider[STRLEN], groups[STRLEN], dim_buf[STRLEN], expression[STRLEN];
+ char wbuf[STRLEN], origin_buf[STRLEN], vec_buf[STRLEN];
/* read pull parameters */
printStringNoNewline(inp, "Cylinder radius for dynamic reaction force groups (nm)");
pull->cylinder_r = get_ereal(inp, "pull-cylinder-r", 1.5, wi);
pull->constr_tol = get_ereal(inp, "pull-constr-tol", 1E-6, wi);
- pull->bPrintCOM = get_eeenum(inp, "pull-print-com", yesno_names, wi);
- pull->bPrintRefValue = get_eeenum(inp, "pull-print-ref-value", yesno_names, wi);
- pull->bPrintComp = get_eeenum(inp, "pull-print-components", yesno_names, wi);
+ pull->bPrintCOM = (getEnum<Boolean>(inp, "pull-print-com", wi) != Boolean::No);
+ pull->bPrintRefValue = (getEnum<Boolean>(inp, "pull-print-ref-value", wi) != Boolean::No);
+ pull->bPrintComp = (getEnum<Boolean>(inp, "pull-print-components", wi) != Boolean::No);
pull->nstxout = get_eint(inp, "pull-nstxout", 50, wi);
pull->nstfout = get_eint(inp, "pull-nstfout", 50, wi);
+ pull->bSetPbcRefToPrevStepCOM =
+ (getEnum<Boolean>(inp, "pull-pbc-ref-prev-step-com", wi) != Boolean::No);
+ pull->bXOutAverage = (getEnum<Boolean>(inp, "pull-xout-average", wi) != Boolean::No);
+ pull->bFOutAverage = (getEnum<Boolean>(inp, "pull-fout-average", wi) != Boolean::No);
printStringNoNewline(inp, "Number of pull groups");
pull->ngroup = get_eint(inp, "pull-ngroups", 1, wi);
printStringNoNewline(inp, "Number of pull coordinates");
gmx_fatal(FARGS, "pull-ncoords should be >= 1");
}
- snew(pull->group, pull->ngroup);
-
- snew(pull->coord, pull->ncoord);
-
/* pull group options */
printStringNoNewline(inp, "Group and coordinate parameters");
/* Read the pull groups */
- snew(grpbuf, pull->ngroup);
+ std::vector<std::string> pullGroups(pull->ngroup);
+ char readBuffer[STRLEN];
/* Group 0 is the absolute reference, we don't read anything for 0 */
+ pull->group.emplace_back(t_pull_group());
for (int groupNum = 1; groupNum < pull->ngroup; groupNum++)
{
- pgrp = &pull->group[groupNum];
- snew(grpbuf[groupNum], STRLEN);
+ t_pull_group pullGroup;
sprintf(buf, "pull-group%d-name", groupNum);
- setStringEntry(inp, buf, grpbuf[groupNum], "");
+ setStringEntry(inp, buf, readBuffer, "");
+ pullGroups[groupNum] = readBuffer;
sprintf(buf, "pull-group%d-weights", groupNum);
setStringEntry(inp, buf, wbuf, "");
sprintf(buf, "pull-group%d-pbcatom", groupNum);
- pgrp->pbcatom = get_eint(inp, buf, 0, wi);
+ pullGroup.pbcatom = get_eint(inp, buf, 0, wi);
+ pullGroup.pbcatom_input = pullGroup.pbcatom;
/* Initialize the pull group */
- init_pull_group(pgrp, wbuf);
+ pullGroup.weight = setupPullGroupWeights(wbuf);
+ pull->group.emplace_back(pullGroup);
}
/* Read the pull coordinates */
for (int coordNum = 1; coordNum < pull->ncoord + 1; coordNum++)
{
- pcrd = &pull->coord[coordNum - 1];
+ t_pull_coord pullCoord; // = &pull->coord[coordNum - 1];
sprintf(buf, "pull-coord%d-type", coordNum);
- pcrd->eType = get_eeenum(inp, buf, epull_names, wi);
+ pullCoord.eType = getEnum<PullingAlgorithm>(inp, buf, wi);
sprintf(buf, "pull-coord%d-potential-provider", coordNum);
setStringEntry(inp, buf, provider, "");
- pcrd->externalPotentialProvider = gmx_strdup(provider);
+ pullCoord.externalPotentialProvider = provider;
+ sprintf(buf, "pull-coord%d-expression", coordNum);
+ setStringEntry(inp, buf, expression, "");
+ pullCoord.expression = expression;
+ sprintf(buf, "pull-coord%d-dx", coordNum);
+ pullCoord.dx = get_ereal(inp, buf, 1e-9, wi);
sprintf(buf, "pull-coord%d-geometry", coordNum);
- pcrd->eGeom = get_eeenum(inp, buf, epullg_names, wi);
+ pullCoord.eGeom = getEnum<PullGroupGeometry>(inp, buf, wi);
sprintf(buf, "pull-coord%d-groups", coordNum);
setStringEntry(inp, buf, groups, "");
- switch (pcrd->eGeom)
+ switch (pullCoord.eGeom)
{
- case epullgDIHEDRAL:
- pcrd->ngroup = 6; break;
- case epullgDIRRELATIVE:
- case epullgANGLE:
- pcrd->ngroup = 4; break;
- default:
- pcrd->ngroup = 2; break;
+ case PullGroupGeometry::Dihedral: pullCoord.ngroup = 6; break;
+ case PullGroupGeometry::DirectionRelative:
+ case PullGroupGeometry::Angle: pullCoord.ngroup = 4; break;
+ case PullGroupGeometry::Transformation: pullCoord.ngroup = 0; break;
+ default: pullCoord.ngroup = 2; break;
}
- nscan = sscanf(groups, "%d %d %d %d %d %d %d",
- &pcrd->group[0], &pcrd->group[1], &pcrd->group[2], &pcrd->group[3],
- &pcrd->group[4], &pcrd->group[5], &idum);
- if (nscan != pcrd->ngroup)
+ nscan = sscanf(groups,
+ "%d %d %d %d %d %d %d",
+ &pullCoord.group[0],
+ &pullCoord.group[1],
+ &pullCoord.group[2],
+ &pullCoord.group[3],
+ &pullCoord.group[4],
+ &pullCoord.group[5],
+ &idum);
+ if (nscan < 0)
+ {
+ // If the groups are not defined we can get a negative value here.
+ // It makes more sense to change it to 0
+ nscan = 0;
+ }
+ if (nscan != pullCoord.ngroup)
{
- sprintf(wbuf, "%s should contain %d pull group indices with geometry %s",
- buf, pcrd->ngroup, epullg_names[pcrd->eGeom]);
+ auto message = gmx::formatString(
+ "%s should contain %d pull group indices with geometry %s."
+ " Found %d groups.",
+ buf,
+ pullCoord.ngroup,
+ enumValueToString(pullCoord.eGeom),
+ nscan);
set_warning_line(wi, nullptr, -1);
- warning_error(wi, wbuf);
+ warning_error(wi, message);
}
- for (int g = 0; g < pcrd->ngroup; g++)
+ for (int g = 0; g < pullCoord.ngroup; g++)
{
- if (pcrd->group[g] < 0 || pcrd->group[g] >= pull->ngroup)
+ if (pullCoord.group[g] < 0 || pullCoord.group[g] >= pull->ngroup)
{
/* Quit with a fatal error to avoid invalid memory access */
- gmx_fatal(FARGS, "%s contains an invalid pull group %d, you should have %d <= group <= %d",
- buf, pcrd->group[g], 0, pull->ngroup - 1);
+ gmx_fatal(FARGS,
+ "%s contains an invalid pull group %d, you should have %d <= group <= %d",
+ buf,
+ pullCoord.group[g],
+ 0,
+ pull->ngroup - 1);
}
}
sprintf(buf, "pull-coord%d-vec", coordNum);
setStringEntry(inp, buf, vec_buf, "0.0 0.0 0.0");
sprintf(buf, "pull-coord%d-start", coordNum);
- pcrd->bStart = get_eeenum(inp, buf, yesno_names, wi);
+ pullCoord.bStart = (getEnum<Boolean>(inp, buf, wi) != Boolean::No);
sprintf(buf, "pull-coord%d-init", coordNum);
- pcrd->init = get_ereal(inp, buf, 0.0, wi);
+ pullCoord.init = get_ereal(inp, buf, 0.0, wi);
sprintf(buf, "pull-coord%d-rate", coordNum);
- pcrd->rate = get_ereal(inp, buf, 0.0, wi);
+ pullCoord.rate = get_ereal(inp, buf, 0.0, wi);
sprintf(buf, "pull-coord%d-k", coordNum);
- pcrd->k = get_ereal(inp, buf, 0.0, wi);
+ pullCoord.k = get_ereal(inp, buf, 0.0, wi);
sprintf(buf, "pull-coord%d-kB", coordNum);
- pcrd->kB = get_ereal(inp, buf, pcrd->k, wi);
+ pullCoord.kB = get_ereal(inp, buf, pullCoord.k, wi);
/* Initialize the pull coordinate */
- init_pull_coord(pcrd, coordNum, dim_buf, origin_buf, vec_buf, wi);
+ init_pull_coord(&pullCoord, dim_buf, origin_buf, vec_buf, *pull, wi);
+
+ pullCoord.coordIndex = coordNum - 1;
+ pull->coord.emplace_back(pullCoord);
}
- return grpbuf;
+ return pullGroups;
}
-void make_pull_groups(pull_params_t *pull,
- char **pgnames,
- const t_blocka *grps, char **gnames)
+void process_pull_groups(gmx::ArrayRef<t_pull_group> pullGroups,
+ gmx::ArrayRef<const std::string> pullGroupNames,
+ const t_blocka* grps,
+ char** gnames)
{
- int g, ig = -1, i;
- t_pull_group *pgrp;
-
/* Absolute reference group (might not be used) is special */
- pgrp = &pull->group[0];
- pgrp->nat = 0;
- pgrp->pbcatom = -1;
+ pullGroups.front().pbcatom = -1;
+ pullGroups.front().pbcatom_input = -1;
- for (g = 1; g < pull->ngroup; g++)
+ // Skip pull group 0 here, as that is the absolute reference
+ for (int g = 1; g < int(pullGroups.size()); g++)
{
- pgrp = &pull->group[g];
+ auto& pullGroup = pullGroups[g];
- if (strcmp(pgnames[g], "") == 0)
+ if (pullGroupNames[g].empty())
{
gmx_fatal(FARGS, "Pull option pull_group%d required by grompp has not been set.", g);
}
- ig = search_string(pgnames[g], grps->nr, gnames);
- pgrp->nat = grps->index[ig+1] - grps->index[ig];
+ int ig = search_string(pullGroupNames[g].c_str(), grps->nr, gnames);
+ int numPullGroupAtoms = grps->index[ig + 1] - grps->index[ig];
- fprintf(stderr, "Pull group %d '%s' has %d atoms\n",
- g, pgnames[g], pgrp->nat);
+ fprintf(stderr, "Pull group %d '%s' has %d atoms\n", g, pullGroupNames[g].c_str(), numPullGroupAtoms);
- if (pgrp->nat == 0)
+ if (numPullGroupAtoms == 0)
{
- gmx_fatal(FARGS, "Pull group %d '%s' is empty", g, pgnames[g]);
+ gmx_fatal(FARGS, "Pull group %d '%s' is empty", g, pullGroupNames[g].c_str());
}
- snew(pgrp->ind, pgrp->nat);
- for (i = 0; i < pgrp->nat; i++)
+ for (int i = 0; i < numPullGroupAtoms; i++)
{
- pgrp->ind[i] = grps->a[grps->index[ig]+i];
+ pullGroup.ind.push_back(grps->a[grps->index[ig] + i]);
}
- if (pgrp->nweight > 0 && pgrp->nweight != pgrp->nat)
+ if (!pullGroup.weight.empty() && pullGroup.weight.size() != pullGroup.ind.size())
{
- gmx_fatal(FARGS, "Number of weights (%d) for pull group %d '%s' does not match the number of atoms (%d)",
- pgrp->nweight, g, pgnames[g], pgrp->nat);
+ gmx_fatal(FARGS,
+ "Number of weights (%ld) for pull group %d '%s' does not match the number of "
+ "atoms (%ld)",
+ gmx::ssize(pullGroup.weight),
+ g,
+ pullGroupNames[g].c_str(),
+ gmx::ssize(pullGroup.ind));
}
- if (pgrp->nat == 1)
+ pullGroup.pbcatom_input = pullGroup.pbcatom;
+ if (pullGroup.ind.size() == 1)
{
/* No pbc is required for this group */
- pgrp->pbcatom = -1;
+ pullGroup.pbcatom = -1;
}
else
{
- if (pgrp->pbcatom > 0)
+ if (pullGroup.pbcatom > 0)
{
- pgrp->pbcatom -= 1;
+ pullGroup.pbcatom -= 1;
}
- else if (pgrp->pbcatom == 0)
+ else if (pullGroup.pbcatom == 0)
{
- pgrp->pbcatom = pgrp->ind[(pgrp->nat-1)/2];
+ pullGroup.pbcatom = pullGroup.ind[(pullGroup.ind.size() - 1) / 2];
}
else
{
/* Use cosine weighting */
- pgrp->pbcatom = -1;
+ pullGroup.pbcatom = -1;
}
}
}
}
-void make_pull_coords(pull_params_t *pull)
+void checkPullCoords(gmx::ArrayRef<const t_pull_group> pullGroups, gmx::ArrayRef<const t_pull_coord> pullCoords)
{
- int c;
- t_pull_coord *pcrd;
-
- for (c = 0; c < pull->ncoord; c++)
+ for (int c = 0; c < pullCoords.ssize(); ++c)
{
- pcrd = &pull->coord[c];
+ const t_pull_coord& pcrd = pullCoords[c];
- if (pcrd->group[0] < 0 || pcrd->group[0] >= pull->ngroup ||
- pcrd->group[1] < 0 || pcrd->group[1] >= pull->ngroup)
+ GMX_RELEASE_ASSERT(pcrd.coordIndex == c, "coordIndex should match the index in the vector");
+
+ if (pcrd.eGeom == PullGroupGeometry::Transformation)
{
- gmx_fatal(FARGS, "Pull group index in pull-coord%d-groups out of range, should be between %d and %d", c+1, 0, pull->ngroup+1);
+ GMX_RELEASE_ASSERT(pcrd.ngroup == 0,
+ "Transformation coordinates don't use groups and "
+ "should have 'ngroup' set to zero");
+ continue;
+ }
+ if (pcrd.group[0] < 0 || pcrd.group[0] >= int(pullGroups.size()) || pcrd.group[1] < 0
+ || pcrd.group[1] >= int(pullGroups.size()))
+ {
+ gmx_fatal(FARGS,
+ "Pull group index in pull-coord%d-groups out of range, should be between %d "
+ "and %d",
+ pcrd.coordIndex + 1,
+ 0,
+ int(pullGroups.size()) + 1);
}
- if (pcrd->group[0] == pcrd->group[1])
+ if (pcrd.group[0] == pcrd.group[1])
{
- gmx_fatal(FARGS, "Identical pull group indices in pull-coord%d-groups", c+1);
+ gmx_fatal(FARGS, "Identical pull group indices in pull-coord%d-groups", pcrd.coordIndex + 1);
}
- if (pcrd->eGeom == epullgCYL)
+ if (pcrd.eGeom == PullGroupGeometry::Cylinder)
{
- if (pull->group[pcrd->group[0]].nweight > 0)
+ if (!pullGroups[pcrd.group[0]].weight.empty())
{
- gmx_fatal(FARGS, "Weights are not supported for the reference group with cylinder pulling");
+ gmx_fatal(
+ FARGS,
+ "Weights are not supported for the reference group with cylinder pulling");
}
}
+ c++;
}
}
-pull_t *set_pull_init(t_inputrec *ir, const gmx_mtop_t *mtop,
- rvec *x, matrix box, real lambda)
+pull_t* set_pull_init(t_inputrec* ir,
+ const gmx_mtop_t& mtop,
+ gmx::ArrayRef<const gmx::RVec> x,
+ matrix box,
+ real lambda,
+ warninp_t wi)
{
- pull_params_t *pull;
- pull_t *pull_work;
- t_pbc pbc;
- int c;
- double t_start;
-
- pull = ir->pull;
- pull_work = init_pull(nullptr, pull, ir, mtop, nullptr, lambda);
- auto mdAtoms = gmx::makeMDAtoms(nullptr, *mtop, *ir, false);
- auto md = mdAtoms->mdatoms();
- atoms2md(mtop, ir, -1, nullptr, mtop->natoms, mdAtoms.get());
- if (ir->efep)
+ pull_t* pull_work;
+ t_pbc pbc;
+
+ pull_params_t* pull = ir->pull.get();
+ gmx::LocalAtomSetManager atomSets;
+ pull_work = init_pull(nullptr, pull, ir, mtop, nullptr, &atomSets, lambda);
+ auto mdAtoms = gmx::makeMDAtoms(nullptr, mtop, *ir, false);
+ auto* md = mdAtoms->mdatoms();
+ atoms2md(mtop, *ir, -1, {}, mtop.natoms, mdAtoms.get());
+ if (ir->efep != FreeEnergyPerturbationType::No)
{
update_mdatoms(md, lambda);
}
- set_pbc(&pbc, ir->ePBC, box);
+ set_pbc(&pbc, ir->pbcType, box);
- t_start = ir->init_t + ir->init_step*ir->delta_t;
+ double t_start = ir->init_t + ir->init_step * ir->delta_t;
- pull_calc_coms(nullptr, pull_work, md, &pbc, t_start, x, nullptr);
+ if (pull->bSetPbcRefToPrevStepCOM)
+ {
+ initPullComFromPrevStep(nullptr, pull_work, gmx::arrayRefFromArray(md->massT, md->nr), pbc, x);
+ }
+ pull_calc_coms(nullptr, pull_work, gmx::arrayRefFromArray(md->massT, md->nr), pbc, t_start, x, {});
+
+ for (int g = 0; g < pull->ngroup; g++)
+ {
+ bool groupObeysPbc =
+ pullCheckPbcWithinGroup(*pull_work, x, pbc, g, c_pullGroupSmallGroupThreshold);
+ if (!groupObeysPbc)
+ {
+ char buf[STRLEN];
+ if (pull->group[g].pbcatom_input == 0)
+ {
+ sprintf(buf,
+ "When the maximum distance from a pull group reference atom to other atoms "
+ "in the "
+ "group is larger than %g times half the box size a centrally placed "
+ "atom should be chosen as pbcatom. Pull group %d is larger than that and "
+ "does not have "
+ "a specific atom selected as reference atom.",
+ c_pullGroupSmallGroupThreshold,
+ g);
+ warning_error(wi, buf);
+ }
+ else if (!pull->bSetPbcRefToPrevStepCOM)
+ {
+ sprintf(buf,
+ "The maximum distance from the chosen PBC atom (%d) of pull group %d to "
+ "other "
+ "atoms in the group is larger than %g times half the box size. "
+ "Set the pull-pbc-ref-prev-step-com option to yes.",
+ pull->group[g].pbcatom + 1,
+ g,
+ c_pullGroupSmallGroupThreshold);
+ warning_error(wi, buf);
+ }
+ }
+ if (groupObeysPbc)
+ {
+ groupObeysPbc = pullCheckPbcWithinGroup(*pull_work, x, pbc, g, c_pullGroupPbcMargin);
+ if (!groupObeysPbc)
+ {
+ char buf[STRLEN];
+ sprintf(buf,
+ "Pull group %d has atoms at a distance larger than %g times half the box "
+ "size from the PBC atom (%d). "
+ "If atoms are or will more beyond half the box size from the PBC atom, the "
+ "COM will be ill defined.",
+ g,
+ c_pullGroupPbcMargin,
+ pull->group[g].pbcatom + 1);
+ set_warning_line(wi, nullptr, -1);
+ warning(wi, buf);
+ }
+ }
+ }
fprintf(stderr, "Pull group natoms pbc atom distance at start reference at t=0\n");
- for (c = 0; c < pull->ncoord; c++)
+ for (int c = 0; c < pull->ncoord; c++)
{
- t_pull_coord *pcrd;
- t_pull_group *pgrp0, *pgrp1;
- double value;
- real init = 0;
+ real init = 0;
- pcrd = &pull->coord[c];
+ t_pull_coord* pcrd = &pull->coord[c];
- pgrp0 = &pull->group[pcrd->group[0]];
- pgrp1 = &pull->group[pcrd->group[1]];
- fprintf(stderr, "%8d %8d %8d\n",
- pcrd->group[0], pgrp0->nat, pgrp0->pbcatom+1);
- fprintf(stderr, "%8d %8d %8d ",
- pcrd->group[1], pgrp1->nat, pgrp1->pbcatom+1);
+ t_pull_group* pgrp0 = &pull->group[pcrd->group[0]];
+ t_pull_group* pgrp1 = &pull->group[pcrd->group[1]];
+ fprintf(stderr, "%8d %8zu %8d\n", pcrd->group[0], pgrp0->ind.size(), pgrp0->pbcatom + 1);
+ fprintf(stderr, "%8d %8zu %8d ", pcrd->group[1], pgrp1->ind.size(), pgrp1->pbcatom + 1);
if (pcrd->bStart)
{
pcrd->init = 0;
}
- value = get_pull_coord_value(pull_work, c, &pbc);
+ double value = get_pull_coord_value(pull_work, c, pbc);
- value *= pull_conversion_factor_internal2userinput(pcrd);
- fprintf(stderr, " %10.3f %s", value, pull_coordinate_units(pcrd));
+ value *= pull_conversion_factor_internal2userinput(*pcrd);
+ fprintf(stderr, " %10.3f %s", value, pull_coordinate_units(*pcrd));
if (pcrd->bStart)
{
pcrd->init = value + init;
}
- if (pcrd->eGeom == epullgDIST)
+ if (pcrd->eGeom == PullGroupGeometry::Distance)
{
if (pcrd->init < 0)
{
- gmx_fatal(FARGS, "The initial pull distance (%g) needs to be non-negative with geometry %s. If you want a signed distance, use geometry %s instead.",
- pcrd->init, EPULLGEOM(pcrd->eGeom), EPULLGEOM(epullgDIR));
+ gmx_fatal(FARGS,
+ "The initial pull distance (%g) needs to be non-negative with geometry "
+ "%s. If you want a signed distance, use geometry %s instead.",
+ pcrd->init,
+ enumValueToString(pcrd->eGeom),
+ enumValueToString(PullGroupGeometry::Direction));
}
/* TODO: With a positive init but a negative rate things could still
* generalization of the pull code makes pull dim available here.
*/
}
- else if (pcrd->eGeom == epullgANGLE || pcrd->eGeom == epullgANGLEAXIS)
+ else if (pcrd->eGeom == PullGroupGeometry::Angle || pcrd->eGeom == PullGroupGeometry::AngleAxis)
{
if (pcrd->init < 0 || pcrd->init > 180)
{
- gmx_fatal(FARGS, "The initial pull reference angle (%g) is outside of the allowed range [0, 180] degrees.", pcrd->init);
+ gmx_fatal(FARGS,
+ "The initial pull reference angle (%g) is outside of the allowed range "
+ "[0, 180] degrees.",
+ pcrd->init);
}
}
- else if (pcrd->eGeom == epullgDIHEDRAL)
+ else if (pcrd->eGeom == PullGroupGeometry::Dihedral)
{
if (pcrd->init < -180 || pcrd->init > 180)
{
- gmx_fatal(FARGS, "The initial pull reference angle (%g) is outside of the allowed range [-180, 180] degrees.",
+ gmx_fatal(FARGS,
+ "The initial pull reference angle (%g) is outside of the allowed range "
+ "[-180, 180] degrees.",
pcrd->init);
}
}
- fprintf(stderr, " %10.3f %s\n", pcrd->init, pull_coordinate_units(pcrd));
+ fprintf(stderr, " %10.3f %s\n", pcrd->init, pull_coordinate_units(*pcrd));
}
return pull_work;