src/gromacs/analysisdata/dataproxy.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014,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 gmx::AnalysisDataProxy.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_analysisdata
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "dataproxy.h"
  45
  46 #include "gromacs/analysisdata/dataframe.h"
  47 #include "gromacs/analysisdata/datamodulemanager.h"
  48 #include "gromacs/utility/gmxassert.h"
  49
  50 namespace gmx
  51 {
  52
  53 AnalysisDataProxy::AnalysisDataProxy(int firstColumn, int columnSpan, AbstractAnalysisData* data) :
  54     source_(*data),
  55     firstColumn_(firstColumn),
  56     columnSpan_(columnSpan),
  57     bParallel_(false)
  58 {
  59     GMX_RELEASE_ASSERT(data != nullptr, "Source data must not be NULL");
  60     GMX_RELEASE_ASSERT(firstColumn >= 0 && columnSpan > 0, "Invalid proxy column");
  61     setMultipoint(source_.isMultipoint());
  62 }
  63
  64
  65 int AnalysisDataProxy::frameCount() const
  66 {
  67     return source_.frameCount();
  68 }
  69
  70
  71 AnalysisDataFrameRef AnalysisDataProxy::tryGetDataFrameInternal(int index) const
  72 {
  73     AnalysisDataFrameRef frame = source_.tryGetDataFrame(index);
  74     if (!frame.isValid())
  75     {
  76         return AnalysisDataFrameRef();
  77     }
  78     return AnalysisDataFrameRef(frame, firstColumn_, columnSpan_);
  79 }
  80
  81
  82 bool AnalysisDataProxy::requestStorageInternal(int nframes)
  83 {
  84     return source_.requestStorage(nframes);
  85 }
  86
  87
  88 int AnalysisDataProxy::flags() const
  89 {
  90     return efAllowMultipoint | efAllowMulticolumn | efAllowMissing | efAllowMultipleDataSets;
  91 }
  92
  93
  94 void AnalysisDataProxy::dataStarted(AbstractAnalysisData* data)
  95 {
  96     GMX_RELEASE_ASSERT(data == &source_, "Source data mismatch");
  97     setDataSetCount(data->dataSetCount());
  98     for (int i = 0; i < data->dataSetCount(); ++i)
  99     {
 100         setColumnCount(i, columnSpan_);
 101     }
 102     moduleManager().notifyDataStart(this);
 103 }
 104
 105
 106 bool AnalysisDataProxy::parallelDataStarted(AbstractAnalysisData*              data,
 107                                             const AnalysisDataParallelOptions& options)
 108 {
 109     GMX_RELEASE_ASSERT(data == &source_, "Source data mismatch");
 110     setDataSetCount(data->dataSetCount());
 111     for (int i = 0; i < data->dataSetCount(); ++i)
 112     {
 113         setColumnCount(i, columnSpan_);
 114     }
 115     moduleManager().notifyParallelDataStart(this, options);
 116     bParallel_ = !moduleManager().hasSerialModules();
 117     return bParallel_;
 118 }
 119
 120
 121 void AnalysisDataProxy::frameStarted(const AnalysisDataFrameHeader& frame)
 122 {
 123     if (bParallel_)
 124     {
 125         moduleManager().notifyParallelFrameStart(frame);
 126     }
 127     else
 128     {
 129         moduleManager().notifyFrameStart(frame);
 130     }
 131 }
 132
 133
 134 void AnalysisDataProxy::pointsAdded(const AnalysisDataPointSetRef& points)
 135 {
 136     AnalysisDataPointSetRef columns(points, firstColumn_, columnSpan_);
 137     if (columns.columnCount() > 0)
 138     {
 139         if (bParallel_)
 140         {
 141             moduleManager().notifyParallelPointsAdd(columns);
 142         }
 143         else
 144         {
 145             moduleManager().notifyPointsAdd(columns);
 146         }
 147     }
 148 }
 149
 150
 151 void AnalysisDataProxy::frameFinished(const AnalysisDataFrameHeader& header)
 152 {
 153     if (bParallel_)
 154     {
 155         moduleManager().notifyParallelFrameFinish(header);
 156     }
 157     else
 158     {
 159         moduleManager().notifyFrameFinish(header);
 160     }
 161 }
 162
 163 void AnalysisDataProxy::frameFinishedSerial(int frameIndex)
 164 {
 165     if (bParallel_)
 166     {
 167         // The x and dx values are unused in this case.
 168         AnalysisDataFrameHeader header(frameIndex, 0.0, 0.0);
 169         moduleManager().notifyFrameFinish(header);
 170     }
 171 }
 172
 173
 174 void AnalysisDataProxy::dataFinished()
 175 {
 176     moduleManager().notifyDataFinish();
 177 }
 178
 179 } // namespace gmx