src/gromacs/selection/selectionenums.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2012,2013,2014,2015,2016,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 /*! \file
  36  * \brief
  37  * Declares common types used in selections.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 #ifndef GMX_SELECTION_SELECTIONENUMS_H
  43 #define GMX_SELECTION_SELECTIONENUMS_H
  44
  45 #include "gromacs/utility/flags.h"
  46
  47 /*! \brief
  48  * Defines the type of covered fraction.
  49  *
  50  * \inpublicapi
  51  */
  52 typedef enum
  53 {
  54     CFRAC_NONE,      /**< No covered fraction (everything covered). */
  55     CFRAC_SOLIDANGLE /**< Fraction of a solid (3D) angle covered. */
  56 } e_coverfrac_t;
  57
  58 namespace gmx
  59 {
  60
  61 /*! \cond internal */
  62 /*! \brief
  63  * Flags for options.
  64  *
  65  * These flags are not part of the public interface, even though they are in an
  66  * installed header.  They are needed in the implementation of SelectionOption.
  67  */
  68 enum SelectionFlag
  69 {
  70     efSelection_OnlyStatic = 1 << 0,
  71     efSelection_OnlyAtoms  = 1 << 1,
  72     efSelection_OnlySorted = 1 << 2,
  73     //! Whether ::POS_MASKONLY should be used for output position evaluation.
  74     efSelection_DynamicMask = 1 << 3,
  75     //! If set, unconditionally empty selections result in compilation errors.
  76     efSelection_DisallowEmpty = 1 << 4,
  77     //! Whether velocities of output positions should be evaluated.
  78     efSelection_EvaluateVelocities = 1 << 5,
  79     //! Whether forces on output positions should be evaluated.
  80     efSelection_EvaluateForces = 1 << 6,
  81 };
  82
  83 //! Holds a collection of ::SelectionFlag values.
  84 typedef FlagsTemplate<SelectionFlag> SelectionFlags;
  85 //! \endcond
  86
  87 /*! \brief
  88  * Describes topology properties required for selection evaluation.
  89  *
  90  * See SelectionCollection::requiredTopologyProperties().
  91  *
  92  * \inpublicapi
  93  * \ingroup module_selection
  94  */
  95 struct SelectionTopologyProperties
  96 {
  97     //! Returns a property object that requires generic topology info.
  98     static SelectionTopologyProperties topology()
  99     {
 100         return SelectionTopologyProperties(true, false);
 101     }
 102     //! Returns a property object that requires atom masses.
 103     static SelectionTopologyProperties masses() { return SelectionTopologyProperties(true, true); }
 104
 105     //! Initializes properties that does not require anything.
 106     SelectionTopologyProperties() : needsTopology(false), needsMasses(false) {}
 107     //! Initializes properties with the given flags.
 108     SelectionTopologyProperties(bool needsTopology, bool needsMasses) :
 109         needsTopology(needsTopology),
 110         needsMasses(needsMasses)
 111     {
 112     }
 113
 114     //! Combines flags from another properties object to this.
 115     void merge(const SelectionTopologyProperties& other)
 116     {
 117         needsTopology = needsTopology || other.needsTopology;
 118         needsMasses   = needsMasses || other.needsMasses;
 119     }
 120     //! Whether all flags are `true` (for short-ciruiting logic).
 121     bool hasAll() const { return needsTopology && needsMasses; }
 122     //! Whether any flag is `true`.
 123     bool hasAny() const { return needsTopology || needsMasses; }
 124
 125     //! Whether topology information is needed for selection evaluation.
 126     bool needsTopology;
 127     //! Whether atom masses are needed for selection evaluation.
 128     bool needsMasses;
 129 };
 130
 131 } // namespace gmx
 132
 133 #endif