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-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015,2017,2018 by the GROMACS development team.
7 * Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
8 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
9 * and including many others, as listed in the AUTHORS file in the
10 * top-level source directory and at http://www.gromacs.org.
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.
49 #include "gromacs/fileio/gmxfio.h"
50 #include "gromacs/gmxpreprocess/fflibutil.h"
51 #include "gromacs/gmxpreprocess/gpp_atomtype.h"
52 #include "gromacs/gmxpreprocess/grompp_impl.h"
53 #include "gromacs/gmxpreprocess/h_db.h"
54 #include "gromacs/gmxpreprocess/notset.h"
55 #include "gromacs/gmxpreprocess/toputil.h"
56 #include "gromacs/utility/cstringutil.h"
57 #include "gromacs/utility/fatalerror.h"
58 #include "gromacs/utility/futil.h"
59 #include "gromacs/utility/smalloc.h"
60 #include "gromacs/utility/strdb.h"
62 #include "hackblock.h"
65 /* use bonded types definitions in hackblock.h */
66 #define ekwRepl (ebtsNR + 1)
67 #define ekwAdd (ebtsNR + 2)
68 #define ekwDel (ebtsNR + 3)
70 static const char* kw_names[ekwNR] = { "replace", "add", "delete" };
72 static int find_kw(char* keyw)
76 for (i = 0; i < ebtsNR; i++)
78 if (gmx_strcasecmp(btsNames[i], keyw) == 0)
83 for (i = 0; i < ekwNR; i++)
85 if (gmx_strcasecmp(kw_names[i], keyw) == 0)
87 return ebtsNR + 1 + i;
94 #define FATAL() gmx_fatal(FARGS, "Reading Termini Database: not enough items on line\n%s", line)
96 static void read_atom(char* line, bool bAdd, std::string* nname, t_atom* a, PreprocessingAtomTypes* atype, int* cgnr)
102 /* This code is messy, because of support for different formats:
103 * for replace: [new name] <atom type> <m> <q> [cgnr (old format)]
104 * for add: <atom type> <m> <q> [cgnr]
106 nr = sscanf(line, "%s %s %s %s %s", buf[0], buf[1], buf[2], buf[3], buf[4]);
108 /* Here there an ambiguity due to the old replace format with cgnr,
109 * which was read for years, but ignored in the rest of the code.
110 * We have to assume that the atom type does not start with a digit
111 * to make a line with 4 entries uniquely interpretable.
113 if (!bAdd && nr == 4 && isdigit(buf[1][0]))
118 if (nr < 3 || nr > 4)
121 "Reading Termini Database: expected %d or %d items of atom data in stead of %d "
140 a->type = *atype->atomTypeFromName(buf[i++]);
141 sscanf(buf[i++], "%lf", &m);
143 sscanf(buf[i++], "%lf", &q);
147 sscanf(buf[i++], "%d", cgnr);
155 static void print_atom(FILE* out, const t_atom& a, PreprocessingAtomTypes* atype)
157 fprintf(out, "\t%s\t%g\t%g\n", *atype->atomNameFromAtomType(a.type), a.m, a.q);
160 static void print_ter_db(const char* ff,
162 gmx::ArrayRef<const MoleculePatchDatabase> tb,
163 PreprocessingAtomTypes* atype)
165 std::string buf = gmx::formatString("%s-%c.tdb", ff, C);
166 FILE* out = gmx_fio_fopen(buf.c_str(), "w");
168 for (const auto& modification : tb)
170 fprintf(out, "[ %s ]\n", modification.name.c_str());
172 if (std::any_of(modification.hack.begin(), modification.hack.end(), [](const auto& mod) {
173 return mod.type() == MoleculePatchType::Replace;
176 fprintf(out, "[ %s ]\n", kw_names[ekwRepl - ebtsNR - 1]);
177 for (const auto& hack : modification.hack)
179 if (hack.type() == MoleculePatchType::Replace)
181 fprintf(out, "%s\t", hack.oname.c_str());
182 print_atom(out, hack.atom.back(), atype);
186 if (std::any_of(modification.hack.begin(), modification.hack.end(), [](const auto& mod) {
187 return mod.type() == MoleculePatchType::Add;
190 fprintf(out, "[ %s ]\n", kw_names[ekwAdd - ebtsNR - 1]);
191 for (const auto& hack : modification.hack)
193 if (hack.type() == MoleculePatchType::Add)
195 print_ab(out, hack, hack.nname.c_str());
196 print_atom(out, hack.atom.back(), atype);
200 if (std::any_of(modification.hack.begin(), modification.hack.end(), [](const auto& mod) {
201 return mod.type() == MoleculePatchType::Delete;
204 fprintf(out, "[ %s ]\n", kw_names[ekwDel - ebtsNR - 1]);
205 for (const auto& hack : modification.hack)
207 if (hack.type() == MoleculePatchType::Delete)
209 fprintf(out, "%s\n", hack.oname.c_str());
213 for (int bt = 0; bt < ebtsNR; bt++)
215 if (!modification.rb[bt].b.empty())
217 fprintf(out, "[ %s ]\n", btsNames[bt]);
218 for (const auto& b : modification.rb[bt].b)
220 for (int k = 0; k < btsNiatoms[bt]; k++)
222 fprintf(out, "%s%s", k ? "\t" : "", b.a[k].c_str());
226 fprintf(out, "\t%s", b.s.c_str());
237 static void read_ter_db_file(const char* fn,
238 std::vector<MoleculePatchDatabase>* tbptr,
239 PreprocessingAtomTypes* atype)
241 char filebase[STRLEN];
242 char header[STRLEN], buf[STRLEN], line[STRLEN];
244 fflib_filename_base(fn, filebase, STRLEN);
245 /* Remove the C/N termini extension */
246 char* ptr = strrchr(filebase, '.');
252 FILE* in = fflib_open(fn);
255 get_a_line(in, line, STRLEN);
256 MoleculePatchDatabase* block = nullptr;
259 if (get_header(line, header))
261 /* this is a new block, or a new keyword */
262 kwnr = find_kw(header);
266 tbptr->emplace_back(MoleculePatchDatabase());
267 block = &tbptr->back();
268 clearModificationBlock(block);
269 block->name = header;
270 block->filebase = filebase;
275 if (block == nullptr)
278 "reading termini database: "
279 "directive expected before line:\n%s\n"
280 "This might be a file in an old format.",
283 /* this is not a header, so it must be data */
286 /* this is a hack: add/rename/delete atoms */
287 /* make space for hacks */
288 block->hack.emplace_back(MoleculePatch());
289 MoleculePatch* hack = &block->hack.back();
293 if (kwnr == ekwRepl || kwnr == ekwDel)
295 if (sscanf(line, "%s%n", buf, &n) != 1)
298 "Reading Termini Database '%s': "
299 "expected atom name on line\n%s",
304 /* we only replace or delete one atom at a time */
307 else if (kwnr == ekwAdd)
309 read_ab(line, fn, hack);
310 get_a_line(in, line, STRLEN);
314 gmx_fatal(FARGS, "unimplemented keyword number %d (%s:%d)", kwnr, __FILE__, __LINE__);
316 if (kwnr == ekwRepl || kwnr == ekwAdd)
318 hack->atom.emplace_back();
319 read_atom(line + n, kwnr == ekwAdd, &hack->nname, &hack->atom.back(), atype, &hack->cgnr);
320 if (hack->nname.empty())
322 if (!hack->oname.empty())
324 hack->nname = hack->oname;
329 "Reading Termini Database '%s': don't know which name the "
330 "new atom should have on line\n%s",
337 else if (kwnr >= 0 && kwnr < ebtsNR)
339 /* this is bonded data: bonds, angles, dihedrals or impropers */
341 block->rb[kwnr].b.emplace_back();
342 BondedInteraction* newBond = &block->rb[kwnr].b.back();
343 for (int j = 0; j < btsNiatoms[kwnr]; j++)
346 if (sscanf(line + n, "%s%n", buf, &ni) == 1)
353 "Reading Termini Database '%s': expected %d atom names (found "
363 sscanf(line + n, "%s", buf);
369 "Reading Termini Database: Expecting a header at line\n"
374 get_a_line(in, line, STRLEN);
380 int read_ter_db(const char* ffdir, char ter, std::vector<MoleculePatchDatabase>* tbptr, PreprocessingAtomTypes* atype)
382 std::string ext = gmx::formatString(".%c.tdb", ter);
384 /* Search for termini database files.
385 * Do not generate an error when none are found.
387 std::vector<std::string> tdbf = fflib_search_file_end(ffdir, ext.c_str(), FALSE);
389 for (const auto& filename : tdbf)
391 read_ter_db_file(filename.c_str(), tbptr, atype);
396 print_ter_db("new", ter, *tbptr, atype);
399 return tbptr->size();
402 std::vector<MoleculePatchDatabase*> filter_ter(gmx::ArrayRef<MoleculePatchDatabase> tb, const char* resname)
404 // TODO Four years later, no force fields have ever used this, so decide status of this feature
405 /* Since some force fields (e.g. OPLS) needs different
406 * atomtypes for different residues there could be a lot
407 * of entries in the databases for specific residues
408 * (e.g. GLY-NH3+, SER-NH3+, ALA-NH3+).
410 * To reduce the database size, we assume that a terminus specifier liker
412 * [ GLY|SER|ALA-NH3+ ]
414 * would cover all of the three residue types above.
415 * Wildcards (*,?) are not OK. Don't worry about e.g. GLU vs. GLUH since
416 * pdb2gmx only uses the first 3 letters when calling this routine.
418 * To automate this, this routines scans a list of termini
419 * for the residue name "resname" and returns an allocated list of
420 * pointers to the termini that could be applied to the
421 * residue in question. The variable pointed to by nret will
422 * contain the number of valid pointers in the list.
423 * Remember to free the list when you are done with it...
426 auto none_idx = tb.end();
427 std::vector<MoleculePatchDatabase*> list;
429 for (auto it = tb.begin(); it != tb.end(); it++)
431 const char* s = it->name.c_str();
435 if (gmx::equalCaseInsensitive(resname, s, 3))
438 list.push_back(&*it);
442 /* advance to next |-separated field */
449 } while (!found && s != nullptr);
452 /* All residue-specific termini have been added. We might have to fall
453 * back on generic termini, which are characterized by not having
454 * '-' in the name prior to the last position (which indicates charge).
455 * The [ None ] alternative is special since we don't want that
456 * to be the default, so we put it last in the list we return.
458 for (auto it = tb.begin(); it != tb.end(); it++)
460 const char* s = it->name.c_str();
461 if (gmx::equalCaseInsensitive("None", it->name))
467 /* Time to see if there's a generic terminus that matches.
468 Is there a hyphen? */
469 const char* c = strchr(s, '-');
471 /* A conjunction hyphen normally indicates a residue-specific
472 terminus, which is named like "GLY-COOH". A generic terminus
473 won't have a hyphen. */
474 bool bFoundAnyHyphen = (c != nullptr);
475 /* '-' as the last character indicates charge, so if that's
476 the only one found e.g. "COO-", then it was not a conjunction
477 hyphen, so this is a generic terminus */
478 bool bOnlyFoundChargeHyphen = (bFoundAnyHyphen && *(c + 1) == '\0');
479 /* Thus, "GLY-COO-" is not recognized as a generic terminus. */
480 bool bFoundGenericTerminus = !bFoundAnyHyphen || bOnlyFoundChargeHyphen;
481 if (bFoundGenericTerminus)
483 /* Check that we haven't already added a residue-specific version
486 auto found = std::find_if(list.begin(), list.end(), [&s](const MoleculePatchDatabase* b) {
487 return strstr(b->name.c_str(), s) != nullptr;
489 if (found == list.end())
491 list.push_back(&*it);
496 if (none_idx != tb.end())
498 list.push_back(&*none_idx);
505 MoleculePatchDatabase* choose_ter(gmx::ArrayRef<MoleculePatchDatabase*> tb, const char* title)
509 printf("%s\n", title);
511 for (const auto& modification : tb)
513 bool bIsZwitterion = (0 == gmx_wcmatch("*ZWITTERION*", modification->name.c_str()));
514 printf("%2d: %s%s\n",
516 modification->name.c_str(),
517 bIsZwitterion ? " (only use with zwitterions containing exactly one residue)" : "");
522 ret = fscanf(stdin, "%d", &sel);
523 } while ((ret != 1) || (sel < 0) || (sel >= tb.ssize()));