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 by the GROMACS development team.
   5  * Copyright (c) 2017,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Implements gmx::AnalysisDataProxy.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_analysisdata
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "dataproxy.h"
  46
  47 #include "gromacs/analysisdata/dataframe.h"
  48 #include "gromacs/analysisdata/datamodulemanager.h"
  49 #include "gromacs/utility/gmxassert.h"
  50
  51 namespace gmx
  52 {
  53
  54 AnalysisDataProxy::AnalysisDataProxy(int firstColumn, int columnSpan, AbstractAnalysisData* data) :
  55     source_(*data),
  56     firstColumn_(firstColumn),
  57     columnSpan_(columnSpan),
  58     bParallel_(false)
  59 {
  60     GMX_RELEASE_ASSERT(data != nullptr, "Source data must not be NULL");
  61     GMX_RELEASE_ASSERT(firstColumn >= 0 && columnSpan > 0, "Invalid proxy column");
  62     setMultipoint(source_.isMultipoint());
  63 }
  64
  65
  66 int AnalysisDataProxy::frameCount() const
  67 {
  68     return source_.frameCount();
  69 }
  70
  71
  72 AnalysisDataFrameRef AnalysisDataProxy::tryGetDataFrameInternal(int index) const
  73 {
  74     AnalysisDataFrameRef frame = source_.tryGetDataFrame(index);
  75     if (!frame.isValid())
  76     {
  77         return AnalysisDataFrameRef();
  78     }
  79     return AnalysisDataFrameRef(frame, firstColumn_, columnSpan_);
  80 }
  81
  82
  83 bool AnalysisDataProxy::requestStorageInternal(int nframes)
  84 {
  85     return source_.requestStorage(nframes);
  86 }
  87
  88
  89 int AnalysisDataProxy::flags() const
  90 {
  91     return efAllowMultipoint | efAllowMulticolumn | efAllowMissing | efAllowMultipleDataSets;
  92 }
  93
  94
  95 void AnalysisDataProxy::dataStarted(AbstractAnalysisData* data)
  96 {
  97     GMX_RELEASE_ASSERT(data == &source_, "Source data mismatch");
  98     setDataSetCount(data->dataSetCount());
  99     for (int i = 0; i < data->dataSetCount(); ++i)
 100     {
 101         setColumnCount(i, columnSpan_);
 102     }
 103     moduleManager().notifyDataStart(this);
 104 }
 105
 106
 107 bool AnalysisDataProxy::parallelDataStarted(AbstractAnalysisData*              data,
 108                                             const AnalysisDataParallelOptions& options)
 109 {
 110     GMX_RELEASE_ASSERT(data == &source_, "Source data mismatch");
 111     setDataSetCount(data->dataSetCount());
 112     for (int i = 0; i < data->dataSetCount(); ++i)
 113     {
 114         setColumnCount(i, columnSpan_);
 115     }
 116     moduleManager().notifyParallelDataStart(this, options);
 117     bParallel_ = !moduleManager().hasSerialModules();
 118     return bParallel_;
 119 }
 120
 121
 122 void AnalysisDataProxy::frameStarted(const AnalysisDataFrameHeader& frame)
 123 {
 124     if (bParallel_)
 125     {
 126         moduleManager().notifyParallelFrameStart(frame);
 127     }
 128     else
 129     {
 130         moduleManager().notifyFrameStart(frame);
 131     }
 132 }
 133
 134
 135 void AnalysisDataProxy::pointsAdded(const AnalysisDataPointSetRef& points)
 136 {
 137     AnalysisDataPointSetRef columns(points, firstColumn_, columnSpan_);
 138     if (columns.columnCount() > 0)
 139     {
 140         if (bParallel_)
 141         {
 142             moduleManager().notifyParallelPointsAdd(columns);
 143         }
 144         else
 145         {
 146             moduleManager().notifyPointsAdd(columns);
 147         }
 148     }
 149 }
 150
 151
 152 void AnalysisDataProxy::frameFinished(const AnalysisDataFrameHeader& header)
 153 {
 154     if (bParallel_)
 155     {
 156         moduleManager().notifyParallelFrameFinish(header);
 157     }
 158     else
 159     {
 160         moduleManager().notifyFrameFinish(header);
 161     }
 162 }
 163
 164 void AnalysisDataProxy::frameFinishedSerial(int frameIndex)
 165 {
 166     if (bParallel_)
 167     {
 168         // The x and dx values are unused in this case.
 169         AnalysisDataFrameHeader header(frameIndex, 0.0, 0.0);
 170         moduleManager().notifyFrameFinish(header);
 171     }
 172 }
 173
 174
 175 void AnalysisDataProxy::dataFinished()
 176 {
 177     moduleManager().notifyDataFinish();
 178 }
 179
 180 } // namespace gmx