src/gromacs/trajectoryanalysis/modules/freevolume.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013, 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 distance calculations.
  38  *
  39  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  40  * \ingroup module_trajectoryanalysis
  41  */
  42 #ifndef GMX_TRAJECTORYANALYSIS_MODULES_FREEVOLUME_H
  43 #define GMX_TRAJECTORYANALYSIS_MODULES_FREEVOLUME_H
  44
  45 #include <string>
  46 #include "gromacs/legacyheaders/gmx_random.h"
  47 #include "../analysismodule.h"
  48 #include "gromacs/selection/nbsearch.h"
  49 #include "gromacs/selection/indexutil.h"
  50 #include "gromacs/analysisdata/analysisdata.h"
  51 #include "gromacs/analysisdata/modules/average.h"
  52 #include "gromacs/selection/selection.h"
  53
  54 namespace gmx
  55 {
  56
  57 namespace analysismodules
  58 {
  59
  60 /*! \brief
  61  * Class used to compute free volume in a simulations box.
  62  *
  63  * Inherits TrajectoryAnalysisModule and all functions from there.
  64  * Does not implement any new functionality.
  65  *
  66  * \inpublicapi
  67  * \ingroup module_trajectoryanalysis
  68  */
  69 class FreeVolume : public TrajectoryAnalysisModule
  70 {
  71     public:
  72         //! Name of the tool
  73         static const char name[];
  74
  75         //! One line description
  76         static const char shortDescription[];
  77
  78         //! Constructor
  79         FreeVolume();
  80
  81         //! Destructor
  82         virtual ~FreeVolume();
  83
  84         //! Set the options and setting
  85         virtual void initOptions(Options                    *options,
  86                                  TrajectoryAnalysisSettings *settings);
  87
  88         //! First routine called by the analysis frame work
  89         virtual void initAnalysis(const TrajectoryAnalysisSettings &settings,
  90                                   const TopologyInformation        &top);
  91
  92         //! Call for each frame of the trajectory
  93         virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
  94                                   TrajectoryAnalysisModuleData *pdata);
  95
  96         //! Last routine called by the analysis frame work
  97         virtual void finishAnalysis(int nframes);
  98
  99         //! Routine to write output, that is additional over the built-in
 100         virtual void writeOutput();
 101
 102     private:
 103         std::string                       fnFreevol_;
 104         Selection                         sel_;
 105         AnalysisData                      data_;
 106         AnalysisDataAverageModulePointer  adata_;
 107
 108         int                               nmol_;
 109         double                            mtot_;
 110         double                            cutoff_;
 111         double                            probeRadius_;
 112         gmx_rng_t                         rng_;
 113         int                               seed_, ninsert_;
 114         gmx_ana_nbsearch_t               *nbsearch_;
 115         //! The van der Waals radius per atom
 116         std::vector<double>               vdw_radius_;
 117
 118         // Copy and assign disallowed by base.
 119 };
 120
 121 } // namespace analysismodules
 122
 123 } // namespace gmx
 124
 125 #endif