src/gromacs/trajectoryanalysis/topologyinformation.cpp

   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 /*! \internal \file
  36  * \brief
  37  * Implements classes in topologyinformation.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_trajectoryanalysis
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "topologyinformation.h"
  45
  46 #include <memory>
  47
  48 #include "gromacs/fileio/confio.h"
  49 #include "gromacs/math/vec.h"
  50 #include "gromacs/pbcutil/rmpbc.h"
  51 #include "gromacs/topology/mtop_util.h"
  52 #include "gromacs/topology/topology.h"
  53 #include "gromacs/utility/arrayref.h"
  54 #include "gromacs/utility/exceptions.h"
  55 #include "gromacs/utility/gmxassert.h"
  56 #include "gromacs/utility/smalloc.h"
  57 #include "gromacs/utility/unique_cptr.h"
  58
  59 namespace gmx
  60 {
  61
  62 TopologyInformation::TopologyInformation() :
  63     hasLoadedMtop_(false),
  64     expandedTopology_(nullptr),
  65     atoms_(nullptr),
  66     bTop_(false),
  67     ePBC_(-1)
  68 {
  69 }
  70
  71
  72 TopologyInformation::~TopologyInformation() {}
  73
  74 void TopologyInformation::fillFromInputFile(const std::string& filename)
  75 {
  76     mtop_ = std::make_unique<gmx_mtop_t>();
  77     // TODO When filename is not a .tpr, then using readConfAndAtoms
  78     // would be efficient for not doing multiple conversions for
  79     // makeAtomsData. However we'd also need to be able to copy the
  80     // t_atoms that we'd keep, which we currently can't do.
  81     // TODO Once there are fewer callers of the file-reading
  82     // functionality, make them read directly into std::vector.
  83     rvec *x, *v;
  84     readConfAndTopology(filename.c_str(), &bTop_, mtop_.get(), &ePBC_, &x, &v, boxtop_);
  85     xtop_.assign(x, x + mtop_->natoms);
  86     vtop_.assign(v, v + mtop_->natoms);
  87     sfree(x);
  88     sfree(v);
  89     hasLoadedMtop_ = true;
  90     // TODO: Only load this here if the tool actually needs it; selections
  91     // take care of themselves.
  92     for (gmx_moltype_t& moltype : mtop_->moltype)
  93     {
  94         if (!moltype.atoms.haveMass)
  95         {
  96             // Try to read masses from database, be silent about missing masses
  97             atomsSetMassesBasedOnNames(&moltype.atoms, FALSE);
  98         }
  99     }
 100 }
 101
 102 const gmx_localtop_t* TopologyInformation::expandedTopology() const
 103 {
 104     // Do lazy initialization
 105     if (expandedTopology_ == nullptr && hasTopology())
 106     {
 107         expandedTopology_ = std::make_unique<gmx_localtop_t>();
 108         gmx_mtop_generate_local_top(*mtop_, expandedTopology_.get(), false);
 109     }
 110
 111     return expandedTopology_.get();
 112 }
 113
 114 namespace
 115 {
 116
 117 //! Helps implement lazy initialization.
 118 AtomsDataPtr makeAtoms(const TopologyInformation& top_)
 119 {
 120     AtomsDataPtr atoms(new t_atoms);
 121     if (top_.hasTopology())
 122     {
 123         *atoms = gmx_mtop_global_atoms(top_.mtop());
 124     }
 125     else
 126     {
 127         init_atom(atoms.get());
 128     }
 129     return atoms;
 130 }
 131
 132 } // namespace
 133
 134 const t_atoms* TopologyInformation::atoms() const
 135 {
 136     // Do lazy initialization
 137     if (atoms_ == nullptr)
 138     {
 139         atoms_ = makeAtoms(*this);
 140     }
 141
 142     return atoms_.get();
 143 }
 144
 145 AtomsDataPtr TopologyInformation::copyAtoms() const
 146 {
 147     // Note that we do not return atoms_, so that regardless of
 148     // whether the user has already used it, or will use it in the
 149     // future, any transformation operations on the data structure
 150     // returned here cannot have unintended effects.
 151     return makeAtoms(*this);
 152 }
 153
 154 ArrayRef<const RVec> TopologyInformation::x() const
 155 {
 156     if (xtop_.empty())
 157     {
 158         GMX_THROW(APIError("Topology coordinates requested without setting efUseTopX"));
 159     }
 160     return xtop_;
 161 }
 162
 163 ArrayRef<const RVec> TopologyInformation::v() const
 164 {
 165     if (vtop_.empty())
 166     {
 167         GMX_THROW(APIError("Topology coordinates requested without setting efUseTopV"));
 168     }
 169     return vtop_;
 170 }
 171
 172 void TopologyInformation::getBox(matrix box) const
 173 {
 174     GMX_RELEASE_ASSERT(box != nullptr, "Must have valid box to fill");
 175     copy_mat(const_cast<rvec*>(boxtop_), box);
 176 }
 177
 178 const char* TopologyInformation::name() const
 179 {
 180     if (hasTopology() && mtop_->name)
 181     {
 182         return *mtop_->name;
 183     }
 184     return nullptr;
 185 }
 186
 187 gmx_rmpbc_t gmx_rmpbc_init(const gmx::TopologyInformation& topInfo)
 188 {
 189     GMX_RELEASE_ASSERT(topInfo.hasTopology(), "Cannot remove PBC without a topology");
 190
 191     return gmx_rmpbc_init(&topInfo.expandedTopology()->idef, topInfo.ePBC(), topInfo.mtop()->natoms);
 192 }
 193
 194 } // namespace gmx