src/gromacs/trajectoryanalysis/analysissettings.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 "analysissettings.h"
  43
  44 #include "gromacs/legacyheaders/smalloc.h"
  45 #include "gromacs/legacyheaders/statutil.h"
  46 #include "gromacs/legacyheaders/vec.h"
  47 #include "gromacs/fileio/trxio.h"
  48
  49 #include "gromacs/utility/exceptions.h"
  50
  51 #include "analysissettings-impl.h"
  52
  53 namespace gmx
  54 {
  55
  56
  57 /********************************************************************
  58  * TrajectoryAnalysisSettings
  59  */
  60
  61 TrajectoryAnalysisSettings::TrajectoryAnalysisSettings()
  62     : impl_(new Impl)
  63 {
  64     impl_->frflags |= TRX_NEED_X;
  65 }
  66
  67
  68 TrajectoryAnalysisSettings::~TrajectoryAnalysisSettings()
  69 {
  70 }
  71
  72
  73 const TimeUnitManager &
  74 TrajectoryAnalysisSettings::timeUnitManager() const
  75 {
  76     return impl_->timeUnitManager;
  77 }
  78
  79
  80 const AnalysisDataPlotSettings &
  81 TrajectoryAnalysisSettings::plotSettings() const
  82 {
  83     return impl_->plotSettings;
  84 }
  85
  86
  87 unsigned long
  88 TrajectoryAnalysisSettings::flags() const
  89 {
  90     return impl_->flags;
  91 }
  92
  93
  94 bool
  95 TrajectoryAnalysisSettings::hasFlag(unsigned long flag) const
  96 {
  97     return impl_->flags & flag;
  98 }
  99
 100
 101 bool
 102 TrajectoryAnalysisSettings::hasPBC() const
 103 {
 104     return impl_->bPBC;
 105 }
 106
 107
 108 bool
 109 TrajectoryAnalysisSettings::hasRmPBC() const
 110 {
 111     return impl_->bRmPBC;
 112 }
 113
 114
 115 int
 116 TrajectoryAnalysisSettings::frflags() const
 117 {
 118     return impl_->frflags;
 119 }
 120
 121
 122 void
 123 TrajectoryAnalysisSettings::setFlags(unsigned long flags)
 124 {
 125     impl_->flags = flags;
 126 }
 127
 128
 129 void
 130 TrajectoryAnalysisSettings::setFlag(unsigned long flag, bool bSet)
 131 {
 132     if (bSet)
 133     {
 134         impl_->flags |= flag;
 135     }
 136     else
 137     {
 138         impl_->flags &= ~flag;
 139     }
 140 }
 141
 142
 143 void
 144 TrajectoryAnalysisSettings::setPBC(bool bPBC)
 145 {
 146     impl_->bPBC = bPBC;
 147 }
 148
 149
 150 void
 151 TrajectoryAnalysisSettings::setRmPBC(bool bRmPBC)
 152 {
 153     impl_->bRmPBC = bRmPBC;
 154 }
 155
 156
 157 void
 158 TrajectoryAnalysisSettings::setFrameFlags(int frflags)
 159 {
 160     impl_->frflags = frflags;
 161 }
 162
 163
 164 /********************************************************************
 165  * TopologyInformation
 166  */
 167
 168 TopologyInformation::TopologyInformation()
 169     : top_(NULL), bTop_(false), xtop_(NULL), ePBC_(-1)
 170 {
 171     clear_mat(boxtop_);
 172 }
 173
 174
 175 TopologyInformation::~TopologyInformation()
 176 {
 177     if (top_)
 178     {
 179         free_t_atoms(&top_->atoms, TRUE);
 180         done_top(top_);
 181         sfree(top_);
 182     }
 183     sfree(xtop_);
 184 }
 185
 186
 187 void
 188 TopologyInformation::getTopologyConf(rvec **x, matrix box) const
 189 {
 190     if (box)
 191     {
 192         copy_mat(const_cast<rvec *>(boxtop_), box);
 193     }
 194     if (x)
 195     {
 196         if (!xtop_)
 197         {
 198             *x = NULL;
 199             GMX_THROW(APIError("Topology coordinates requested without setting efUseTopX"));
 200         }
 201         *x = xtop_;
 202     }
 203 }
 204
 205 } // namespace gmx