src/gromacs/selection/selection.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2011,2012,2013,2014,2015, 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 classes in selection.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "selection.h"
  45
  46 #include <string>
  47
  48 #include "gromacs/selection/nbsearch.h"
  49 #include "gromacs/selection/position.h"
  50 #include "gromacs/topology/topology.h"
  51 #include "gromacs/utility/exceptions.h"
  52 #include "gromacs/utility/gmxassert.h"
  53 #include "gromacs/utility/stringutil.h"
  54 #include "gromacs/utility/textwriter.h"
  55
  56 #include "selelem.h"
  57 #include "selvalue.h"
  58
  59 namespace gmx
  60 {
  61
  62 namespace internal
  63 {
  64
  65 /********************************************************************
  66  * SelectionData
  67  */
  68
  69 SelectionData::SelectionData(SelectionTreeElement *elem,
  70                              const char           *selstr)
  71     : name_(elem->name()), selectionText_(selstr),
  72       rootElement_(*elem), coveredFractionType_(CFRAC_NONE),
  73       coveredFraction_(1.0), averageCoveredFraction_(1.0),
  74       bDynamic_(false), bDynamicCoveredFraction_(false)
  75 {
  76     if (elem->child->type == SEL_CONST)
  77     {
  78         // TODO: This is not exception-safe if any called function throws.
  79         gmx_ana_pos_copy(&rawPositions_, elem->child->v.u.p, true);
  80     }
  81     else
  82     {
  83         SelectionTreeElementPointer child = elem->child;
  84         child->flags     &= ~SEL_ALLOCVAL;
  85         _gmx_selvalue_setstore(&child->v, &rawPositions_);
  86         /* We should also skip any modifiers to determine the dynamic
  87          * status. */
  88         while (child->type == SEL_MODIFIER)
  89         {
  90             child = child->child;
  91             if (!child)
  92             {
  93                 break;
  94             }
  95             if (child->type == SEL_SUBEXPRREF)
  96             {
  97                 child = child->child;
  98                 /* Because most subexpression elements are created
  99                  * during compilation, we need to check for them
 100                  * explicitly here.
 101                  */
 102                 if (child->type == SEL_SUBEXPR)
 103                 {
 104                     child = child->child;
 105                 }
 106             }
 107         }
 108         if (child)
 109         {
 110             /* For variable references, we should skip the
 111              * SEL_SUBEXPRREF and SEL_SUBEXPR elements. */
 112             if (child->type == SEL_SUBEXPRREF)
 113             {
 114                 child = child->child->child;
 115             }
 116             bDynamic_ = (child->child->flags & SEL_DYNAMIC);
 117         }
 118     }
 119     initCoveredFraction(CFRAC_NONE);
 120 }
 121
 122
 123 SelectionData::~SelectionData()
 124 {
 125 }
 126
 127
 128 bool
 129 SelectionData::initCoveredFraction(e_coverfrac_t type)
 130 {
 131     coveredFractionType_ = type;
 132     if (type == CFRAC_NONE)
 133     {
 134         bDynamicCoveredFraction_ = false;
 135     }
 136     else if (!_gmx_selelem_can_estimate_cover(rootElement()))
 137     {
 138         coveredFractionType_     = CFRAC_NONE;
 139         bDynamicCoveredFraction_ = false;
 140     }
 141     else
 142     {
 143         bDynamicCoveredFraction_ = true;
 144     }
 145     coveredFraction_        = bDynamicCoveredFraction_ ? 0.0 : 1.0;
 146     averageCoveredFraction_ = coveredFraction_;
 147     return type == CFRAC_NONE || coveredFractionType_ != CFRAC_NONE;
 148 }
 149
 150 namespace
 151 {
 152
 153 /*! \brief
 154  * Helper function to compute total masses and charges for positions.
 155  *
 156  * \param[in]  top     Topology to take atom masses from.
 157  * \param[in]  pos     Positions to compute masses and charges for.
 158  * \param[out] masses  Output masses.
 159  * \param[out] charges Output charges.
 160  *
 161  * Does not throw if enough space has been reserved for the output vectors.
 162  */
 163 void computeMassesAndCharges(const t_topology *top, const gmx_ana_pos_t &pos,
 164                              std::vector<real> *masses,
 165                              std::vector<real> *charges)
 166 {
 167     GMX_ASSERT(top != NULL, "Should not have been called with NULL topology");
 168     masses->clear();
 169     charges->clear();
 170     for (int b = 0; b < pos.count(); ++b)
 171     {
 172         real mass   = 0.0;
 173         real charge = 0.0;
 174         for (int i = pos.m.mapb.index[b]; i < pos.m.mapb.index[b+1]; ++i)
 175         {
 176             const int index = pos.m.mapb.a[i];
 177             mass   += top->atoms.atom[index].m;
 178             charge += top->atoms.atom[index].q;
 179         }
 180         masses->push_back(mass);
 181         charges->push_back(charge);
 182     }
 183 }
 184
 185 }       // namespace
 186
 187 void
 188 SelectionData::refreshName()
 189 {
 190     rootElement_.fillNameIfMissing(selectionText_.c_str());
 191     name_ = rootElement_.name();
 192 }
 193
 194 void
 195 SelectionData::initializeMassesAndCharges(const t_topology *top)
 196 {
 197     GMX_ASSERT(posMass_.empty() && posCharge_.empty(),
 198                "Should not be called more than once");
 199     posMass_.reserve(posCount());
 200     posCharge_.reserve(posCount());
 201     if (top == NULL)
 202     {
 203         posMass_.resize(posCount(), 1.0);
 204         posCharge_.resize(posCount(), 0.0);
 205     }
 206     else
 207     {
 208         computeMassesAndCharges(top, rawPositions_, &posMass_, &posCharge_);
 209     }
 210 }
 211
 212
 213 void
 214 SelectionData::refreshMassesAndCharges(const t_topology *top)
 215 {
 216     if (top != NULL && isDynamic() && !hasFlag(efSelection_DynamicMask))
 217     {
 218         computeMassesAndCharges(top, rawPositions_, &posMass_, &posCharge_);
 219     }
 220 }
 221
 222
 223 void
 224 SelectionData::updateCoveredFractionForFrame()
 225 {
 226     if (isCoveredFractionDynamic())
 227     {
 228         real cfrac = _gmx_selelem_estimate_coverfrac(rootElement());
 229         coveredFraction_         = cfrac;
 230         averageCoveredFraction_ += cfrac;
 231     }
 232 }
 233
 234
 235 void
 236 SelectionData::computeAverageCoveredFraction(int nframes)
 237 {
 238     if (isCoveredFractionDynamic() && nframes > 0)
 239     {
 240         averageCoveredFraction_ /= nframes;
 241     }
 242 }
 243
 244
 245 void
 246 SelectionData::restoreOriginalPositions(const t_topology *top)
 247 {
 248     if (isDynamic())
 249     {
 250         gmx_ana_pos_t &p = rawPositions_;
 251         gmx_ana_indexmap_update(&p.m, rootElement().v.u.g,
 252                                 hasFlag(gmx::efSelection_DynamicMask));
 253         refreshMassesAndCharges(top);
 254     }
 255 }
 256
 257 }   // namespace internal
 258
 259 /********************************************************************
 260  * Selection
 261  */
 262
 263 Selection::operator AnalysisNeighborhoodPositions() const
 264 {
 265     AnalysisNeighborhoodPositions pos(data().rawPositions_.x,
 266                                       data().rawPositions_.count());
 267     if (hasOnlyAtoms())
 268     {
 269         pos.exclusionIds(atomIndices());
 270     }
 271     return pos;
 272 }
 273
 274
 275 void
 276 Selection::setOriginalId(int i, int id)
 277 {
 278     data().rawPositions_.m.mapid[i] = id;
 279     data().rawPositions_.m.orgid[i] = id;
 280 }
 281
 282
 283 int
 284 Selection::initOriginalIdsToGroup(t_topology *top, e_index_t type)
 285 {
 286     try
 287     {
 288         return gmx_ana_indexmap_init_orgid_group(&data().rawPositions_.m, top, type);
 289     }
 290     catch (const InconsistentInputError &)
 291     {
 292         GMX_ASSERT(type == INDEX_RES || type == INDEX_MOL,
 293                    "Expected that only grouping by residue/molecule would fail");
 294         std::string message =
 295             formatString("Cannot group selection '%s' into %s, because some "
 296                          "positions have atoms from more than one such group.",
 297                          name(), type == INDEX_MOL ? "molecules" : "residues");
 298         GMX_THROW(InconsistentInputError(message));
 299     }
 300 }
 301
 302
 303 void
 304 Selection::printInfo(FILE *fp) const
 305 {
 306     fprintf(fp, "\"%s\" (%d position%s, %d atom%s%s)", name(),
 307             posCount(),  posCount()  == 1 ? "" : "s",
 308             atomCount(), atomCount() == 1 ? "" : "s",
 309             isDynamic() ? ", dynamic" : "");
 310     fprintf(fp, "\n");
 311 }
 312
 313
 314 void
 315 Selection::printDebugInfo(FILE *fp, int nmaxind) const
 316 {
 317     const gmx_ana_pos_t &p = data().rawPositions_;
 318
 319     fprintf(fp, "  ");
 320     printInfo(fp);
 321     fprintf(fp, "    Group ");
 322     gmx_ana_index_t g;
 323     gmx_ana_index_set(&g, p.m.mapb.nra, p.m.mapb.a, 0);
 324     TextWriter      writer(fp);
 325     gmx_ana_index_dump(&writer, &g, nmaxind);
 326
 327     fprintf(fp, "    Block (size=%d):", p.m.mapb.nr);
 328     if (!p.m.mapb.index)
 329     {
 330         fprintf(fp, " (null)");
 331     }
 332     else
 333     {
 334         int n = p.m.mapb.nr;
 335         if (nmaxind >= 0 && n > nmaxind)
 336         {
 337             n = nmaxind;
 338         }
 339         for (int i = 0; i <= n; ++i)
 340         {
 341             fprintf(fp, " %d", p.m.mapb.index[i]);
 342         }
 343         if (n < p.m.mapb.nr)
 344         {
 345             fprintf(fp, " ...");
 346         }
 347     }
 348     fprintf(fp, "\n");
 349
 350     int n = posCount();
 351     if (nmaxind >= 0 && n > nmaxind)
 352     {
 353         n = nmaxind;
 354     }
 355     fprintf(fp, "    RefId:");
 356     if (!p.m.refid)
 357     {
 358         fprintf(fp, " (null)");
 359     }
 360     else
 361     {
 362         for (int i = 0; i < n; ++i)
 363         {
 364             fprintf(fp, " %d", p.m.refid[i]);
 365         }
 366         if (n < posCount())
 367         {
 368             fprintf(fp, " ...");
 369         }
 370     }
 371     fprintf(fp, "\n");
 372
 373     fprintf(fp, "    MapId:");
 374     if (!p.m.mapid)
 375     {
 376         fprintf(fp, " (null)");
 377     }
 378     else
 379     {
 380         for (int i = 0; i < n; ++i)
 381         {
 382             fprintf(fp, " %d", p.m.mapid[i]);
 383         }
 384         if (n < posCount())
 385         {
 386             fprintf(fp, " ...");
 387         }
 388     }
 389     fprintf(fp, "\n");
 390 }
 391
 392
 393 /********************************************************************
 394  * SelectionPosition
 395  */
 396
 397 SelectionPosition::operator AnalysisNeighborhoodPositions() const
 398 {
 399     AnalysisNeighborhoodPositions pos(sel_->rawPositions_.x,
 400                                       sel_->rawPositions_.count());
 401     if (sel_->hasOnlyAtoms())
 402     {
 403         // TODO: Move atomIndices() such that it can be reused here as well.
 404         pos.exclusionIds(constArrayRefFromArray<int>(sel_->rawPositions_.m.mapb.a,
 405                                                      sel_->rawPositions_.m.mapb.nra));
 406     }
 407     return pos.selectSingleFromArray(i_);
 408 }
 409
 410 } // namespace gmx