src/gromacs/mdtypes/locality.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \libinternal \file
  37  * \brief Defines atom and atom interaction locality enums
  38  *
  39  * \author Berk Hess <hess@kth.se>
  40  * \ingroup module_mdtypes
  41  */
  42
  43 #ifndef GMX_MDTYPES_LOCALITY_H
  44 #define GMX_MDTYPES_LOCALITY_H
  45
  46 #include "gromacs/utility/enumerationhelpers.h"
  47
  48 namespace gmx
  49 {
  50
  51 /*! \brief Atom locality indicator: local, non-local, all.
  52  *
  53  * Used for calls to:
  54  * gridding, force calculation, x/f buffer operations
  55  */
  56 enum class AtomLocality : int
  57 {
  58     Local    = 0, //!< Local atoms
  59     NonLocal = 1, //!< Non-local atoms
  60     All      = 2, //!< Both local and non-local atoms
  61     Count    = 3  //!< The number of atom locality types
  62 };
  63
  64 /*! \brief Descriptive strings for atom localities */
  65 static const EnumerationArray<AtomLocality, const char *> c_atomLocalityNames = { "local", "non-local", "all" };
  66
  67 /*! \brief Interaction locality indicator: local, non-local, all.
  68  *
  69  * Used for calls to:
  70  * pair-search, force calculation, x/f buffer operations
  71  */
  72 enum class InteractionLocality : int
  73 {
  74     Local    = 0, //!< Interactions between local atoms only
  75     NonLocal = 1, //!< Interactions between non-local and (non-)local atoms
  76     Count    = 2  //!< The number of interaction locality types
  77 };
  78
  79 /*! \brief Descriptive strings for interaction localities */
  80 static const EnumerationArray<InteractionLocality, const char *> c_interactionLocalityNames = { "local", "non-local" };
  81
  82 }      // namespace gmx
  83
  84 #endif // GMX_MDTYPES_LOCALITY_H