src/gromacs/trajectoryanalysis/modules/freevolume.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2015, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements gmx::analysismodules::Freevolume.
  38  *
  39  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  40  * \ingroup module_trajectoryanalysis
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "freevolume.h"
  45
  46 #include <string>
  47
  48 #include "gromacs/analysisdata/analysisdata.h"
  49 #include "gromacs/analysisdata/modules/average.h"
  50 #include "gromacs/analysisdata/modules/plot.h"
  51 #include "gromacs/fileio/trx.h"
  52 #include "gromacs/legacyheaders/copyrite.h"
  53 #include "gromacs/math/vec.h"
  54 #include "gromacs/options/basicoptions.h"
  55 #include "gromacs/options/filenameoption.h"
  56 #include "gromacs/options/options.h"
  57 #include "gromacs/pbcutil/pbc.h"
  58 #include "gromacs/random/random.h"
  59 #include "gromacs/selection/nbsearch.h"
  60 #include "gromacs/selection/selection.h"
  61 #include "gromacs/selection/selectionoption.h"
  62 #include "gromacs/topology/atomprop.h"
  63 #include "gromacs/topology/topology.h"
  64 #include "gromacs/trajectoryanalysis/analysissettings.h"
  65 #include "gromacs/utility/arrayref.h"
  66 #include "gromacs/utility/exceptions.h"
  67
  68 namespace gmx
  69 {
  70
  71 namespace analysismodules
  72 {
  73
  74 namespace
  75 {
  76
  77 /*! \brief
  78  * Class used to compute free volume in a simulations box.
  79  *
  80  * Inherits TrajectoryAnalysisModule and all functions from there.
  81  * Does not implement any new functionality.
  82  *
  83  * \ingroup module_trajectoryanalysis
  84  */
  85 class FreeVolume : public TrajectoryAnalysisModule
  86 {
  87     public:
  88         //! Constructor
  89         FreeVolume();
  90
  91         //! Destructor
  92         virtual ~FreeVolume();
  93
  94         //! Set the options and setting
  95         virtual void initOptions(Options                    *options,
  96                                  TrajectoryAnalysisSettings *settings);
  97
  98         //! First routine called by the analysis framework
  99         virtual void initAnalysis(const TrajectoryAnalysisSettings &settings,
 100                                   const TopologyInformation        &top);
 101
 102         //! Call for each frame of the trajectory
 103         virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
 104                                   TrajectoryAnalysisModuleData *pdata);
 105
 106         //! Last routine called by the analysis framework
 107         virtual void finishAnalysis(int nframes);
 108
 109         //! Routine to write output, that is additional over the built-in
 110         virtual void writeOutput();
 111
 112     private:
 113         std::string                       fnFreevol_;
 114         Selection                         sel_;
 115         AnalysisData                      data_;
 116         AnalysisDataAverageModulePointer  adata_;
 117
 118         int                               nmol_;
 119         double                            mtot_;
 120         double                            cutoff_;
 121         double                            probeRadius_;
 122         gmx_rng_t                         rng_;
 123         int                               seed_, ninsert_;
 124         AnalysisNeighborhood              nb_;
 125         //! The van der Waals radius per atom
 126         std::vector<double>               vdw_radius_;
 127
 128         // Copy and assign disallowed by base.
 129 };
 130
 131 // Constructor. Here it is important to initialize the pointer to
 132 // subclasses that are elements of the main class. Here we have only
 133 // one. The type of this depends on what kind of tool you need.
 134 // Here we only have simple value/time kind of data.
 135 FreeVolume::FreeVolume()
 136     : TrajectoryAnalysisModule(FreeVolumeInfo::name, FreeVolumeInfo::shortDescription),
 137       adata_(new AnalysisDataAverageModule())
 138 {
 139     // We only compute two numbers per frame
 140     data_.setColumnCount(0, 2);
 141     // Tell the analysis framework that this component exists
 142     registerAnalysisDataset(&data_, "freevolume");
 143     rng_         = NULL;
 144     nmol_        = 0;
 145     mtot_        = 0;
 146     cutoff_      = 0;
 147     probeRadius_ = 0;
 148     seed_        = -1;
 149     ninsert_     = 1000;
 150 }
 151
 152
 153 FreeVolume::~FreeVolume()
 154 {
 155     // Destroy C structures where there is no automatic memory release
 156     // C++ takes care of memory in classes (hopefully)
 157     if (NULL != rng_)
 158     {
 159         gmx_rng_destroy(rng_);
 160     }
 161 }
 162
 163
 164 void
 165 FreeVolume::initOptions(Options                    *options,
 166                         TrajectoryAnalysisSettings *settings)
 167 {
 168     static const char *const desc[] = {
 169         "[THISMODULE] calculates the free volume in a box as",
 170         "a function of time. The free volume is",
 171         "plotted as a fraction of the total volume.",
 172         "The program tries to insert a probe with a given radius,",
 173         "into the simulations box and if the distance between the",
 174         "probe and any atom is less than the sums of the",
 175         "van der Waals radii of both atoms, the position is",
 176         "considered to be occupied, i.e. non-free. By using a",
 177         "probe radius of 0, the true free volume is computed.",
 178         "By using a larger radius, e.g. 0.14 nm, roughly corresponding",
 179         "to a water molecule, the free volume for a hypothetical",
 180         "particle with that size will be produced.",
 181         "Note however, that since atoms are treated as hard-spheres",
 182         "these number are very approximate, and typically only",
 183         "relative changes are meaningful, for instance by doing a",
 184         "series of simulations at different temperature.[PAR]",
 185         "The group specified by the selection is considered to",
 186         "delineate non-free volume.",
 187         "The number of insertions per unit of volume is important",
 188         "to get a converged result. About 1000/nm^3 yields an overall",
 189         "standard deviation that is determined by the fluctuations in",
 190         "the trajectory rather than by the fluctuations due to the",
 191         "random numbers.[PAR]",
 192         "The results are critically dependent on the van der Waals radii;",
 193         "we recommend to use the values due to Bondi (1964).[PAR]",
 194         "The Fractional Free Volume (FFV) that some authors like to use",
 195         "is given by 1 - 1.3*(1-Free Volume). This value is printed on",
 196         "the terminal."
 197     };
 198
 199     // Add the descriptive text (program help text) to the options
 200     options->setDescription(desc);
 201
 202     // Add option for optional output file
 203     options->addOption(FileNameOption("o").filetype(eftPlot).outputFile()
 204                            .store(&fnFreevol_).defaultBasename("freevolume")
 205                            .description("Computed free volume"));
 206
 207     // Add option for selecting a subset of atoms
 208     options->addOption(SelectionOption("select")
 209                            .store(&sel_).defaultSelectionText("all")
 210                            .onlyAtoms()
 211                            .description("Atoms that are considered as part of the excluded volume"));
 212
 213     // Add option for the probe radius and initialize it
 214     options->addOption(DoubleOption("radius").store(&probeRadius_)
 215                            .description("Radius of the probe to be inserted (nm, 0 yields the true free volume)"));
 216
 217     // Add option for the random number seed and initialize it to
 218     // generate a value automatically
 219     options->addOption(IntegerOption("seed").store(&seed_)
 220                            .description("Seed for random number generator."));
 221
 222     // Add option to determine number of insertion trials per frame
 223     options->addOption(IntegerOption("ninsert").store(&ninsert_)
 224                            .description("Number of probe insertions per cubic nm to try for each frame in the trajectory."));
 225
 226     // Control input settings
 227     settings->setFlags(TrajectoryAnalysisSettings::efRequireTop |
 228                        TrajectoryAnalysisSettings::efNoUserPBC);
 229     settings->setPBC(true);
 230 }
 231
 232
 233 void
 234 FreeVolume::initAnalysis(const TrajectoryAnalysisSettings &settings,
 235                          const TopologyInformation        &top)
 236 {
 237     // Add the module that will contain the averaging and the time series
 238     // for our calculation
 239     data_.addModule(adata_);
 240
 241     // Add a module for plotting the data automatically at the end of
 242     // the calculation. With this in place you only have to add data
 243     // points to the data et.
 244     AnalysisDataPlotModulePointer plotm_(new AnalysisDataPlotModule());
 245     plotm_->setSettings(settings.plotSettings());
 246     plotm_->setFileName(fnFreevol_);
 247     plotm_->setTitle("Free Volume");
 248     plotm_->setXAxisIsTime();
 249     plotm_->setYLabel("Free Volume (%)");
 250     plotm_->appendLegend("Free Volume");
 251     plotm_->appendLegend("Volume");
 252
 253     data_.addModule(plotm_);
 254
 255     // Initiate variable
 256     cutoff_               = 0;
 257     int            nnovdw = 0;
 258     gmx_atomprop_t aps    = gmx_atomprop_init();
 259     t_atoms       *atoms  = &(top.topology()->atoms);
 260
 261     // Compute total mass
 262     mtot_ = 0;
 263     for (int i = 0; (i < atoms->nr); i++)
 264     {
 265         mtot_ += atoms->atom[i].m;
 266     }
 267
 268     // Extracts number of molecules
 269     nmol_ = top.topology()->mols.nr;
 270
 271     // Loop over atoms in the selection using an iterator
 272     const int          maxnovdw = 10;
 273     ConstArrayRef<int> atomind  = sel_.atomIndices();
 274     for (ConstArrayRef<int>::iterator ai = atomind.begin(); (ai < atomind.end()); ++ai)
 275     {
 276         // Dereference the iterator to obtain an atom number
 277         int  i = *ai;
 278         real value;
 279
 280         // Lookup the Van der Waals radius of this atom
 281         int resnr = atoms->atom[i].resind;
 282         if (TRUE == gmx_atomprop_query(aps, epropVDW,
 283                                        *(atoms->resinfo[resnr].name),
 284                                        *(atoms->atomname[i]),
 285                                        &value))
 286         {
 287             vdw_radius_.push_back(value);
 288             if (value > cutoff_)
 289             {
 290                 cutoff_ = value;
 291             }
 292         }
 293         else
 294         {
 295             nnovdw++;
 296             if (nnovdw < maxnovdw)
 297             {
 298                 fprintf(stderr, "Could not determine VDW radius for %s-%s. Set to zero.\n",
 299                         *(atoms->resinfo[resnr].name),
 300                         *(atoms->atomname[i]));
 301             }
 302             vdw_radius_.push_back(0.0);
 303         }
 304     }
 305     gmx_atomprop_destroy(aps);
 306
 307     // Increase cutoff by proberadius to make sure we do not miss
 308     // anything
 309     cutoff_ += probeRadius_;
 310
 311     if (nnovdw >= maxnovdw)
 312     {
 313         fprintf(stderr, "Could not determine VDW radius for %d particles. These were set to zero.\n", nnovdw);
 314     }
 315
 316     // Print parameters to output. Maybe should make dependent on
 317     // verbosity flag?
 318     printf("cutoff       = %g nm\n", cutoff_);
 319     printf("probe_radius = %g nm\n", probeRadius_);
 320     printf("seed         = %d\n", seed_);
 321     printf("ninsert      = %d probes per nm^3\n", ninsert_);
 322
 323     // Initiate the random number generator
 324     rng_ = gmx_rng_init(seed_);
 325
 326     // Initiate the neighborsearching code
 327     nb_.setCutoff(cutoff_);
 328 }
 329
 330 void
 331 FreeVolume::analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
 332                          TrajectoryAnalysisModuleData *pdata)
 333 {
 334     AnalysisDataHandle       dh   = pdata->dataHandle(data_);
 335     const Selection         &sel  = pdata->parallelSelection(sel_);
 336
 337     GMX_RELEASE_ASSERT(NULL != pbc, "You have no periodic boundary conditions");
 338
 339     // Analysis framework magic
 340     dh.startFrame(frnr, fr.time);
 341
 342     // Compute volume and number of insertions to perform
 343     real V       = det(fr.box);
 344     int  Ninsert = static_cast<int>(ninsert_*V);
 345
 346     // Use neighborsearching tools!
 347     AnalysisNeighborhoodSearch nbsearch = nb_.initSearch(pbc, sel);
 348
 349     // Then loop over insertions
 350     int NinsTot = 0;
 351     for (int i = 0; (i < Ninsert); i++)
 352     {
 353         rvec rand, ins, dx;
 354
 355         for (int m = 0; (m < DIM); m++)
 356         {
 357             // Generate random number between 0 and 1
 358             rand[m] = gmx_rng_uniform_real(rng_);
 359         }
 360         // Generate random 3D position within the box
 361         mvmul(fr.box, rand, ins);
 362
 363         // Find the first reference position within the cutoff.
 364         bool                           bOverlap = false;
 365         AnalysisNeighborhoodPair       pair;
 366         AnalysisNeighborhoodPairSearch pairSearch = nbsearch.startPairSearch(ins);
 367         while (!bOverlap && pairSearch.findNextPair(&pair))
 368         {
 369             int jp = pair.refIndex();
 370             // Compute distance vector to first atom in the neighborlist
 371             pbc_dx(pbc, ins, sel.position(jp).x(), dx);
 372
 373             // See whether the distance is smaller than allowed
 374             bOverlap = (norm(dx) <
 375                         probeRadius_+vdw_radius_[sel.position(jp).refId()]);
 376
 377         }
 378
 379         if (!bOverlap)
 380         {
 381             // We found some free volume!
 382             NinsTot++;
 383         }
 384     }
 385     // Compute total free volume for this frame
 386     double frac = 0;
 387     if (Ninsert > 0)
 388     {
 389         frac = (100.0*NinsTot)/Ninsert;
 390     }
 391     // Add the free volume fraction to the data set in column 0
 392     dh.setPoint(0, frac);
 393     // Add the total volume to the data set in column 1
 394     dh.setPoint(1, V);
 395
 396     // Magic
 397     dh.finishFrame();
 398 }
 399
 400
 401 void
 402 FreeVolume::finishAnalysis(int /* nframes */)
 403 {
 404     please_cite(stdout, "Bondi1964a");
 405     please_cite(stdout, "Lourenco2013a");
 406 }
 407
 408 void
 409 FreeVolume::writeOutput()
 410 {
 411     // Final results come from statistics module in analysis framework
 412     double FVaver  = adata_->average(0, 0);
 413     double FVerror = adata_->standardDeviation(0, 0);
 414     printf("Free volume %.2f +/- %.2f %%\n", FVaver, FVerror);
 415
 416     double Vaver  = adata_->average(0, 1);
 417     double Verror = adata_->standardDeviation(0, 1);
 418     printf("Total volume %.2f +/- %.2f nm^3\n", Vaver, Verror);
 419
 420     printf("Number of molecules %d total mass %.2f Dalton\n", nmol_, mtot_);
 421     double RhoAver  = mtot_ / (Vaver * 1e-24 * AVOGADRO);
 422     double RhoError = sqr(RhoAver / Vaver)*Verror;
 423     printf("Average molar mass: %.2f Dalton\n", mtot_/nmol_);
 424
 425     double VmAver  = Vaver/nmol_;
 426     double VmError = Verror/nmol_;
 427     printf("Density rho: %.2f +/- %.2f nm^3\n", RhoAver, RhoError);
 428     printf("Molecular volume Vm assuming homogeneity: %.4f +/- %.4f nm^3\n",
 429            VmAver, VmError);
 430
 431     double VvdWaver  = (1-FVaver/100)*VmAver;
 432     double VvdWerror = 0;
 433     printf("Molecular van der Waals volume assuming homogeneity:  %.4f +/- %.4f nm^3\n",
 434            VvdWaver, VvdWerror);
 435
 436     double FFVaver  = 1-1.3*((100-FVaver)/100);
 437     double FFVerror = (FVerror/FVaver)*FFVaver;
 438     printf("Fractional free volume %.3f +/- %.3f\n", FFVaver, FFVerror);
 439 }
 440
 441 }       // namespace
 442
 443 const char FreeVolumeInfo::name[]             = "freevolume";
 444 const char FreeVolumeInfo::shortDescription[] =
 445     "Calculate free volume";
 446
 447 TrajectoryAnalysisModulePointer FreeVolumeInfo::create()
 448 {
 449     return TrajectoryAnalysisModulePointer(new FreeVolume);
 450 }
 451
 452 } // namespace analysismodules
 453
 454 } // namespace gmx