api/nblib/topologyhelpers.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020,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 /*! \internal \file
  36  * \brief
  37  * Implements nblib Topology helpers
  38  *
  39  * \author Victor Holanda <victor.holanda@cscs.ch>
  40  * \author Joe Jordan <ejjordan@kth.se>
  41  * \author Prashanth Kanduri <kanduri@cscs.ch>
  42  * \author Sebastian Keller <keller@cscs.ch>
  43  * \author Artem Zhmurov <zhmurov@gmail.com>
  44  */
  45
  46 #include <algorithm>
  47
  48 #include "gromacs/topology/exclusionblocks.h"
  49 #include "nblib/topologyhelpers.h"
  50
  51 namespace nblib
  52 {
  53
  54 std::vector<gmx::ExclusionBlock> toGmxExclusionBlock(const std::vector<std::tuple<int, int>>& tupleList)
  55 {
  56     std::vector<gmx::ExclusionBlock> ret;
  57
  58     auto firstLowerThan = [](auto const& tup1, auto const& tup2) {
  59         return std::get<0>(tup1) < std::get<0>(tup2);
  60     };
  61
  62     // Note this is a programming error as all particles should exclude at least themselves and empty topologies are not allowed.
  63     // Note also that this is also checked in the parent function with a more informative error message.
  64     assert((!tupleList.empty() && "No exclusions found.\n"));
  65
  66     // initialize pair of iterators delimiting the range of exclusions for
  67     // the first particle in the list
  68     auto range = std::equal_range(std::begin(tupleList), std::end(tupleList), tupleList[0], firstLowerThan);
  69     auto it1 = range.first;
  70     auto it2 = range.second;
  71
  72     // loop over all exclusions in molecule, linear in tupleList.size()
  73     while (it1 != std::end(tupleList))
  74     {
  75         gmx::ExclusionBlock localBlock;
  76         // loop over all exclusions for current particle
  77         for (; it1 != it2; ++it1)
  78         {
  79             localBlock.atomNumber.push_back(std::get<1>(*it1));
  80         }
  81
  82         ret.push_back(localBlock);
  83
  84         // update the upper bound of the range for the next particle
  85         if (it1 != end(tupleList))
  86         {
  87             it2 = std::upper_bound(it1, std::end(tupleList), *it1, firstLowerThan);
  88         }
  89     }
  90
  91     return ret;
  92 }
  93
  94 std::vector<gmx::ExclusionBlock> offsetGmxBlock(std::vector<gmx::ExclusionBlock> inBlock, int offset)
  95 {
  96     // shift particle numbers by offset
  97     for (auto& localBlock : inBlock)
  98     {
  99         std::transform(std::begin(localBlock.atomNumber),
 100                        std::end(localBlock.atomNumber),
 101                        std::begin(localBlock.atomNumber),
 102                        [offset](auto i) { return i + offset; });
 103     }
 104
 105     return inBlock;
 106 }
 107
 108 } // namespace nblib