src/gromacs/selection/sm_distance.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,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
  37  * Implements distance-based selection methods.
  38  *
  39  * This file implements the \p distance, \p mindistance and \p within
  40  * selection methods.
  41  *
  42  * \author Teemu Murtola <teemu.murtola@gmail.com>
  43  * \ingroup module_selection
  44  */
  45 #include "gromacs/legacyheaders/macros.h"
  46 #include "gromacs/legacyheaders/pbc.h"
  47 #include "gromacs/legacyheaders/vec.h"
  48
  49 #include "gromacs/selection/nbsearch.h"
  50 #include "gromacs/selection/position.h"
  51 #include "gromacs/selection/selmethod.h"
  52 #include "gromacs/utility/exceptions.h"
  53
  54 /*! \internal
  55  * \brief
  56  * Data structure for distance-based selection method.
  57  *
  58  * The same data structure is used by all the distance-based methods.
  59  *
  60  * \ingroup module_selection
  61  */
  62 struct t_methoddata_distance
  63 {
  64     t_methoddata_distance() : cutoff(-1.0)
  65     {
  66     }
  67
  68     /** Cutoff distance. */
  69     real                             cutoff;
  70     /** Positions of the reference points. */
  71     gmx_ana_pos_t                    p;
  72     /** Neighborhood search data. */
  73     gmx::AnalysisNeighborhood        nb;
  74     /** Neighborhood search for an invididual frame. */
  75     gmx::AnalysisNeighborhoodSearch  nbsearch;
  76 };
  77
  78 /*! \brief
  79  * Allocates data for distance-based selection methods.
  80  *
  81  * \param[in]     npar  Not used (should be 2).
  82  * \param[in,out] param Method parameters (should point to one of the distance
  83  *   parameter arrays).
  84  * \returns       Pointer to the allocated data (\c t_methoddata_distance).
  85  *
  86  * Allocates memory for a \c t_methoddata_distance structure and
  87  * initializes the parameter as follows:
  88  *  - the first parameter defines the value for
  89  *    \c t_methoddata_distance::cutoff.
  90  *  - the second parameter defines the reference positions and the value is
  91  *    stored in \c t_methoddata_distance::p.
  92  */
  93 static void *
  94 init_data_common(int npar, gmx_ana_selparam_t *param);
  95 /*! \brief
  96  * Initializes a distance-based selection method.
  97  *
  98  * \param   top   Not used.
  99  * \param   npar  Not used (should be 2).
 100  * \param   param Method parameters (should point to one of the distance
 101  *   parameter arrays).
 102  * \param   data  Pointer to \c t_methoddata_distance to initialize.
 103  * \returns 0 on success, a non-zero error code on failure.
 104  *
 105  * Initializes the neighborhood search data structure
 106  * (\c t_methoddata_distance::nb).
 107  * Also checks that the cutoff is valid.
 108  */
 109 static void
 110 init_common(t_topology *top, int npar, gmx_ana_selparam_t *param, void *data);
 111 /** Frees the data allocated for a distance-based selection method. */
 112 static void
 113 free_data_common(void *data);
 114 /*! \brief
 115  * Initializes the evaluation of a distance-based within selection method for a
 116  * frame.
 117  *
 118  * \param[in]  top  Not used.
 119  * \param[in]  fr   Current frame.
 120  * \param[in]  pbc  PBC structure.
 121  * \param      data Should point to a \c t_methoddata_distance.
 122  * \returns    0 on success, a non-zero error code on error.
 123  *
 124  * Initializes the neighborhood search for the current frame.
 125  */
 126 static void
 127 init_frame_common(t_topology *top, t_trxframe * fr, t_pbc *pbc, void *data);
 128 /** Evaluates the \p distance selection method. */
 129 static void
 130 evaluate_distance(t_topology * /* top */, t_trxframe * /* fr */, t_pbc * /* pbc */,
 131                   gmx_ana_pos_t *pos, gmx_ana_selvalue_t *out, void *data);
 132 /** Evaluates the \p within selection method. */
 133 static void
 134 evaluate_within(t_topology * /* top */, t_trxframe * /* fr */, t_pbc * /* pbc */,
 135                 gmx_ana_pos_t *pos, gmx_ana_selvalue_t *out, void *data);
 136
 137 /** Parameters for the \p distance selection method. */
 138 static gmx_ana_selparam_t smparams_distance[] = {
 139     {"cutoff", {REAL_VALUE, 1, {NULL}}, NULL, SPAR_OPTIONAL},
 140     {"from",   {POS_VALUE,  1, {NULL}}, NULL, SPAR_DYNAMIC},
 141 };
 142
 143 /** Parameters for the \p mindistance selection method. */
 144 static gmx_ana_selparam_t smparams_mindistance[] = {
 145     {"cutoff", {REAL_VALUE, 1, {NULL}}, NULL, SPAR_OPTIONAL},
 146     {"from",   {POS_VALUE, -1, {NULL}}, NULL, SPAR_DYNAMIC | SPAR_VARNUM},
 147 };
 148
 149 /** Parameters for the \p within selection method. */
 150 static gmx_ana_selparam_t smparams_within[] = {
 151     {NULL, {REAL_VALUE,  1, {NULL}}, NULL, 0},
 152     {"of", {POS_VALUE,  -1, {NULL}}, NULL, SPAR_DYNAMIC | SPAR_VARNUM},
 153 };
 154
 155 /** Help text for the distance selection methods. */
 156 static const char *help_distance[] = {
 157     "DISTANCE-BASED SELECTION KEYWORDS[PAR]",
 158
 159     "[TT]distance from POS [cutoff REAL][tt][BR]",
 160     "[TT]mindistance from POS_EXPR [cutoff REAL][tt][BR]",
 161     "[TT]within REAL of POS_EXPR[tt][PAR]",
 162
 163     "[TT]distance[tt] and [TT]mindistance[tt] calculate the distance from the",
 164     "given position(s), the only difference being in that [TT]distance[tt]",
 165     "only accepts a single position, while any number of positions can be",
 166     "given for [TT]mindistance[tt], which then calculates the distance to the",
 167     "closest position.",
 168     "[TT]within[tt] directly selects atoms that are within [TT]REAL[tt] of",
 169     "[TT]POS_EXPR[tt].[PAR]",
 170
 171     "For the first two keywords, it is possible to specify a cutoff to speed",
 172     "up the evaluation: all distances above the specified cutoff are",
 173     "returned as equal to the cutoff.",
 174 };
 175
 176 /** Selection method data for the \p distance method. */
 177 gmx_ana_selmethod_t sm_distance = {
 178     "distance", REAL_VALUE, SMETH_DYNAMIC,
 179     asize(smparams_distance), smparams_distance,
 180     &init_data_common,
 181     NULL,
 182     &init_common,
 183     NULL,
 184     &free_data_common,
 185     &init_frame_common,
 186     NULL,
 187     &evaluate_distance,
 188     {"distance from POS [cutoff REAL]", asize(help_distance), help_distance},
 189 };
 190
 191 /** Selection method data for the \p distance method. */
 192 gmx_ana_selmethod_t sm_mindistance = {
 193     "mindistance", REAL_VALUE, SMETH_DYNAMIC,
 194     asize(smparams_mindistance), smparams_mindistance,
 195     &init_data_common,
 196     NULL,
 197     &init_common,
 198     NULL,
 199     &free_data_common,
 200     &init_frame_common,
 201     NULL,
 202     &evaluate_distance,
 203     {"mindistance from POS_EXPR [cutoff REAL]", asize(help_distance), help_distance},
 204 };
 205
 206 /** Selection method data for the \p within method. */
 207 gmx_ana_selmethod_t sm_within = {
 208     "within", GROUP_VALUE, SMETH_DYNAMIC,
 209     asize(smparams_within), smparams_within,
 210     &init_data_common,
 211     NULL,
 212     &init_common,
 213     NULL,
 214     &free_data_common,
 215     &init_frame_common,
 216     NULL,
 217     &evaluate_within,
 218     {"within REAL of POS_EXPR", asize(help_distance), help_distance},
 219 };
 220
 221 static void *
 222 init_data_common(int /* npar */, gmx_ana_selparam_t *param)
 223 {
 224     t_methoddata_distance *data = new t_methoddata_distance();
 225     param[0].val.u.r = &data->cutoff;
 226     param[1].val.u.p = &data->p;
 227     return data;
 228 }
 229
 230 static void
 231 init_common(t_topology * /* top */, int /* npar */, gmx_ana_selparam_t *param, void *data)
 232 {
 233     t_methoddata_distance *d = (t_methoddata_distance *)data;
 234
 235     if ((param[0].flags & SPAR_SET) && d->cutoff <= 0)
 236     {
 237         GMX_THROW(gmx::InvalidInputError("Distance cutoff should be > 0"));
 238     }
 239     d->nb.setCutoff(d->cutoff);
 240 }
 241
 242 /*!
 243  * \param data Data to free (should point to a \c t_methoddata_distance).
 244  *
 245  * Frees the memory allocated for \c t_methoddata_distance::xref and
 246  * \c t_methoddata_distance::nb.
 247  */
 248 static void
 249 free_data_common(void *data)
 250 {
 251     delete static_cast<t_methoddata_distance *>(data);
 252 }
 253
 254 static void
 255 init_frame_common(t_topology * /* top */, t_trxframe * /* fr */, t_pbc *pbc, void *data)
 256 {
 257     t_methoddata_distance *d = (t_methoddata_distance *)data;
 258
 259     d->nbsearch.reset();
 260     gmx::AnalysisNeighborhoodPositions pos(d->p.x, d->p.count());
 261     d->nbsearch = d->nb.initSearch(pbc, pos);
 262 }
 263
 264 /*!
 265  * See sel_updatefunc_pos() for description of the parameters.
 266  * \p data should point to a \c t_methoddata_distance.
 267  *
 268  * Calculates the distance of each position from \c t_methoddata_distance::p
 269  * and puts them in \p out->u.r.
 270  */
 271 static void
 272 evaluate_distance(t_topology * /* top */, t_trxframe * /* fr */, t_pbc * /* pbc */,
 273                   gmx_ana_pos_t *pos, gmx_ana_selvalue_t *out, void *data)
 274 {
 275     t_methoddata_distance *d = (t_methoddata_distance *)data;
 276
 277     out->nr = pos->m.mapb.nra;
 278     for (int b = 0; b < pos->count(); ++b)
 279     {
 280         real dist = d->nbsearch.minimumDistance(pos->x[b]);
 281         for (int i = pos->m.mapb.index[b]; i < pos->m.mapb.index[b+1]; ++i)
 282         {
 283             out->u.r[i] = dist;
 284         }
 285     }
 286 }
 287
 288 /*!
 289  * See sel_updatefunc() for description of the parameters.
 290  * \p data should point to a \c t_methoddata_distance.
 291  *
 292  * Finds the atoms that are closer than the defined cutoff to
 293  * \c t_methoddata_distance::xref and puts them in \p out.g.
 294  */
 295 static void
 296 evaluate_within(t_topology * /* top */, t_trxframe * /* fr */, t_pbc * /* pbc */,
 297                 gmx_ana_pos_t *pos, gmx_ana_selvalue_t *out, void *data)
 298 {
 299     t_methoddata_distance *d = (t_methoddata_distance *)data;
 300
 301     out->u.g->isize = 0;
 302     for (int b = 0; b < pos->count(); ++b)
 303     {
 304         if (d->nbsearch.isWithin(pos->x[b]))
 305         {
 306             gmx_ana_pos_add_to_group(out->u.g, pos, b);
 307         }
 308     }
 309 }