src/gromacs/trajectoryanalysis/modules/distance.h

   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  * Declares trajectory analysis module for distance calculations.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_trajectoryanalysis
  37  */
  38 #ifndef GMX_TRAJECTORYANALYSIS_MODULES_DISTANCE_H
  39 #define GMX_TRAJECTORYANALYSIS_MODULES_DISTANCE_H
  40
  41 #include <string>
  42
  43 #include "../analysismodule.h"
  44 #include "gromacs/analysisdata/analysisdata.h"
  45 #include "gromacs/analysisdata/modules/average.h"
  46 #include "gromacs/options/options.h"
  47 #include "gromacs/selection/selection.h"
  48
  49 namespace gmx
  50 {
  51
  52 namespace analysismodules
  53 {
  54
  55 class Distance : public TrajectoryAnalysisModule
  56 {
  57     public:
  58         static const char name[];
  59         static const char shortDescription[];
  60
  61         Distance();
  62         virtual ~Distance();
  63
  64         virtual Options &initOptions(TrajectoryAnalysisSettings *settings);
  65         virtual void initAnalysis(const TrajectoryAnalysisSettings &settings,
  66                                   const TopologyInformation &top);
  67
  68         virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
  69                                   TrajectoryAnalysisModuleData *pdata);
  70
  71         virtual void finishAnalysis(int nframes);
  72         virtual void writeOutput();
  73
  74     private:
  75         Options                          _options;
  76         std::string                      _fnDist;
  77         Selection                        _sel[2];
  78         AnalysisData                     _data;
  79         AnalysisDataAverageModulePointer _avem;
  80
  81         // Copy and assign disallowed by base.
  82 };
  83
  84 } // namespace analysismodules
  85
  86 } // namespace gmx
  87
  88 #endif