src/gromacs/trajectoryanalysis/modules.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014 by the GROMACS development team.
   5  * Copyright (c) 2016,2018,2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Implements registerTrajectoryAnalysisModules().
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_trajectoryanalysis
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "modules.h"
  46
  47 #include "gromacs/commandline/cmdlinemodulemanager.h"
  48 #include "gromacs/trajectoryanalysis/cmdlinerunner.h"
  49
  50 #include "modules/angle.h"
  51 #include "modules/convert_trj.h"
  52 #include "modules/distance.h"
  53 #include "modules/extract_cluster.h"
  54 #include "modules/freevolume.h"
  55 #include "modules/msd.h"
  56 #include "modules/pairdist.h"
  57 #include "modules/rdf.h"
  58 #include "modules/sasa.h"
  59 #include "modules/select.h"
  60 #include "modules/trajectory.h"
  61
  62 namespace gmx
  63 {
  64
  65 namespace
  66 {
  67
  68 /*! \brief
  69  * Convenience method for registering a command-line module for trajectory
  70  * analysis.
  71  *
  72  * \tparam ModuleInfo  Info about trajectory analysis module to wrap.
  73  *
  74  * \p ModuleInfo should have static public members
  75  * `const char name[]`, `const char shortDescription[]`, and
  76  * `gmx::TrajectoryAnalysisModulePointer create()`.
  77  *
  78  * \ingroup module_trajectoryanalysis
  79  */
  80 template<class ModuleInfo>
  81 void registerModule(CommandLineModuleManager* manager, CommandLineModuleGroup group)
  82 {
  83     TrajectoryAnalysisCommandLineRunner::registerModule(
  84             manager, ModuleInfo::name, ModuleInfo::shortDescription, &ModuleInfo::create);
  85     group.addModule(ModuleInfo::name);
  86 }
  87
  88 } // namespace
  89
  90 //! \cond libapi
  91 void registerTrajectoryAnalysisModules(CommandLineModuleManager* manager)
  92 {
  93     using namespace gmx::analysismodules;
  94     CommandLineModuleGroup group = manager->addModuleGroup("Trajectory analysis");
  95     registerModule<AngleInfo>(manager, group);
  96     registerModule<ConvertTrjInfo>(manager, group);
  97     registerModule<DistanceInfo>(manager, group);
  98     registerModule<ExtractClusterInfo>(manager, group);
  99     registerModule<FreeVolumeInfo>(manager, group);
 100     registerModule<MsdInfo>(manager, group);
 101     registerModule<PairDistanceInfo>(manager, group);
 102     registerModule<RdfInfo>(manager, group);
 103     registerModule<SasaInfo>(manager, group);
 104     registerModule<SelectInfo>(manager, group);
 105     registerModule<TrajectoryInfo>(manager, group);
 106 }
 107 //! \endcond
 108
 109 } // namespace gmx