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