src/gromacs/selection/tests/toputils.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2015,2016,2017,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 /*! \internal \file
  36  * \brief
  37  * Helper routines for constructing topologies for tests.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 #ifndef GMX_SELECTION_TESTS_TOPUTILS_H
  43 #define GMX_SELECTION_TESTS_TOPUTILS_H
  44
  45 #include <memory>
  46 #include <vector>
  47
  48 struct gmx_mtop_t;
  49 struct t_atoms;
  50 struct t_trxframe;
  51
  52 namespace gmx
  53 {
  54
  55 template<typename T>
  56 class ArrayRef;
  57
  58 namespace test
  59 {
  60
  61 /*! \internal
  62  * \brief Helps create and manage the lifetime of topology and
  63  * related data structures. */
  64 class TopologyManager
  65 {
  66 public:
  67     TopologyManager();
  68     ~TopologyManager();
  69
  70     //@{
  71     /*! \brief Prepare the memory within a trajectory frame needed
  72      * for test */
  73     void requestFrame();
  74     void requestVelocities();
  75     void requestForces();
  76     void initFrameIndices(const ArrayRef<const int>& index);
  77     //@}
  78
  79     //! Load a topology from an input file relative to the source tree
  80     void loadTopology(const char* filename);
  81
  82     //@{
  83     /*! \brief Functions for creating simplistic topologies
  84      *
  85      * These are easy to work with for some kinds of tests. */
  86     void initAtoms(int count);
  87     void initAtomTypes(const ArrayRef<const char* const>& types);
  88     void initUniformResidues(int residueSize);
  89     void initUniformMolecules(int moleculeSize);
  90     //@}
  91
  92     //@{
  93     /*! \brief Functions for creating realistic topologies
  94      *
  95      * Real topologies aren't uniform, so we need to be able to
  96      * create custom topologies to test against.
  97      *
  98      * Ideally, we'd just be able to push new molecule types and
  99      * blocks, but the data structures are not mature enough for
 100      * that yet. The intended usage pattern is to initialize the
 101      * topology and declare the number of molecule types and
 102      * blocks, and then call the setter functions to fill in the
 103      * data structures. */
 104     void initTopology(int numMoleculeTypes, int numMoleculeBlocks);
 105     void setMoleculeType(int moleculeTypeIndex, ArrayRef<const int> residueSizes);
 106     void setMoleculeBlock(int moleculeBlockIndex, int moleculeTypeIndex, int numMoleculesToAdd);
 107     void finalizeTopology();
 108     //@}
 109
 110     //@{
 111     //! Getters
 112     gmx_mtop_t* topology() { return mtop_.get(); }
 113     t_atoms&    atoms();
 114     t_trxframe* frame() { return frame_; }
 115     //@}
 116
 117 private:
 118     //! Topology
 119     std::unique_ptr<gmx_mtop_t> mtop_;
 120     //! Trajectory frame
 121     t_trxframe* frame_;
 122     //! Atom type names
 123     std::vector<char*> atomtypes_;
 124 };
 125
 126 } // namespace test
 127 } // namespace gmx
 128
 129 #endif