src/gromacs/trajectoryanalysis/analysissettings.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014,2015, 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 analysissettings.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_trajectoryanalysis
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "analysissettings.h"
  45
  46 #include "gromacs/fileio/trxio.h"
  47 #include "gromacs/math/vec.h"
  48 #include "gromacs/topology/topology.h"
  49 #include "gromacs/utility/arrayref.h"
  50 #include "gromacs/utility/exceptions.h"
  51 #include "gromacs/utility/smalloc.h"
  52 #include "gromacs/utility/stringutil.h"
  53
  54 #include "analysissettings-impl.h"
  55
  56 namespace gmx
  57 {
  58
  59
  60 /********************************************************************
  61  * TrajectoryAnalysisSettings
  62  */
  63
  64 TrajectoryAnalysisSettings::TrajectoryAnalysisSettings()
  65     : impl_(new Impl)
  66 {
  67     impl_->frflags |= TRX_NEED_X;
  68 }
  69
  70
  71 TrajectoryAnalysisSettings::~TrajectoryAnalysisSettings()
  72 {
  73 }
  74
  75
  76 const TimeUnitManager &
  77 TrajectoryAnalysisSettings::timeUnitManager() const
  78 {
  79     return impl_->timeUnitManager;
  80 }
  81
  82
  83 const AnalysisDataPlotSettings &
  84 TrajectoryAnalysisSettings::plotSettings() const
  85 {
  86     return impl_->plotSettings;
  87 }
  88
  89
  90 unsigned long
  91 TrajectoryAnalysisSettings::flags() const
  92 {
  93     return impl_->flags;
  94 }
  95
  96
  97 bool
  98 TrajectoryAnalysisSettings::hasFlag(unsigned long flag) const
  99 {
 100     return impl_->flags & flag;
 101 }
 102
 103
 104 bool
 105 TrajectoryAnalysisSettings::hasPBC() const
 106 {
 107     return impl_->bPBC;
 108 }
 109
 110
 111 bool
 112 TrajectoryAnalysisSettings::hasRmPBC() const
 113 {
 114     return impl_->bRmPBC;
 115 }
 116
 117
 118 int
 119 TrajectoryAnalysisSettings::frflags() const
 120 {
 121     return impl_->frflags;
 122 }
 123
 124
 125 void
 126 TrajectoryAnalysisSettings::setFlags(unsigned long flags)
 127 {
 128     impl_->flags = flags;
 129 }
 130
 131
 132 void
 133 TrajectoryAnalysisSettings::setFlag(unsigned long flag, bool bSet)
 134 {
 135     if (bSet)
 136     {
 137         impl_->flags |= flag;
 138     }
 139     else
 140     {
 141         impl_->flags &= ~flag;
 142     }
 143 }
 144
 145
 146 void
 147 TrajectoryAnalysisSettings::setPBC(bool bPBC)
 148 {
 149     impl_->bPBC = bPBC;
 150 }
 151
 152
 153 void
 154 TrajectoryAnalysisSettings::setRmPBC(bool bRmPBC)
 155 {
 156     impl_->bRmPBC = bRmPBC;
 157 }
 158
 159
 160 void
 161 TrajectoryAnalysisSettings::setFrameFlags(int frflags)
 162 {
 163     impl_->frflags = frflags;
 164 }
 165
 166 const std::string &
 167 TrajectoryAnalysisSettings::helpText() const
 168 {
 169     return impl_->helpText_;
 170 }
 171
 172 void
 173 TrajectoryAnalysisSettings::setHelpText(const ConstArrayRef<const char *> &help)
 174 {
 175     impl_->helpText_ = joinStrings(help, "\n");
 176 }
 177
 178
 179 /********************************************************************
 180  * TopologyInformation
 181  */
 182
 183 TopologyInformation::TopologyInformation()
 184     : top_(NULL), bTop_(false), xtop_(NULL), ePBC_(-1)
 185 {
 186     clear_mat(boxtop_);
 187 }
 188
 189
 190 TopologyInformation::~TopologyInformation()
 191 {
 192     if (top_)
 193     {
 194         free_t_atoms(&top_->atoms, TRUE);
 195         done_top(top_);
 196         sfree(top_);
 197     }
 198     sfree(xtop_);
 199 }
 200
 201
 202 void
 203 TopologyInformation::getTopologyConf(rvec **x, matrix box) const
 204 {
 205     if (box)
 206     {
 207         copy_mat(const_cast<rvec *>(boxtop_), box);
 208     }
 209     if (x)
 210     {
 211         if (!xtop_)
 212         {
 213             *x = NULL;
 214             GMX_THROW(APIError("Topology coordinates requested without setting efUseTopX"));
 215         }
 216         *x = xtop_;
 217     }
 218 }
 219
 220 } // namespace gmx