src/gromacs/trajectoryanalysis/modules/angle.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 angle calculations.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_trajectoryanalysis
  37  */
  38 #ifndef GMX_TRAJECTORYANALYSIS_MODULES_ANGLE_H
  39 #define GMX_TRAJECTORYANALYSIS_MODULES_ANGLE_H
  40
  41 #include <string>
  42 #include <vector>
  43
  44 #include "../analysismodule.h"
  45 #include "gromacs/analysisdata/analysisdata.h"
  46 #include "gromacs/analysisdata/modules/average.h"
  47 #include "gromacs/selection/selection.h"
  48
  49 namespace gmx
  50 {
  51
  52 class SelectionOptionInfo;
  53
  54 namespace analysismodules
  55 {
  56
  57 class Angle : public TrajectoryAnalysisModule
  58 {
  59     public:
  60         static const char name[];
  61         static const char shortDescription[];
  62
  63         Angle();
  64         virtual ~Angle();
  65
  66         virtual void initOptions(Options *options,
  67                                  TrajectoryAnalysisSettings *settings);
  68         virtual void optionsFinished(Options *options,
  69                                      TrajectoryAnalysisSettings *settings);
  70         virtual void initAnalysis(const TrajectoryAnalysisSettings &settings,
  71                                   const TopologyInformation &top);
  72
  73         virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
  74                                   TrajectoryAnalysisModuleData *pdata);
  75
  76         virtual void finishAnalysis(int nframes);
  77         virtual void writeOutput();
  78
  79     private:
  80         void checkSelections(const SelectionList &sel1,
  81                              const SelectionList &sel2) const;
  82
  83         SelectionList           sel1_;
  84         SelectionList           sel2_;
  85         SelectionOptionInfo    *sel1info_;
  86         SelectionOptionInfo    *sel2info_;
  87         std::string             fnAverage_;
  88         std::string             fnAll_;
  89
  90         std::string             g1type_;
  91         std::string             g2type_;
  92
  93         AnalysisData            angles_;
  94         AnalysisDataFrameAverageModulePointer averageModule_;
  95         int                     natoms1_;
  96         int                     natoms2_;
  97         // TODO: It is not possible to put rvec into a container.
  98         std::vector<rvec *>     vt0_;
  99
 100         // Copy and assign disallowed by base.
 101 };
 102
 103 } // namespace analysismodules
 104
 105 } // namespace gmxana
 106
 107 #endif