src/gromacs/selection/selectionoptionbehavior.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,2017,2018,2019,2020,2021, 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
  37  * Implements gmx::SelectionOptionBehavior.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "selectionoptionbehavior.h"
  45
  46 #include <cstdio>
  47
  48 #include <string>
  49
  50 #include "gromacs/options/filenameoption.h"
  51 #include "gromacs/options/ioptionscontainer.h"
  52 #include "gromacs/options/options.h"
  53 #include "gromacs/selection/indexutil.h"
  54 #include "gromacs/selection/selectioncollection.h"
  55 #include "gromacs/selection/selectionfileoption.h"
  56 #include "gromacs/selection/selectionoptionmanager.h"
  57 #include "gromacs/topology/atoms.h"
  58 #include "gromacs/topology/topology.h"
  59 #include "gromacs/utility/exceptions.h"
  60 #include "gromacs/utility/filestream.h"
  61
  62 namespace gmx
  63 {
  64
  65 /********************************************************************
  66  * ITopologyProvider
  67  */
  68
  69 ITopologyProvider::~ITopologyProvider() {}
  70
  71 /********************************************************************
  72  * SelectionOptionBehavior
  73  */
  74
  75 class SelectionOptionBehavior::Impl
  76 {
  77 public:
  78     Impl(SelectionCollection* selections, ITopologyProvider* topologyProvider) :
  79         selections_(*selections), topologyProvider_(*topologyProvider), manager_(selections), grps_(nullptr)
  80     {
  81     }
  82     ~Impl()
  83     {
  84         if (grps_ != nullptr)
  85         {
  86             gmx_ana_indexgrps_free(grps_);
  87         }
  88     }
  89
  90     void promptSelections()
  91     {
  92         const bool isInteractive = StandardInputStream::isInteractive();
  93         initIndexGroups();
  94         manager_.parseRequestedFromStdin(isInteractive);
  95         doneIndexGroups();
  96     }
  97     void initIndexGroups()
  98     {
  99         if (!selections_.requiresIndexGroups() && !manager_.hasRequestedSelections())
 100         {
 101             if (!ndxfile_.empty())
 102             {
 103                 std::fprintf(stderr,
 104                              "NOTE: You provided an index file\n"
 105                              "  %s\n(with -n), but it was not used by any selection.\n",
 106                              ndxfile_.c_str());
 107             }
 108             selections_.setIndexGroups(nullptr);
 109             return;
 110         }
 111         if (ndxfile_.empty())
 112         {
 113             gmx_mtop_t* top = topologyProvider_.getTopology(false);
 114             gmx_ana_indexgrps_init(&grps_, top, nullptr);
 115         }
 116         else
 117         {
 118             gmx_ana_indexgrps_init(&grps_, nullptr, ndxfile_.c_str());
 119         }
 120         selections_.setIndexGroups(grps_);
 121     }
 122     void doneIndexGroups()
 123     {
 124         if (grps_ != nullptr)
 125         {
 126             selections_.setIndexGroups(nullptr);
 127             gmx_ana_indexgrps_free(grps_);
 128             grps_ = nullptr;
 129         }
 130     }
 131
 132     void compileSelections()
 133     {
 134         const bool  topRequired = selections_.requiredTopologyProperties().needsTopology;
 135         gmx_mtop_t* top         = topologyProvider_.getTopology(topRequired);
 136         int         natoms      = -1;
 137         if (top == nullptr)
 138         {
 139             natoms = topologyProvider_.getAtomCount();
 140         }
 141         getMassesIfRequired(top);
 142         selections_.setTopology(top, natoms);
 143         selections_.compile();
 144         // Situation may have changed after compilation.
 145         getMassesIfRequired(top);
 146     }
 147
 148     void getMassesIfRequired(gmx_mtop_t* top) const
 149     {
 150         const bool massRequired = selections_.requiredTopologyProperties().needsMasses;
 151         if (!massRequired)
 152         {
 153             return;
 154         }
 155         // TODO: There can be some corner cases that still hit this assert
 156         // when the user has not provided the topology.
 157         GMX_RELEASE_ASSERT(top != nullptr, "Masses are required, but no topology is loaded");
 158         for (gmx_moltype_t& moltype : top->moltype)
 159         {
 160             if (!moltype.atoms.haveMass)
 161             {
 162                 atomsSetMassesBasedOnNames(&moltype.atoms, TRUE);
 163                 if (!moltype.atoms.haveMass)
 164                 {
 165                     GMX_THROW(InconsistentInputError(
 166                             "Selections require mass information for evaluation, but it is not "
 167                             "available in the input and could not be determined for all atoms "
 168                             "based on atom names."));
 169                 }
 170             }
 171         }
 172     }
 173
 174     SelectionCollection&   selections_;
 175     ITopologyProvider&     topologyProvider_;
 176     SelectionOptionManager manager_;
 177     //! Name of the index file (empty if no index file provided).
 178     std::string          ndxfile_;
 179     gmx_ana_indexgrps_t* grps_;
 180 };
 181
 182 SelectionOptionBehavior::SelectionOptionBehavior(SelectionCollection* selections,
 183                                                  ITopologyProvider*   topologyProvider) :
 184     impl_(new Impl(selections, topologyProvider))
 185 {
 186 }
 187
 188 SelectionOptionBehavior::~SelectionOptionBehavior() {}
 189
 190 void SelectionOptionBehavior::initOptions(IOptionsContainer* options)
 191 {
 192     options->addOption(FileNameOption("n")
 193                                .filetype(OptionFileType::Index)
 194                                .inputFile()
 195                                .store(&impl_->ndxfile_)
 196                                .defaultBasename("index")
 197                                .description("Extra index groups"));
 198     options->addOption(SelectionFileOption("sf"));
 199     impl_->manager_.initOptions(options);
 200 }
 201
 202 void SelectionOptionBehavior::initBehavior(Options* options)
 203 {
 204     options->addManager(&impl_->manager_);
 205 }
 206
 207 void SelectionOptionBehavior::optionsFinished()
 208 {
 209     impl_->promptSelections();
 210     impl_->compileSelections();
 211 }
 212
 213 } // namespace gmx