src/gromacs/analysisdata/analysisdata.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 analysisdata.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_analysisdata
  41  */
  42 #include "gromacs/analysisdata/analysisdata.h"
  43
  44 #include "gromacs/analysisdata/dataframe.h"
  45 #include "gromacs/analysisdata/datastorage.h"
  46 #include "gromacs/analysisdata/paralleloptions.h"
  47 #include "gromacs/utility/exceptions.h"
  48 #include "gromacs/utility/gmxassert.h"
  49 #include "gromacs/utility/uniqueptr.h"
  50
  51 namespace gmx
  52 {
  53
  54 /********************************************************************
  55  * AnalysisDataHandleImpl
  56  */
  57
  58 namespace internal
  59 {
  60
  61 /*! \internal \brief
  62  * Private implementation class for AnalysisDataHandle.
  63  *
  64  * \ingroup module_analysisdata
  65  */
  66 class AnalysisDataHandleImpl
  67 {
  68     public:
  69         //! Creates a handle associated with the given data object.
  70         explicit AnalysisDataHandleImpl(AnalysisData *data)
  71             : data_(*data), currentFrame_(NULL)
  72         {
  73         }
  74
  75         //! The data object that this handle belongs to.
  76         AnalysisData             &data_;
  77         //! Current storage frame object, or NULL if no current frame.
  78         AnalysisDataStorageFrame *currentFrame_;
  79 };
  80
  81 }   // namespace internal
  82
  83 /********************************************************************
  84  * AnalysisData::Impl
  85  */
  86
  87 /*! \internal \brief
  88  * Private implementation class for AnalysisData.
  89  *
  90  * \ingroup module_analysisdata
  91  */
  92 class AnalysisData::Impl
  93 {
  94     public:
  95         //! Smart pointer type to manage a data handle implementation.
  96         typedef gmx_unique_ptr<internal::AnalysisDataHandleImpl>::type
  97             HandlePointer;
  98         //! Shorthand for a list of data handles.
  99         typedef std::vector<HandlePointer> HandleList;
 100
 101         //! Storage implementation.
 102         AnalysisDataStorage     storage_;
 103         /*! \brief
 104          * List of handles for this data object.
 105          *
 106          * Note that AnalysisDataHandle objects also contain (raw) pointers
 107          * to these objects.
 108          */
 109         HandleList              handles_;
 110 };
 111
 112 /********************************************************************
 113  * AnalysisData
 114  */
 115
 116 AnalysisData::AnalysisData()
 117     : impl_(new Impl)
 118 {
 119 }
 120
 121
 122 AnalysisData::~AnalysisData()
 123 {
 124 }
 125
 126
 127 void
 128 AnalysisData::setColumnCount(int ncol)
 129 {
 130     GMX_RELEASE_ASSERT(ncol > 0, "Number of columns must be positive");
 131     GMX_RELEASE_ASSERT(impl_->handles_.empty(),
 132                        "Cannot change data dimensionality after creating handles");
 133     AbstractAnalysisData::setColumnCount(ncol);
 134 }
 135
 136
 137 void
 138 AnalysisData::setMultipoint(bool bMultipoint)
 139 {
 140     GMX_RELEASE_ASSERT(impl_->handles_.empty(),
 141                        "Cannot change data type after creating handles");
 142     AbstractAnalysisData::setMultipoint(bMultipoint);
 143     impl_->storage_.setMultipoint(bMultipoint);
 144 }
 145
 146
 147 AnalysisDataHandle
 148 AnalysisData::startData(const AnalysisDataParallelOptions &opt)
 149 {
 150     GMX_RELEASE_ASSERT(impl_->handles_.size() < static_cast<unsigned>(opt.parallelizationFactor()),
 151                        "Too many calls to startData() compared to provided options");
 152     if (impl_->handles_.empty())
 153     {
 154         notifyDataStart();
 155         impl_->storage_.setParallelOptions(opt);
 156         impl_->storage_.startDataStorage(this);
 157     }
 158     else if (isMultipoint())
 159     {
 160         GMX_THROW(NotImplementedError("Parallelism not supported for multipoint data"));
 161     }
 162
 163     Impl::HandlePointer handle(new internal::AnalysisDataHandleImpl(this));
 164     impl_->handles_.push_back(move(handle));
 165     return AnalysisDataHandle(impl_->handles_.back().get());
 166 }
 167
 168
 169 void
 170 AnalysisData::finishData(AnalysisDataHandle handle)
 171 {
 172     Impl::HandleList::iterator i;
 173
 174     for (i = impl_->handles_.begin(); i != impl_->handles_.end(); ++i)
 175     {
 176         if (i->get() == handle.impl_)
 177         {
 178             break;
 179         }
 180     }
 181     GMX_RELEASE_ASSERT(i != impl_->handles_.end(),
 182                        "finishData() called for an unknown handle");
 183
 184     impl_->handles_.erase(i);
 185
 186     if (impl_->handles_.empty())
 187     {
 188         notifyDataFinish();
 189     }
 190 }
 191
 192
 193 AnalysisDataFrameRef
 194 AnalysisData::tryGetDataFrameInternal(int index) const
 195 {
 196     return impl_->storage_.tryGetDataFrame(index);
 197 }
 198
 199
 200 bool
 201 AnalysisData::requestStorageInternal(int nframes)
 202 {
 203     return impl_->storage_.requestStorage(nframes);
 204 }
 205
 206
 207 /********************************************************************
 208  * AnalysisDataHandle
 209  */
 210
 211 AnalysisDataHandle::AnalysisDataHandle()
 212     : impl_(NULL)
 213 {
 214 }
 215
 216
 217 AnalysisDataHandle::AnalysisDataHandle(internal::AnalysisDataHandleImpl *impl)
 218     : impl_(impl)
 219 {
 220 }
 221
 222
 223 void
 224 AnalysisDataHandle::startFrame(int index, real x, real dx)
 225 {
 226     GMX_RELEASE_ASSERT(impl_ != NULL, "Invalid data handle used");
 227     GMX_RELEASE_ASSERT(impl_->currentFrame_ == NULL,
 228                        "startFrame() called twice without calling finishFrame()");
 229     impl_->currentFrame_ =
 230         &impl_->data_.impl_->storage_.startFrame(index, x, dx);
 231 }
 232
 233
 234 void
 235 AnalysisDataHandle::setPoint(int column, real value, bool bPresent)
 236 {
 237     GMX_RELEASE_ASSERT(impl_ != NULL, "Invalid data handle used");
 238     GMX_RELEASE_ASSERT(impl_->currentFrame_ != NULL,
 239                        "setPoint() called without calling startFrame()");
 240     impl_->currentFrame_->setValue(column, value, bPresent);
 241 }
 242
 243
 244 void
 245 AnalysisDataHandle::setPoint(int column, real value, real error, bool bPresent)
 246 {
 247     GMX_RELEASE_ASSERT(impl_ != NULL, "Invalid data handle used");
 248     GMX_RELEASE_ASSERT(impl_->currentFrame_ != NULL,
 249                        "setPoint() called without calling startFrame()");
 250     impl_->currentFrame_->setValue(column, value, error, bPresent);
 251 }
 252
 253
 254 void
 255 AnalysisDataHandle::setPoints(int firstColumn, int count, const real *values)
 256 {
 257     GMX_RELEASE_ASSERT(impl_ != NULL, "Invalid data handle used");
 258     GMX_RELEASE_ASSERT(impl_->currentFrame_ != NULL,
 259                        "setPoints() called without calling startFrame()");
 260     for (int i = 0; i < count; ++i)
 261     {
 262         impl_->currentFrame_->setValue(firstColumn + i, values[i]);
 263     }
 264 }
 265
 266
 267 void
 268 AnalysisDataHandle::finishPointSet()
 269 {
 270     GMX_RELEASE_ASSERT(impl_ != NULL, "Invalid data handle used");
 271     GMX_RELEASE_ASSERT(impl_->data_.isMultipoint(),
 272                        "finishPointSet() called for non-multipoint data");
 273     GMX_RELEASE_ASSERT(impl_->currentFrame_ != NULL,
 274                        "finishPointSet() called without calling startFrame()");
 275     impl_->currentFrame_->finishPointSet();
 276 }
 277
 278
 279 void
 280 AnalysisDataHandle::finishFrame()
 281 {
 282     GMX_RELEASE_ASSERT(impl_ != NULL, "Invalid data handle used");
 283     GMX_RELEASE_ASSERT(impl_->currentFrame_ != NULL,
 284                        "finishFrame() called without calling startFrame()");
 285     int index = impl_->currentFrame_->frameIndex();
 286     impl_->currentFrame_ = NULL;
 287     impl_->data_.impl_->storage_.finishFrame(index);
 288 }
 289
 290
 291 void
 292 AnalysisDataHandle::finishData()
 293 {
 294     GMX_RELEASE_ASSERT(impl_ != NULL, "Invalid data handle used");
 295     // Deletes the implementation pointer.
 296     impl_->data_.finishData(*this);
 297     impl_ = NULL;
 298 }
 299
 300 } // namespace gmx