src/gromacs/trajectoryanalysis/modules/distance.cpp

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Implements gmx::analysismodules::Distance.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_trajectoryanalysis
  37  */
  38 #include "distance.h"
  39
  40 #ifdef HAVE_CONFIG_H
  41 #include <config.h>
  42 #endif
  43
  44 #include "pbc.h"
  45 #include "vec.h"
  46
  47 #include "gromacs/analysisdata/analysisdata.h"
  48 #include "gromacs/analysisdata/modules/plot.h"
  49 #include "gromacs/options/basicoptions.h"
  50 #include "gromacs/options/filenameoption.h"
  51 #include "gromacs/options/options.h"
  52 #include "gromacs/selection/selection.h"
  53 #include "gromacs/selection/selectionoption.h"
  54 #include "gromacs/trajectoryanalysis/analysissettings.h"
  55 #include "gromacs/utility/exceptions.h"
  56 #include "gromacs/utility/stringutil.h"
  57
  58 namespace gmx
  59 {
  60
  61 namespace analysismodules
  62 {
  63
  64 const char Distance::name[] = "distance";
  65 const char Distance::shortDescription[] =
  66     "Calculate distances";
  67
  68 Distance::Distance()
  69     : options_(name, shortDescription), avem_(new AnalysisDataAverageModule())
  70 {
  71     data_.setColumnCount(4);
  72     registerAnalysisDataset(&data_, "distance");
  73 }
  74
  75
  76 Distance::~Distance()
  77 {
  78 }
  79
  80
  81 Options &
  82 Distance::initOptions(TrajectoryAnalysisSettings *settings)
  83 {
  84     static const char *const desc[] = {
  85         "g_dist can calculate the distance between two positions as",
  86         "a function of time. The total distance and its",
  87         "x, y and z components are plotted."
  88     };
  89
  90     options_.setDescription(concatenateStrings(desc));
  91
  92     options_.addOption(FileNameOption("o").filetype(eftPlot).outputFile()
  93                            .store(&fnDist_).defaultValueIfSet("dist")
  94                            .description("Computed distances"));
  95     options_.addOption(SelectionOption("select").required().valueCount(2)
  96                            .store(sel_));
  97     return options_;
  98 }
  99
 100
 101 void
 102 Distance::initAnalysis(const TrajectoryAnalysisSettings &settings,
 103                        const TopologyInformation & /*top*/)
 104 {
 105     if (sel_[0].posCount() != 1)
 106     {
 107         GMX_THROW(InvalidInputError("The first selection does not define a single position"));
 108     }
 109     if (sel_[1].posCount() != 1)
 110     {
 111         GMX_THROW(InvalidInputError("The second selection does not define a single position"));
 112     }
 113
 114     data_.addModule(avem_);
 115     AnalysisDataPlotModulePointer plotm_(new AnalysisDataPlotModule());
 116     plotm_->setSettings(settings.plotSettings());
 117     plotm_->setFileName(fnDist_);
 118     plotm_->setTitle("Distance");
 119     plotm_->setXAxisIsTime();
 120     plotm_->setYLabel("Distance (nm)");
 121     data_.addModule(plotm_);
 122 }
 123
 124
 125 void
 126 Distance::analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
 127                        TrajectoryAnalysisModuleData *pdata)
 128 {
 129     AnalysisDataHandle  dh = pdata->dataHandle(data_);
 130     const Selection    &sel1 = pdata->parallelSelection(sel_[0]);
 131     const Selection    &sel2 = pdata->parallelSelection(sel_[1]);
 132     rvec                dx;
 133     real                r;
 134     const SelectionPosition &p1 = sel1.position(0);
 135     const SelectionPosition &p2 = sel2.position(0);
 136
 137     if (pbc != NULL)
 138     {
 139         pbc_dx(pbc, p1.x(), p2.x(), dx);
 140     }
 141     else
 142     {
 143         rvec_sub(p1.x(), p2.x(), dx);
 144     }
 145     r = norm(dx);
 146     dh.startFrame(frnr, fr.time);
 147     dh.setPoint(0, r);
 148     dh.setPoints(1, 3, dx);
 149     dh.finishFrame();
 150 }
 151
 152
 153 void
 154 Distance::finishAnalysis(int /*nframes*/)
 155 {
 156 }
 157
 158
 159 void
 160 Distance::writeOutput()
 161 {
 162     fprintf(stderr, "Average distance: %f\n", avem_->average(0));
 163     fprintf(stderr, "Std. deviation:   %f\n", avem_->stddev(0));
 164 }
 165
 166 } // namespace analysismodules
 167
 168 } // namespace gmx