src/gromacs/trajectoryanalysis/tests/test_selection.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, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source 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 Testing/debugging tool for the selection engine.
  37  *
  38  * \author Teemu Murtola <teemu.murtola@gmail.com>
  39  * \ingroup module_trajectoryanalysis
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "gromacs/options/basicoptions.h"
  44 #include "gromacs/options/options.h"
  45 #include "gromacs/selection/selection.h"
  46 #include "gromacs/selection/selectionoption.h"
  47 #include "gromacs/trajectoryanalysis/analysismodule.h"
  48 #include "gromacs/trajectoryanalysis/analysissettings.h"
  49 #include "gromacs/trajectoryanalysis/cmdlinerunner.h"
  50 #include "gromacs/utility/arrayref.h"
  51 #include "gromacs/utility/exceptions.h"
  52
  53 namespace gmx
  54 {
  55
  56 class SelectionTester : public TrajectoryAnalysisModule
  57 {
  58     public:
  59         SelectionTester();
  60         virtual ~SelectionTester();
  61
  62         virtual void initOptions(Options                    *options,
  63                                  TrajectoryAnalysisSettings *settings);
  64         virtual void initAnalysis(const TrajectoryAnalysisSettings &settings,
  65                                   const TopologyInformation        &top);
  66
  67         virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
  68                                   TrajectoryAnalysisModuleData *pdata);
  69
  70         virtual void finishAnalysis(int nframes);
  71         virtual void writeOutput();
  72
  73     private:
  74         void printSelections();
  75
  76         SelectionList            selections_;
  77         int                      nmaxind_;
  78 };
  79
  80 SelectionTester::SelectionTester()
  81     : TrajectoryAnalysisModule("testing", "Selection testing and debugging"),
  82       nmaxind_(20)
  83 {
  84 }
  85
  86 SelectionTester::~SelectionTester()
  87 {
  88 }
  89
  90 void
  91 SelectionTester::printSelections()
  92 {
  93     fprintf(stderr, "\nSelections:\n");
  94     for (size_t g = 0; g < selections_.size(); ++g)
  95     {
  96         selections_[g].printDebugInfo(stderr, nmaxind_);
  97     }
  98     fprintf(stderr, "\n");
  99 }
 100
 101 void
 102 SelectionTester::initOptions(Options                   *options,
 103                              TrajectoryAnalysisSettings * /*settings*/)
 104 {
 105     static const char *const desc[] = {
 106         "This is a test program for selections."
 107     };
 108
 109     options->setDescription(desc);
 110
 111     options->addOption(SelectionOption("select").storeVector(&selections_)
 112                            .required().multiValue()
 113                            .description("Selections to test"));
 114     options->addOption(IntegerOption("pmax").store(&nmaxind_)
 115                            .description("Maximum number of indices to print in lists (-1 = print all)"));
 116 }
 117
 118 void
 119 SelectionTester::initAnalysis(const TrajectoryAnalysisSettings & /*settings*/,
 120                               const TopologyInformation        & /*top*/)
 121 {
 122     printSelections();
 123 }
 124
 125 void
 126 SelectionTester::analyzeFrame(int /*frnr*/, const t_trxframe & /*fr*/, t_pbc * /*pbc*/,
 127                               TrajectoryAnalysisModuleData * /*pdata*/)
 128 {
 129     fprintf(stderr, "\n");
 130     for (size_t g = 0; g < selections_.size(); ++g)
 131     {
 132         const Selection &sel = selections_[g];
 133         int              n;
 134
 135         fprintf(stderr, "  Atoms (%d pcs):", sel.atomCount());
 136         n = sel.atomCount();
 137         if (nmaxind_ >= 0 && n > nmaxind_)
 138         {
 139             n = nmaxind_;
 140         }
 141         ConstArrayRef<int> atoms = sel.atomIndices();
 142         for (int i = 0; i < n; ++i)
 143         {
 144             fprintf(stderr, " %d", atoms[i]+1);
 145         }
 146         if (n < sel.atomCount())
 147         {
 148             fprintf(stderr, " ...");
 149         }
 150         fprintf(stderr, "\n");
 151
 152         fprintf(stderr, "  Positions (%d pcs):\n", sel.posCount());
 153         n = sel.posCount();
 154         if (nmaxind_ >= 0 && n > nmaxind_)
 155         {
 156             n = nmaxind_;
 157         }
 158         for (int i = 0; i < n; ++i)
 159         {
 160             const SelectionPosition &p = sel.position(i);
 161             fprintf(stderr, "    (%.2f,%.2f,%.2f) r=%d, m=%d, n=%d\n",
 162                     p.x()[XX], p.x()[YY], p.x()[ZZ],
 163                     p.refId(), p.mappedId(), p.atomCount());
 164         }
 165         if (n < sel.posCount())
 166         {
 167             fprintf(stderr, "    ...\n");
 168         }
 169     }
 170     fprintf(stderr, "\n");
 171 }
 172
 173 void
 174 SelectionTester::finishAnalysis(int /*nframes*/)
 175 {
 176     printSelections();
 177 }
 178
 179 void
 180 SelectionTester::writeOutput()
 181 {
 182 }
 183
 184 }
 185
 186 /*! \internal \brief
 187  * The main function for the selection testing tool.
 188  */
 189 int
 190 main(int argc, char *argv[])
 191 {
 192     return gmx::TrajectoryAnalysisCommandLineRunner::runAsMain<gmx::SelectionTester>(argc, argv);
 193 }