src/gromacs/selection/selmethod_impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, 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
  36 #ifndef GMX_SELECTION_SELMETHOD_IMPL_H
  37 #define GMX_SELECTION_SELMETHOD_IMPL_H
  38
  39 #include "selmethod.h"
  40
  41 /*
  42  * These global variables cannot be const because gmx_ana_selmethod_register()
  43  * modifies them to set some defaults. This is a small price to pay for the
  44  * convenience of not having to remember exactly how the selection compiler
  45  * expects the structures to be filled, and even more so if the expectations
  46  * change. Also, even if the gmx_ana_selmethod_t structures were made const,
  47  * the parameters could not be without typecasts somewhere, because the param
  48  * field in gmx_ana_selmethod_t cannot be declared const.
  49  *
  50  * Even though the variables may be modified, this should be thread-safe as
  51  * modifications are done only in gmx_ana_selmethod_register(), and it should
  52  * work even if called more than once for the same structure, and even if
  53  * called concurrently from multiple threads (as long as the selection
  54  * collection is not the same).
  55  *
  56  * All of these problems should go away if/when the selection methods are
  57  * implemented as C++ classes.
  58  */
  59
  60 /* From sm_com.c */
  61 extern gmx_ana_selmethod_t sm_cog;
  62 extern gmx_ana_selmethod_t sm_com;
  63 /* From sm_simple.c */
  64 extern gmx_ana_selmethod_t sm_all;
  65 extern gmx_ana_selmethod_t sm_none;
  66 extern gmx_ana_selmethod_t sm_atomnr;
  67 extern gmx_ana_selmethod_t sm_resnr;
  68 extern gmx_ana_selmethod_t sm_resindex;
  69 extern gmx_ana_selmethod_t sm_molindex;
  70 extern gmx_ana_selmethod_t sm_atomname;
  71 extern gmx_ana_selmethod_t sm_pdbatomname;
  72 extern gmx_ana_selmethod_t sm_atomtype;
  73 extern gmx_ana_selmethod_t sm_resname;
  74 extern gmx_ana_selmethod_t sm_insertcode;
  75 extern gmx_ana_selmethod_t sm_chain;
  76 extern gmx_ana_selmethod_t sm_mass;
  77 extern gmx_ana_selmethod_t sm_charge;
  78 extern gmx_ana_selmethod_t sm_altloc;
  79 extern gmx_ana_selmethod_t sm_occupancy;
  80 extern gmx_ana_selmethod_t sm_betafactor;
  81 extern gmx_ana_selmethod_t sm_x;
  82 extern gmx_ana_selmethod_t sm_y;
  83 extern gmx_ana_selmethod_t sm_z;
  84 /* From sm_distance.c */
  85 extern gmx_ana_selmethod_t sm_distance;
  86 extern gmx_ana_selmethod_t sm_mindistance;
  87 extern gmx_ana_selmethod_t sm_within;
  88 /* From sm_insolidangle.c */
  89 extern gmx_ana_selmethod_t sm_insolidangle;
  90 /* From sm_same.c */
  91 extern gmx_ana_selmethod_t sm_same;
  92
  93 /* From sm_merge.c */
  94 extern gmx_ana_selmethod_t sm_merge;
  95 extern gmx_ana_selmethod_t sm_plus;
  96 /* From sm_permute.c */
  97 extern gmx_ana_selmethod_t sm_permute;
  98
  99 #endif