src/gromacs/trajectoryanalysis/topologyinformation.cpp

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