src/gromacs/topology/atomsbuilder.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2016,2019,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  * \brief
  37  * Utility classes for manipulating \c t_atoms structures.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  */
  42 #ifndef GMX_TOPOLOGY_ATOMSBUILDER_H
  43 #define GMX_TOPOLOGY_ATOMSBUILDER_H
  44
  45 #include <memory>
  46 #include <vector>
  47
  48 #include "gromacs/math/vectypes.h"
  49
  50 #include "gromacs/utility/classhelpers.h"
  51 #include "gromacs/utility/real.h"
  52
  53 struct t_atoms;
  54 struct t_resinfo;
  55 struct t_symtab;
  56
  57 namespace gmx
  58 {
  59
  60 class AtomsBuilder
  61 {
  62 public:
  63     AtomsBuilder(t_atoms* atoms, t_symtab* symtab);
  64     ~AtomsBuilder();
  65
  66     void reserve(int atomCount, int residueCount);
  67     void clearAtoms();
  68
  69     int currentAtomCount() const;
  70
  71     void setNextResidueNumber(int number);
  72     void addAtom(const t_atoms& atoms, int i);
  73     void startResidue(const t_resinfo& resinfo);
  74     void finishResidue(const t_resinfo& resinfo);
  75     void discardCurrentResidue();
  76
  77     void mergeAtoms(const t_atoms& atoms);
  78
  79 private:
  80     char** symtabString(char** source);
  81
  82     t_atoms*  atoms_;
  83     t_symtab* symtab_;
  84     int       nrAlloc_;
  85     int       nresAlloc_;
  86     int       currentResidueIndex_;
  87     int       nextResidueNumber_;
  88
  89     GMX_DISALLOW_COPY_AND_ASSIGN(AtomsBuilder);
  90 };
  91
  92 class AtomsRemover
  93 {
  94 public:
  95     explicit AtomsRemover(const t_atoms& atoms);
  96     ~AtomsRemover();
  97
  98     void refreshAtomCount(const t_atoms& atoms);
  99
 100     void markAll();
 101     void markResidue(const t_atoms& atoms, int atomIndex, bool bStatus);
 102     bool isMarked(int atomIndex) const { return removed_[atomIndex] != 0; }
 103
 104     void removeMarkedElements(std::vector<RVec>* container) const;
 105     void removeMarkedElements(std::vector<real>* container) const;
 106     void removeMarkedAtoms(t_atoms* atoms) const;
 107
 108 private:
 109     std::vector<char> removed_;
 110
 111     GMX_DISALLOW_COPY_AND_ASSIGN(AtomsRemover);
 112 };
 113
 114 } // namespace gmx
 115
 116 #endif