src/gromacs/selection/sm_position.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2011,2012,2013, 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 position evaluation selection methods.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 #include "gromacs/legacyheaders/macros.h"
  43 #include "gromacs/legacyheaders/smalloc.h"
  44 #include "gromacs/legacyheaders/string2.h"
  45
  46 #include "gromacs/selection/indexutil.h"
  47 #include "gromacs/selection/poscalc.h"
  48 #include "gromacs/selection/position.h"
  49 #include "gromacs/selection/selmethod.h"
  50
  51 #include "keywords.h"
  52 #include "selelem.h"
  53
  54 /*! \internal \brief
  55  * Data structure for position keyword evaluation.
  56  */
  57 typedef struct
  58 {
  59     /** Position calculation collection to use. */
  60     gmx::PositionCalculationCollection *pcc;
  61     /** Index group for which the center should be evaluated. */
  62     gmx_ana_index_t                     g;
  63     /** Position evaluation data structure. */
  64     gmx_ana_poscalc_t                  *pc;
  65     /** true if periodic boundary conditions should be used. */
  66     bool                                bPBC;
  67     /** Type of positions to calculate. */
  68     char                               *type;
  69     /** Flags for the position calculation. */
  70     int                                 flags;
  71 } t_methoddata_pos;
  72
  73 /** Allocates data for position evaluation selection methods. */
  74 static void *
  75 init_data_pos(int npar, gmx_ana_selparam_t *param);
  76 /** Sets the position calculation collection for position evaluation selection methods. */
  77 static void
  78 set_poscoll_pos(gmx::PositionCalculationCollection *pcc, void *data);
  79 /*! \brief
  80  * Initializes position evaluation keywords.
  81  *
  82  * \param[in] top   Not used.
  83  * \param[in] npar  Not used.
  84  * \param[in] param Not used.
  85  * \param[in,out] data  Should point to \c t_methoddata_pos.
  86  * \returns       0 on success, a non-zero error code on error.
  87  *
  88  * The \c t_methoddata_pos::type field should have been initialized
  89  * externally using _gmx_selelem_set_kwpos_type().
  90  */
  91 static void
  92 init_kwpos(t_topology *top, int npar, gmx_ana_selparam_t *param, void *data);
  93 /*! Initializes the \p cog selection method.
  94  *
  95  * \param[in]     top   Topology data structure.
  96  * \param[in]     npar  Not used.
  97  * \param[in]     param Not used.
  98  * \param[in,out] data  Should point to \c t_methoddata_pos.
  99  * \returns       0 on success, a non-zero error code on error.
 100  */
 101 static void
 102 init_cog(t_topology *top, int npar, gmx_ana_selparam_t *param, void *data);
 103 /*! \brief
 104  * Initializes the \p cog selection method.
 105  *
 106  * \param[in]     top   Topology data structure.
 107  * \param[in]     npar  Not used.
 108  * \param[in]     param Not used.
 109  * \param[in,out] data  Should point to \c t_methoddata_pos.
 110  * \returns       0 on success, a non-zero error code on error.
 111  */
 112 static void
 113 init_com(t_topology *top, int npar, gmx_ana_selparam_t *param, void *data);
 114 /*! \brief
 115  * Initializes output for position evaluation selection methods.
 116  *
 117  * \param[in]     top   Topology data structure.
 118  * \param[in,out] out   Pointer to output data structure.
 119  * \param[in,out] data  Should point to \c t_methoddata_pos.
 120  * \returns       0 for success.
 121  */
 122 static void
 123 init_output_pos(t_topology *top, gmx_ana_selvalue_t *out, void *data);
 124 /** Frees the data allocated for position evaluation selection methods. */
 125 static void
 126 free_data_pos(void *data);
 127 /** Evaluates position evaluation selection methods. */
 128 static void
 129 evaluate_pos(t_topology * /* top */, t_trxframe *fr, t_pbc *pbc, gmx_ana_index_t * /* g */, gmx_ana_selvalue_t *out, void *data);
 130
 131 /** Parameters for position keyword evaluation. */
 132 static gmx_ana_selparam_t smparams_keyword_pos[] = {
 133     {NULL,   {GROUP_VALUE, 1, {NULL}}, NULL, SPAR_DYNAMIC},
 134 };
 135
 136 /** Parameters for the \p cog and \p com selection methods. */
 137 static gmx_ana_selparam_t smparams_com[] = {
 138     {"of",   {GROUP_VALUE, 1, {NULL}}, NULL, SPAR_DYNAMIC},
 139     {"pbc",  {NO_VALUE,    0, {NULL}}, NULL, 0},
 140 };
 141
 142 /** \internal Selection method data for position keyword evaluation. */
 143 gmx_ana_selmethod_t sm_keyword_pos = {
 144     "kw_pos", POS_VALUE, SMETH_DYNAMIC | SMETH_VARNUMVAL,
 145     asize(smparams_keyword_pos), smparams_keyword_pos,
 146     &init_data_pos,
 147     &set_poscoll_pos,
 148     &init_kwpos,
 149     &init_output_pos,
 150     &free_data_pos,
 151     NULL,
 152     &evaluate_pos,
 153     NULL,
 154     {NULL, 0, NULL},
 155 };
 156
 157 /** \internal Selection method data for the \p cog method. */
 158 gmx_ana_selmethod_t sm_cog = {
 159     "cog", POS_VALUE, SMETH_DYNAMIC | SMETH_SINGLEVAL,
 160     asize(smparams_com), smparams_com,
 161     &init_data_pos,
 162     &set_poscoll_pos,
 163     &init_cog,
 164     &init_output_pos,
 165     &free_data_pos,
 166     NULL,
 167     &evaluate_pos,
 168     NULL,
 169     {"cog of ATOM_EXPR [pbc]", 0, NULL},
 170 };
 171
 172 /** \internal Selection method data for the \p com method. */
 173 gmx_ana_selmethod_t sm_com = {
 174     "com", POS_VALUE, SMETH_REQTOP | SMETH_DYNAMIC | SMETH_SINGLEVAL,
 175     asize(smparams_com), smparams_com,
 176     &init_data_pos,
 177     &set_poscoll_pos,
 178     &init_com,
 179     &init_output_pos,
 180     &free_data_pos,
 181     NULL,
 182     &evaluate_pos,
 183     NULL,
 184     {"com of ATOM_EXPR [pbc]", 0, NULL},
 185 };
 186
 187 /*!
 188  * \param[in]     npar  Should be 1 or 2.
 189  * \param[in,out] param Method parameters (should point to
 190  *   \ref smparams_keyword_pos or \ref smparams_com).
 191  * \returns       Pointer to the allocated data (\c t_methoddata_pos).
 192  *
 193  * Allocates memory for a \c t_methoddata_pos structure and initializes
 194  * the first parameter to define the value for \c t_methoddata_pos::g.
 195  * If a second parameter is present, it is used for setting the
 196  * \c t_methoddata_pos::bPBC flag.
 197  */
 198 static void *
 199 init_data_pos(int npar, gmx_ana_selparam_t *param)
 200 {
 201     t_methoddata_pos *data;
 202
 203     snew(data, 1);
 204     param[0].val.u.g = &data->g;
 205     if (npar > 1)
 206     {
 207         param[1].val.u.b = &data->bPBC;
 208     }
 209     data->pc       = NULL;
 210     data->bPBC     = false;
 211     data->type     = NULL;
 212     data->flags    = -1;
 213     return data;
 214 }
 215
 216 /*!
 217  * \param[in]     pcc   Position calculation collection to use.
 218  * \param[in,out] data  Should point to \c t_methoddata_pos.
 219  */
 220 static void
 221 set_poscoll_pos(gmx::PositionCalculationCollection *pcc, void *data)
 222 {
 223     ((t_methoddata_pos *)data)->pcc = pcc;
 224 }
 225
 226 /*!
 227  * \param[in,out] sel   Selection element to initialize.
 228  * \param[in]     type  One of the enum values acceptable for
 229  *     PositionCalculationCollection::typeFromEnum().
 230  *
 231  * Initializes the reference position type for position evaluation.
 232  * If called multiple times, the first setting takes effect, and later calls
 233  * are neglected.
 234  */
 235 void
 236 _gmx_selelem_set_kwpos_type(gmx::SelectionTreeElement *sel, const char *type)
 237 {
 238     t_methoddata_pos *d = (t_methoddata_pos *)sel->u.expr.mdata;
 239
 240     if (sel->type != SEL_EXPRESSION || !sel->u.expr.method
 241         || sel->u.expr.method->name != sm_keyword_pos.name)
 242     {
 243         return;
 244     }
 245     if (!d->type && type)
 246     {
 247         d->type  = strdup(type);
 248         /* FIXME: It would be better not to have the string here hardcoded. */
 249         if (type[0] != 'a')
 250         {
 251             sel->u.expr.method->flags |= SMETH_REQTOP;
 252         }
 253     }
 254 }
 255
 256 /*!
 257  * \param[in,out] sel   Selection element to initialize.
 258  * \param[in]     flags Default completion flags
 259  *     (see PositionCalculationCollection::typeFromEnum()).
 260  *
 261  * Initializes the flags for position evaluation.
 262  * If called multiple times, the first setting takes effect, and later calls
 263  * are neglected.
 264  */
 265 void
 266 _gmx_selelem_set_kwpos_flags(gmx::SelectionTreeElement *sel, int flags)
 267 {
 268     t_methoddata_pos *d = (t_methoddata_pos *)sel->u.expr.mdata;
 269
 270     if (sel->type != SEL_EXPRESSION || !sel->u.expr.method
 271         || sel->u.expr.method->name != sm_keyword_pos.name)
 272     {
 273         return;
 274     }
 275     if (d->flags == -1)
 276     {
 277         d->flags = flags;
 278     }
 279 }
 280
 281 static void
 282 init_kwpos(t_topology * /* top */, int /* npar */, gmx_ana_selparam_t *param, void *data)
 283 {
 284     t_methoddata_pos *d = (t_methoddata_pos *)data;
 285
 286     if (!(param[0].flags & SPAR_DYNAMIC))
 287     {
 288         d->flags &= ~(POS_DYNAMIC | POS_MASKONLY);
 289     }
 290     else if (!(d->flags & POS_MASKONLY))
 291     {
 292         d->flags |= POS_DYNAMIC;
 293     }
 294     d->pc = d->pcc->createCalculationFromEnum(d->type, d->flags);
 295     gmx_ana_poscalc_set_maxindex(d->pc, &d->g);
 296 }
 297
 298 static void
 299 init_cog(t_topology * /* top */, int /* npar */, gmx_ana_selparam_t *param, void *data)
 300 {
 301     t_methoddata_pos *d = (t_methoddata_pos *)data;
 302
 303     d->flags = (param[0].flags & SPAR_DYNAMIC) ? POS_DYNAMIC : 0;
 304     d->pc    = d->pcc->createCalculation(d->bPBC ? POS_ALL_PBC : POS_ALL, d->flags);
 305     gmx_ana_poscalc_set_maxindex(d->pc, &d->g);
 306 }
 307
 308 static void
 309 init_com(t_topology * /* top */, int /* npar */, gmx_ana_selparam_t *param, void *data)
 310 {
 311     t_methoddata_pos *d = (t_methoddata_pos *)data;
 312
 313     d->flags  = (param[0].flags & SPAR_DYNAMIC) ? POS_DYNAMIC : 0;
 314     d->flags |= POS_MASS;
 315     d->pc     = d->pcc->createCalculation(d->bPBC ? POS_ALL_PBC : POS_ALL, d->flags);
 316     gmx_ana_poscalc_set_maxindex(d->pc, &d->g);
 317 }
 318
 319 static void
 320 init_output_pos(t_topology * /* top */, gmx_ana_selvalue_t *out, void *data)
 321 {
 322     t_methoddata_pos *d = (t_methoddata_pos *)data;
 323
 324     gmx_ana_poscalc_init_pos(d->pc, out->u.p);
 325 }
 326
 327 /*!
 328  * \param data Data to free (should point to a \c t_methoddata_pos).
 329  *
 330  * Frees the memory allocated for \c t_methoddata_pos::g and
 331  * \c t_methoddata_pos::pc.
 332  */
 333 static void
 334 free_data_pos(void *data)
 335 {
 336     t_methoddata_pos *d = (t_methoddata_pos *)data;
 337
 338     sfree(d->type);
 339     gmx_ana_poscalc_free(d->pc);
 340     sfree(d);
 341 }
 342
 343 /*!
 344  * See sel_updatefunc() for description of the parameters.
 345  * \p data should point to a \c t_methoddata_pos.
 346  *
 347  * Calculates the positions using \c t_methoddata_pos::pc for the index group
 348  * in \c t_methoddata_pos::g and stores the results in \p out->u.p.
 349  */
 350 static void
 351 evaluate_pos(t_topology * /* top */, t_trxframe *fr, t_pbc *pbc,
 352              gmx_ana_index_t * /* g */, gmx_ana_selvalue_t *out, void *data)
 353 {
 354     t_methoddata_pos *d = (t_methoddata_pos *)data;
 355
 356     gmx_ana_poscalc_update(d->pc, out->u.p, &d->g, fr, pbc);
 357 }