Merge release-4-6 into master
[alexxy/gromacs.git] / 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/selection/selection.h"
47
48 namespace gmx
49 {
50
51 namespace analysismodules
52 {
53
54 class Select : public TrajectoryAnalysisModule
55 {
56     public:
57         static const char name[];
58         static const char shortDescription[];
59
60         Select();
61         virtual ~Select();
62
63         virtual void initOptions(Options *options,
64                                  TrajectoryAnalysisSettings *settings);
65         virtual void initAnalysis(const TrajectoryAnalysisSettings &settings,
66                                   const TopologyInformation &top);
67
68         virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
69                                   TrajectoryAnalysisModuleData *pdata);
70
71         virtual void finishAnalysis(int nframes);
72         virtual void writeOutput();
73
74     private:
75         SelectionList            sel_;
76
77         std::string              fnSize_;
78         std::string              fnFrac_;
79         std::string              fnIndex_;
80         std::string              fnNdx_;
81         std::string              fnMask_;
82         bool                     bDump_;
83         bool                     bTotNorm_;
84         bool                     bFracNorm_;
85         bool                     bResInd_;
86         std::string              resNumberType_;
87
88         t_topology              *top_;
89         std::vector<int>         totsize_;
90         AnalysisData             sdata_;
91         AnalysisData             cdata_;
92         AnalysisData             idata_;
93         AnalysisData             mdata_;
94 };
95
96 } // namespace analysismodules
97
98 } // namespace gmx
99
100 #endif