src/gromacs/selection/selectionenums.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \file
  32  * \brief
  33  * Declares common types used in selections.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_selection
  37  */
  38 #ifndef GMX_SELECTION_SELECTIONENUMS_H
  39 #define GMX_SELECTION_SELECTIONENUMS_H
  40
  41 #include "../utility/flags.h"
  42
  43 /*! \brief
  44  * Defines the type of covered fraction.
  45  *
  46  * \inpublicapi
  47  */
  48 typedef enum
  49 {
  50     CFRAC_NONE,         /**< No covered fraction (everything covered). */
  51     CFRAC_SOLIDANGLE    /**< Fraction of a solid (3D) angle covered. */
  52 } e_coverfrac_t;
  53
  54 namespace gmx
  55 {
  56
  57 /*! \cond internal */
  58 /*! \internal \brief
  59  * Flags for options.
  60  *
  61  * These flags are not part of the public interface, even though they are in an
  62  * installed header.  They are needed in the implementation of SelectionOption.
  63  */
  64 enum SelectionFlag
  65 {
  66     efSelection_OnlyStatic              = 1<<0,
  67     efSelection_OnlyAtoms               = 1<<1,
  68     //! Whether ::POS_MASKONLY should be used for output position evaluation.
  69     efSelection_DynamicMask             = 1<<2,
  70     efSelection_DynamicOnlyWhole        = 1<<3,
  71     //! Whether velocities of output positions should be evaluated.
  72     efSelection_EvaluateVelocities      = 1<<5,
  73     //! Whether forces on output positions should be evaluated.
  74     efSelection_EvaluateForces          = 1<<6,
  75 };
  76
  77 //! \internal Holds a collection of ::SelectionFlag values.
  78 typedef FlagsTemplate<SelectionFlag> SelectionFlags;
  79 //! \endcond
  80
  81 }
  82
  83 #endif