src/gromacs/analysisdata/arraydata.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014,2015,2017,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 arraydata.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_analysisdata
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "arraydata.h"
  45
  46 #include <algorithm>
  47
  48 #include "gromacs/analysisdata/dataframe.h"
  49 #include "gromacs/analysisdata/datamodulemanager.h"
  50 #include "gromacs/utility/exceptions.h"
  51 #include "gromacs/utility/gmxassert.h"
  52
  53 namespace gmx
  54 {
  55
  56 AbstractAnalysisArrayData::AbstractAnalysisArrayData() :
  57     rowCount_(0),
  58     pointSetInfo_(0, 0, 0, 0),
  59     xstep_(1.0),
  60     bUniformX_(true),
  61     bReady_(false)
  62 {
  63     xvalue_.push_back(0);
  64 }
  65
  66 AbstractAnalysisArrayData::~AbstractAnalysisArrayData() {}
  67
  68
  69 AnalysisDataFrameRef AbstractAnalysisArrayData::tryGetDataFrameInternal(int index) const
  70 {
  71     if (!isAllocated())
  72     {
  73         return AnalysisDataFrameRef();
  74     }
  75     return AnalysisDataFrameRef(AnalysisDataFrameHeader(index, xvalue(index), 0.0),
  76                                 makeConstArrayRef(value_).subArray(index * columnCount(), columnCount()),
  77                                 constArrayRefFromArray(&pointSetInfo_, 1));
  78 }
  79
  80
  81 bool AbstractAnalysisArrayData::requestStorageInternal(int /*nframes*/)
  82 {
  83     return true;
  84 }
  85
  86
  87 void AbstractAnalysisArrayData::setColumnCount(int ncols)
  88 {
  89     GMX_RELEASE_ASSERT(!isAllocated(), "Cannot change column count after data has been allocated");
  90     AbstractAnalysisData::setColumnCount(0, ncols);
  91     pointSetInfo_ = AnalysisDataPointSetInfo(0, ncols, 0, 0);
  92 }
  93
  94
  95 void AbstractAnalysisArrayData::setRowCount(int rowCount)
  96 {
  97     GMX_RELEASE_ASSERT(rowCount > 0, "Invalid number of rows");
  98     GMX_RELEASE_ASSERT(!isAllocated(), "Cannot change row count after data has been allocated");
  99     GMX_RELEASE_ASSERT(bUniformX_ || xvalue_.empty() || rowCount == ssize(xvalue_),
 100                        "X axis set with setXAxisValue() does not match the row count");
 101     xvalue_.resize(rowCount);
 102     if (bUniformX_ && rowCount > rowCount_)
 103     {
 104         for (int i = rowCount_; i < rowCount; ++i)
 105         {
 106             xvalue_[i] = xvalue_[0] + i * xstep_;
 107         }
 108     }
 109     rowCount_ = rowCount;
 110 }
 111
 112
 113 void AbstractAnalysisArrayData::allocateValues()
 114 {
 115     GMX_RELEASE_ASSERT(!isAllocated(), "Can only allocate values once");
 116     GMX_RELEASE_ASSERT(rowCount() > 0 && columnCount() > 0,
 117                        "Row and column counts must be set before allocating values");
 118     value_.resize(rowCount() * columnCount());
 119     std::vector<AnalysisDataValue>::iterator i;
 120     for (i = value_.begin(); i != value_.end(); ++i)
 121     {
 122         i->setValue(0.0);
 123     }
 124 }
 125
 126
 127 void AbstractAnalysisArrayData::setXAxis(real start, real step)
 128 {
 129     GMX_RELEASE_ASSERT(!bReady_, "X axis cannot be set after data is finished");
 130     xvalue_[0] = start;
 131     xstep_     = step;
 132     bUniformX_ = true;
 133     for (int i = 0; i < rowCount_; ++i)
 134     {
 135         xvalue_[i] = start + i * xstep_;
 136     }
 137 }
 138
 139
 140 void AbstractAnalysisArrayData::setXAxisValue(int row, real value)
 141 {
 142     GMX_RELEASE_ASSERT(!bReady_, "X axis cannot be set after data is finished");
 143     if (rowCount_ > 0)
 144     {
 145         GMX_RELEASE_ASSERT(row >= 0 && row < rowCount(), "Row index out of range");
 146     }
 147     else if (row >= ssize(xvalue_))
 148     {
 149         xvalue_.resize(row + 1);
 150     }
 151     bUniformX_   = false;
 152     xstep_       = 0.0;
 153     xvalue_[row] = value;
 154 }
 155
 156
 157 void AbstractAnalysisArrayData::valuesReady()
 158 {
 159     GMX_RELEASE_ASSERT(isAllocated(), "There must be some data");
 160     if (bReady_)
 161     {
 162         return;
 163     }
 164     bReady_ = true;
 165
 166     AnalysisDataModuleManager& modules = moduleManager();
 167     modules.notifyDataStart(this);
 168     for (int i = 0; i < rowCount(); ++i)
 169     {
 170         AnalysisDataFrameHeader header(i, xvalue(i), 0);
 171         modules.notifyFrameStart(header);
 172         modules.notifyPointsAdd(AnalysisDataPointSetRef(
 173                 header, pointSetInfo_,
 174                 makeConstArrayRef(value_).subArray(i * columnCount(), columnCount())));
 175         modules.notifyFrameFinish(header);
 176     }
 177     modules.notifyDataFinish();
 178 }
 179
 180
 181 void AbstractAnalysisArrayData::copyContents(const AbstractAnalysisArrayData* src,
 182                                              AbstractAnalysisArrayData*       dest)
 183 {
 184     GMX_RELEASE_ASSERT(src->isAllocated(), "Source data must not be empty");
 185     GMX_RELEASE_ASSERT(!dest->isAllocated(), "Destination data must not be allocated");
 186     dest->setColumnCount(src->columnCount());
 187     dest->setRowCount(src->rowCount());
 188     dest->allocateValues();
 189     dest->xstep_     = src->xstep_;
 190     dest->bUniformX_ = src->bUniformX_;
 191     std::copy(src->xvalue_.begin(), src->xvalue_.end(), dest->xvalue_.begin());
 192     std::copy(src->value_.begin(), src->value_.end(), dest->value_.begin());
 193 }
 194
 195 } // namespace gmx