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
  43 #include "../analysismodule.h"
  44 #include "gromacs/analysisdata/analysisdata.h"
  45 #include "gromacs/options/options.h"
  46 #include "gromacs/selection/selection.h"
  47
  48 namespace gmx
  49 {
  50
  51 class SelectionOptionInfo;
  52
  53 namespace analysismodules
  54 {
  55
  56 class Angle : public TrajectoryAnalysisModule
  57 {
  58     public:
  59         static const char name[];
  60         static const char shortDescription[];
  61
  62         Angle();
  63         virtual ~Angle();
  64
  65         virtual Options &initOptions(TrajectoryAnalysisSettings *settings);
  66         virtual void initOptionsDone(TrajectoryAnalysisSettings *settings);
  67         virtual void initAnalysis(const TrajectoryAnalysisSettings &settings,
  68                                   const TopologyInformation &top);
  69
  70         virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
  71                                   TrajectoryAnalysisModuleData *pdata);
  72
  73         virtual void finishAnalysis(int nframes);
  74         virtual void writeOutput();
  75
  76     private:
  77         void checkSelections(const SelectionList &sel1,
  78                              const SelectionList &sel2) const;
  79
  80         Options                 _options;
  81
  82         SelectionList           _sel1;
  83         SelectionList           _sel2;
  84         SelectionOptionInfo    *_sel1info;
  85         SelectionOptionInfo    *_sel2info;
  86         std::string             _fnAngle;
  87         std::string             _fnDump;
  88
  89         std::string             _g1type;
  90         std::string             _g2type;
  91         bool                    _bSplit1;
  92         bool                    _bSplit2;
  93         bool                    _bMulti;
  94         bool                    _bAll;
  95         bool                    _bDumpDist;
  96
  97         AnalysisData            _data;
  98         int                     _natoms1;
  99         int                     _natoms2;
 100         rvec                   *_vt0;
 101
 102         // Copy and assign disallowed by base.
 103 };
 104
 105 } // namespace analysismodules
 106
 107 } // namespace gmxana
 108
 109 #endif