src/gromacs/trajectoryanalysis.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 /*! \defgroup module_trajectoryanalysis Framework for Trajectory Analysis
  36  * \ingroup group_analysismodules
  37  * \brief
  38  * Provides functionality for implementing trajectory analysis modules.
  39  *
  40  * This module implements a framework for implementing flexible trajectory
  41  * analysis routines.  It provides a base class for implementing analysis as
  42  * reusable modules that can be used from different contexts and can also
  43  * support per-frame parallelization.  It integrally uses functionality from the
  44  * following modules:
  45  *  - \ref module_options
  46  *  - \ref module_analysisdata
  47  *  - \ref module_selection
  48  *
  49  * The main interface of this module is the gmx::TrajectoryAnalysisModule class.
  50  * Analysis modules should derive from this class, and override the necessary
  51  * virtual methods to provide the actual initialization and analysis routines.
  52  * Classes gmx::TrajectoryAnalysisSettings and gmx::TopologyInformation (in
  53  * addition to classes declared in the above-mentioned modules) are used to pass
  54  * information to and from these methods.  gmx::TrajectoryAnalysisModuleData can
  55  * be used in advanced scenarios where the tool requires custom thread-local
  56  * data for parallel analysis.
  57  *
  58  * In addition to the framework for defining analysis modules, this module also
  59  * provides gmx::TrajectoryAnalysisCommandLineRunner, which implements a
  60  * command-line program that runs a certain analysis module.
  61  *
  62  * Internally, the module also defines a set of trajectory analysis modules that
  63  * can be instantiated using createTrajectoryAnalysisModule().
  64  *
  65  * For an example of how to implement an analysis tool using the framework, see
  66  * \ref template.cpp.
  67  *
  68  * \author Teemu Murtola <teemu.murtola@gmail.com>
  69  */
  70 /*! \file
  71  * \brief
  72  * Public API convenience header for trajectory analysis framework
  73  *
  74  * \author Teemu Murtola <teemu.murtola@gmail.com>
  75  * \inpublicapi
  76  * \ingroup module_trajectoryanalysis
  77  */
  78 #ifndef GMX_TRAJECTORYANALYSIS_H
  79 #define GMX_TRAJECTORYANALYSIS_H
  80
  81 #include "analysisdata.h"
  82 #include "options.h"
  83 #include "selection.h"
  84
  85 #include "selection/nbsearch.h"
  86 #include "trajectoryanalysis/analysismodule.h"
  87 #include "trajectoryanalysis/analysissettings.h"
  88 #include "trajectoryanalysis/cmdlinerunner.h"
  89 #include "utility/exceptions.h"
  90 #include "utility/programinfo.h"
  91 #include "utility/stringutil.h"
  92
  93 #endif