src/gromacs/gmxpreprocess/genrestr.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2017,2018 by the GROMACS development team.
   7  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #include "gmxpre.h"
  39
  40 #include "genrestr.h"
  41
  42 #include <cmath>
  43 #include <cstring>
  44
  45 #include <algorithm>
  46
  47 #include "gromacs/commandline/pargs.h"
  48 #include "gromacs/fileio/confio.h"
  49 #include "gromacs/math/vec.h"
  50 #include "gromacs/topology/index.h"
  51 #include "gromacs/topology/mtop_util.h"
  52 #include "gromacs/topology/topology.h"
  53 #include "gromacs/utility/arraysize.h"
  54 #include "gromacs/utility/cstringutil.h"
  55 #include "gromacs/utility/fatalerror.h"
  56 #include "gromacs/utility/futil.h"
  57 #include "gromacs/utility/smalloc.h"
  58
  59 int gmx_genrestr(int argc, char* argv[])
  60 {
  61     const char* desc[] = {
  62         "[THISMODULE] produces an #include file for a topology containing",
  63         "a list of atom numbers and three force constants for the",
  64         "[IT]x[it]-, [IT]y[it]-, and [IT]z[it]-direction based on",
  65         "the contents of the [TT]-f[tt] file. A single isotropic force constant may",
  66         "be given on the command line instead of three components.[PAR]",
  67         "WARNING: Position restraints are interactions within molecules, therefore",
  68         "they must be included within the correct [TT][ moleculetype ][tt]",
  69         "block in the topology. The atom indices within the",
  70         "[TT][ position_restraints ][tt] block must be within the range of the",
  71         "atom indices for that molecule type. Since the atom numbers in every",
  72         "moleculetype in the topology start at 1 and the numbers in the input file",
  73         "for [THISMODULE] number consecutively from 1, [THISMODULE] will only",
  74         "produce a useful file for the first molecule. You may wish to",
  75         "edit the resulting index file to remove the lines for later atoms,",
  76         "or construct a suitable index group to provide",
  77         "as input to [THISMODULE].[PAR]",
  78         "The [TT]-of[tt] option produces an index file that can be used for",
  79         "freezing atoms. In this case, the input file must be a [REF].pdb[ref] file.[PAR]",
  80         "With the [TT]-disre[tt] option, half a matrix of distance restraints",
  81         "is generated instead of position restraints. With this matrix, that",
  82         "one typically would apply to C[GRK]alpha[grk] atoms in a protein, one can",
  83         "maintain the overall conformation of a protein without tieing it to",
  84         "a specific position (as with position restraints)."
  85     };
  86     static rvec     fc           = { 1000.0, 1000.0, 1000.0 };
  87     static real     freeze_level = 0.0;
  88     static real     disre_dist   = 0.1;
  89     static real     disre_frac   = 0.0;
  90     static real     disre_up2    = 1.0;
  91     static gmx_bool bDisre       = FALSE;
  92     static gmx_bool bConstr      = FALSE;
  93     static real     cutoff       = -1.0;
  94
  95     t_pargs pa[] = {
  96         { "-fc", FALSE, etRVEC, { fc }, "Force constants (kJ/mol nm^2)" },
  97         { "-freeze",
  98           FALSE,
  99           etREAL,
 100           { &freeze_level },
 101           "If the [TT]-of[tt] option or this one is given an index file will be written containing "
 102           "atom numbers of all atoms that have a B-factor less than the level given here" },
 103         { "-disre",
 104           FALSE,
 105           etBOOL,
 106           { &bDisre },
 107           "Generate a distance restraint matrix for all the atoms in index" },
 108         { "-disre_dist",
 109           FALSE,
 110           etREAL,
 111           { &disre_dist },
 112           "Distance range around the actual distance for generating distance restraints" },
 113         { "-disre_frac",
 114           FALSE,
 115           etREAL,
 116           { &disre_frac },
 117           "Fraction of distance to be used as interval rather than a fixed distance. If the "
 118           "fraction of the distance that you specify here is less than the distance given in the "
 119           "previous option, that one is used instead." },
 120         { "-disre_up2",
 121           FALSE,
 122           etREAL,
 123           { &disre_up2 },
 124           "Distance between upper bound for distance restraints, and the distance at which the "
 125           "force becomes constant (see manual)" },
 126         { "-cutoff",
 127           FALSE,
 128           etREAL,
 129           { &cutoff },
 130           "Only generate distance restraints for atoms pairs within cutoff (nm)" },
 131         { "-constr",
 132           FALSE,
 133           etBOOL,
 134           { &bConstr },
 135           "Generate a constraint matrix rather than distance restraints. Constraints of type 2 "
 136           "will be generated that do generate exclusions." }
 137     };
 138 #define npargs asize(pa)
 139
 140     gmx_output_env_t* oenv;
 141     t_atoms           atoms;
 142     int               i, j, k;
 143     FILE*             out;
 144     int               igrp;
 145     real              d, dd, lo, hi;
 146     int*              ind_grp;
 147     const char *      xfn, *nfn;
 148     char*             gn_grp;
 149     matrix            box;
 150     gmx_bool          bFreeze;
 151     rvec              dx, *x = nullptr, *v = nullptr;
 152
 153     t_filenm fnm[] = { { efSTX, "-f", nullptr, ffREAD },
 154                        { efNDX, "-n", nullptr, ffOPTRD },
 155                        { efITP, "-o", "posre", ffWRITE },
 156                        { efNDX, "-of", "freeze", ffOPTWR } };
 157 #define NFILE asize(fnm)
 158
 159     if (!parse_common_args(&argc, argv, 0, NFILE, fnm, npargs, pa, asize(desc), desc, 0, nullptr, &oenv))
 160     {
 161         return 0;
 162     }
 163
 164     bFreeze = opt2bSet("-of", NFILE, fnm) || opt2parg_bSet("-freeze", asize(pa), pa);
 165     bDisre  = bDisre || opt2parg_bSet("-disre_dist", npargs, pa);
 166     xfn     = opt2fn_null("-f", NFILE, fnm);
 167     nfn     = opt2fn_null("-n", NFILE, fnm);
 168
 169     if ((nfn == nullptr) && (xfn == nullptr))
 170     {
 171         gmx_fatal(FARGS, "no index file and no structure file supplied");
 172     }
 173
 174     if ((disre_frac < 0) || (disre_frac >= 1))
 175     {
 176         gmx_fatal(FARGS, "disre_frac should be between 0 and 1");
 177     }
 178     if (disre_dist < 0)
 179     {
 180         gmx_fatal(FARGS, "disre_dist should be >= 0");
 181     }
 182
 183     const char* title        = "";
 184     bool        haveTopology = false;
 185     if (xfn != nullptr)
 186     {
 187         fprintf(stderr, "\nReading structure file\n");
 188         gmx_mtop_t mtop;
 189         readConfAndTopology(xfn, &haveTopology, &mtop, nullptr, &x, &v, box);
 190         title = *mtop.name;
 191         atoms = gmx_mtop_global_atoms(&mtop);
 192         if (atoms.pdbinfo == nullptr)
 193         {
 194             snew(atoms.pdbinfo, atoms.nr);
 195         }
 196         haveTopology = true;
 197     }
 198
 199     if (bFreeze)
 200     {
 201         if (!haveTopology || !atoms.pdbinfo)
 202         {
 203             gmx_fatal(FARGS, "No B-factors in input file %s, use a pdb file next time.", xfn);
 204         }
 205
 206         out = opt2FILE("-of", NFILE, fnm, "w");
 207         fprintf(out, "[ freeze ]\n");
 208         for (i = 0; (i < atoms.nr); i++)
 209         {
 210             if (atoms.pdbinfo[i].bfac <= freeze_level)
 211             {
 212                 fprintf(out, "%d\n", i + 1);
 213             }
 214         }
 215         gmx_ffclose(out);
 216     }
 217     else if ((bDisre || bConstr) && x)
 218     {
 219         printf("Select group to generate %s matrix from\n", bConstr ? "constraint" : "distance restraint");
 220         get_index(&atoms, nfn, 1, &igrp, &ind_grp, &gn_grp);
 221
 222         out = ftp2FILE(efITP, NFILE, fnm, "w");
 223         if (bConstr)
 224         {
 225             fprintf(out, "; constraints for %s of %s\n\n", gn_grp, title);
 226             fprintf(out, "[ constraints ]\n");
 227             fprintf(out, ";%4s %5s %1s %10s\n", "i", "j", "tp", "dist");
 228         }
 229         else
 230         {
 231             fprintf(out, "; distance restraints for %s of %s\n\n", gn_grp, title);
 232             fprintf(out, "[ distance_restraints ]\n");
 233             fprintf(out, ";%4s %5s %1s %5s %10s %10s %10s %10s %10s\n", "i", "j", "?", "label",
 234                     "funct", "lo", "up1", "up2", "weight");
 235         }
 236         for (i = k = 0; i < igrp; i++)
 237         {
 238             for (j = i + 1; j < igrp; j++, k++)
 239             {
 240                 rvec_sub(x[ind_grp[i]], x[ind_grp[j]], dx);
 241                 d = norm(dx);
 242                 if (bConstr)
 243                 {
 244                     fprintf(out, "%5d %5d %1d %10g\n", ind_grp[i] + 1, ind_grp[j] + 1, 2, d);
 245                 }
 246                 else
 247                 {
 248                     if (cutoff < 0 || d < cutoff)
 249                     {
 250                         if (disre_frac > 0)
 251                         {
 252                             dd = std::min(disre_dist, disre_frac * d);
 253                         }
 254                         else
 255                         {
 256                             dd = disre_dist;
 257                         }
 258                         lo = std::max(0.0_real, d - dd);
 259                         hi = d + dd;
 260                         fprintf(out, "%5d %5d %1d %5d %10d %10g %10g %10g %10g\n", ind_grp[i] + 1,
 261                                 ind_grp[j] + 1, 1, k, 1, lo, hi, hi + disre_up2, 1.0);
 262                     }
 263                 }
 264             }
 265         }
 266         gmx_ffclose(out);
 267     }
 268     else
 269     {
 270         printf("Select group to position restrain\n");
 271         get_index(&atoms, nfn, 1, &igrp, &ind_grp, &gn_grp);
 272
 273         out = ftp2FILE(efITP, NFILE, fnm, "w");
 274         fprintf(out, "; position restraints for %s of %s\n\n", gn_grp, title);
 275         fprintf(out, "[ position_restraints ]\n");
 276         fprintf(out, ";%3s %5s %9s %10s %10s\n", "i", "funct", "fcx", "fcy", "fcz");
 277         for (i = 0; i < igrp; i++)
 278         {
 279             fprintf(out, "%4d %4d %10g %10g %10g\n", ind_grp[i] + 1, 1, fc[XX], fc[YY], fc[ZZ]);
 280         }
 281         gmx_ffclose(out);
 282     }
 283     if (xfn)
 284     {
 285         sfree(x);
 286         sfree(v);
 287         done_atom(&atoms);
 288     }
 289
 290     return 0;
 291 }