src/gromacs/trajectoryanalysis/modules/distance.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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  * Declares trajectory analysis module for distance calculations.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_trajectoryanalysis
  41  */
  42 #ifndef GMX_TRAJECTORYANALYSIS_MODULES_DISTANCE_H
  43 #define GMX_TRAJECTORYANALYSIS_MODULES_DISTANCE_H
  44
  45 #include <string>
  46
  47 #include "../analysismodule.h"
  48 #include "gromacs/analysisdata/analysisdata.h"
  49 #include "gromacs/analysisdata/modules/average.h"
  50 #include "gromacs/selection/selection.h"
  51
  52 namespace gmx
  53 {
  54
  55 namespace analysismodules
  56 {
  57
  58 class Distance : public TrajectoryAnalysisModule
  59 {
  60     public:
  61         static const char name[];
  62         static const char shortDescription[];
  63
  64         Distance();
  65         virtual ~Distance();
  66
  67         virtual void initOptions(Options                    *options,
  68                                  TrajectoryAnalysisSettings *settings);
  69         virtual void initAnalysis(const TrajectoryAnalysisSettings &settings,
  70                                   const TopologyInformation        &top);
  71
  72         virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
  73                                   TrajectoryAnalysisModuleData *pdata);
  74
  75         virtual void finishAnalysis(int nframes);
  76         virtual void writeOutput();
  77
  78     private:
  79         std::string                      fnDist_;
  80         Selection                        sel_[2];
  81         AnalysisData                     data_;
  82         AnalysisDataAverageModulePointer avem_;
  83
  84         // Copy and assign disallowed by base.
  85 };
  86
  87 } // namespace analysismodules
  88
  89 } // namespace gmx
  90
  91 #endif