src/gromacs/trajectoryanalysis/modules/angle.h

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