src/gromacs/mdtypes/atominfo.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2021, 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 /*! \libinternal \file
  36  *
  37  * \brief This file makes declarations used for storing bitfields
  38  * describing each atom so that other modules can efficiently process
  39  * them.
  40  *
  41  * \inlibraryapi
  42  */
  43
  44 #ifndef GMX_MDTYPES_ATOMINFO_H
  45 #define GMX_MDTYPES_ATOMINFO_H
  46
  47 #include <vector>
  48
  49 namespace gmx
  50 {
  51
  52 /*! \brief Constants whose bit describes a property of an atom in
  53  * AtomInfoWithinMoleculeBlock.atomInfo.
  54  *
  55  * No bit should exceed 1 << 63, so that it fits into a 64-bit
  56  * integer.
  57  *
  58  * Since the tpx format support max 256 energy groups, we do the same
  59  * here, reserving bits 0-7 for the energy-group ID.
  60  */
  61 //! \{
  62 static constexpr int64_t sc_atomInfo_FreeEnergyPerturbation = 1 << 15;
  63 static constexpr int64_t sc_atomInfo_Exclusion              = 1 << 17;
  64 static constexpr int64_t sc_atomInfo_Constraint             = 1 << 20;
  65 static constexpr int64_t sc_atomInfo_Settle                 = 1 << 21;
  66 static constexpr int64_t sc_atomInfo_BondCommunication      = 1 << 22;
  67 static constexpr int64_t sc_atomInfo_HasVdw                 = 1 << 23;
  68 static constexpr int64_t sc_atomInfo_HasCharge              = 1 << 24;
  69 //! \}
  70 //! The first 8 bits are reserved for energy-group ID
  71 static constexpr int64_t sc_atomInfo_EnergyGroupIdMask = 0b11111111;
  72
  73 /*! \brief Contains information about each atom in a molecule block of
  74  * the global topology. */
  75 struct AtomInfoWithinMoleculeBlock
  76 {
  77     //! Index within the system of the first atom in the molecule block
  78     int indexOfFirstAtomInMoleculeBlock = 0;
  79     //! Index within the system of the last atom in the molecule block
  80     int indexOfLastAtomInMoleculeBlock = 0;
  81     /*! \brief Atom info for each atom in the block.
  82      *
  83      * The typical case is that all atoms are identical for each
  84      * molecule of the block, and if so this vector has size equal to
  85      * the number of atoms in the molecule.
  86      *
  87      * An example of an atypical case is QM/MM, where multiple
  88      * molecules might be present and different molecules have
  89      * different atoms within any one QM group or region. Now there are
  90      * multiple kinds of molecules with the same connectivity, so we simply
  91      * write out the atom info for the entire molecule block. Then the
  92      * size equals the product of the number of atoms in the
  93      * molecule and the number of molecules.
  94      *
  95      * The vector needs to be indexed accordingly.
  96      */
  97     std::vector<int64_t> atomInfo;
  98 };
  99
 100 } // namespace gmx
 101
 102 #endif