src/gromacs/trajectoryanalysis/modules/select.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 basic selection information.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_trajectoryanalysis
  37  */
  38 #ifndef GMX_TRAJECTORYANALYSIS_MODULES_SELECT_H
  39 #define GMX_TRAJECTORYANALYSIS_MODULES_SELECT_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 Select : public TrajectoryAnalysisModule
  58 {
  59     public:
  60         static const char name[];
  61         static const char shortDescription[];
  62
  63         Select();
  64         virtual ~Select();
  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         SelectionList                    sel_;
  81         SelectionOptionInfo             *selOpt_;
  82
  83         std::string                      fnSize_;
  84         std::string                      fnFrac_;
  85         std::string                      fnIndex_;
  86         std::string                      fnNdx_;
  87         std::string                      fnMask_;
  88         std::string                      fnOccupancy_;
  89         std::string                      fnPDB_;
  90         bool                             bDump_;
  91         bool                             bTotNorm_;
  92         bool                             bFracNorm_;
  93         bool                             bResInd_;
  94         std::string                      resNumberType_;
  95         std::string                      pdbAtoms_;
  96
  97         const TopologyInformation       *top_;
  98         std::vector<int>                 totsize_;
  99         AnalysisData                     sdata_;
 100         AnalysisData                     cdata_;
 101         AnalysisData                     idata_;
 102         AnalysisData                     mdata_;
 103         AnalysisDataAverageModulePointer occupancyModule_;
 104 };
 105
 106 } // namespace analysismodules
 107
 108 } // namespace gmx
 109
 110 #endif