src/gromacs/topology/exclusionblocks.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_TOPOLOGY_EXCLUSIONBLOCKS_H
  37 #define GMX_TOPOLOGY_EXCLUSIONBLOCKS_H
  38
  39 #include <vector>
  40
  41 #include "gromacs/utility/arrayref.h"
  42
  43 struct t_blocka;
  44
  45 namespace gmx
  46 {
  47
  48 /*! \libinternal \brief
  49  * Describes exclusions for a single atom.
  50  */
  51 struct ExclusionBlock
  52 {
  53     //! Atom numbers for exclusion.
  54     std::vector<int> atomNumber;
  55     //! Number of atoms in the exclusion.
  56     int nra() const { return atomNumber.size(); }
  57 };
  58
  59 /*! \brief Merge the contents of \c b2 into \c excl.
  60  *
  61  * Requires that \c b2 and \c excl describe the same number of
  62  * particles, if \c b2 describes a non-zero number.
  63  */
  64 void mergeExclusions(t_blocka* excl, gmx::ArrayRef<ExclusionBlock> b2);
  65
  66 /*! \brief
  67  * Convert the exclusions.
  68  *
  69  * Convert t_blocka exclusions in \p b into ExclusionBlock form and
  70  * include them in \p b2.
  71  *
  72  * \param[in] b Exclusions in t_blocka form.
  73  * \param[inout] b2 ExclusionBlocks to populate with t_blocka exclusions.
  74  */
  75 void blockaToExclusionBlocks(const t_blocka* b, gmx::ArrayRef<ExclusionBlock> b2);
  76
  77 //! Convert the exclusions expressed in \c b into t_blocka form
  78 void exclusionBlocksToBlocka(gmx::ArrayRef<const ExclusionBlock> b2, t_blocka* b);
  79
  80 } // namespace gmx
  81
  82 #endif