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