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,2021, 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), firstColumn_(firstColumn), columnSpan_(columnSpan), bParallel_(false)
  56 {
  57     GMX_RELEASE_ASSERT(data != nullptr, "Source data must not be NULL");
  58     GMX_RELEASE_ASSERT(firstColumn >= 0 && columnSpan > 0, "Invalid proxy column");
  59     setMultipoint(source_.isMultipoint());
  60 }
  61
  62
  63 int AnalysisDataProxy::frameCount() const
  64 {
  65     return source_.frameCount();
  66 }
  67
  68
  69 AnalysisDataFrameRef AnalysisDataProxy::tryGetDataFrameInternal(int index) const
  70 {
  71     AnalysisDataFrameRef frame = source_.tryGetDataFrame(index);
  72     if (!frame.isValid())
  73     {
  74         return AnalysisDataFrameRef();
  75     }
  76     return AnalysisDataFrameRef(frame, firstColumn_, columnSpan_);
  77 }
  78
  79
  80 bool AnalysisDataProxy::requestStorageInternal(int nframes)
  81 {
  82     return source_.requestStorage(nframes);
  83 }
  84
  85
  86 int AnalysisDataProxy::flags() const
  87 {
  88     return efAllowMultipoint | efAllowMulticolumn | efAllowMissing | efAllowMultipleDataSets;
  89 }
  90
  91
  92 void AnalysisDataProxy::dataStarted(AbstractAnalysisData* data)
  93 {
  94     GMX_RELEASE_ASSERT(data == &source_, "Source data mismatch");
  95     setDataSetCount(data->dataSetCount());
  96     for (int i = 0; i < data->dataSetCount(); ++i)
  97     {
  98         setColumnCount(i, columnSpan_);
  99     }
 100     moduleManager().notifyDataStart(this);
 101 }
 102
 103
 104 bool AnalysisDataProxy::parallelDataStarted(AbstractAnalysisData*              data,
 105                                             const AnalysisDataParallelOptions& options)
 106 {
 107     GMX_RELEASE_ASSERT(data == &source_, "Source data mismatch");
 108     setDataSetCount(data->dataSetCount());
 109     for (int i = 0; i < data->dataSetCount(); ++i)
 110     {
 111         setColumnCount(i, columnSpan_);
 112     }
 113     moduleManager().notifyParallelDataStart(this, options);
 114     bParallel_ = !moduleManager().hasSerialModules();
 115     return bParallel_;
 116 }
 117
 118
 119 void AnalysisDataProxy::frameStarted(const AnalysisDataFrameHeader& frame)
 120 {
 121     if (bParallel_)
 122     {
 123         moduleManager().notifyParallelFrameStart(frame);
 124     }
 125     else
 126     {
 127         moduleManager().notifyFrameStart(frame);
 128     }
 129 }
 130
 131
 132 void AnalysisDataProxy::pointsAdded(const AnalysisDataPointSetRef& points)
 133 {
 134     AnalysisDataPointSetRef columns(points, firstColumn_, columnSpan_);
 135     if (columns.columnCount() > 0)
 136     {
 137         if (bParallel_)
 138         {
 139             moduleManager().notifyParallelPointsAdd(columns);
 140         }
 141         else
 142         {
 143             moduleManager().notifyPointsAdd(columns);
 144         }
 145     }
 146 }
 147
 148
 149 void AnalysisDataProxy::frameFinished(const AnalysisDataFrameHeader& header)
 150 {
 151     if (bParallel_)
 152     {
 153         moduleManager().notifyParallelFrameFinish(header);
 154     }
 155     else
 156     {
 157         moduleManager().notifyFrameFinish(header);
 158     }
 159 }
 160
 161 void AnalysisDataProxy::frameFinishedSerial(int frameIndex)
 162 {
 163     if (bParallel_)
 164     {
 165         // The x and dx values are unused in this case.
 166         AnalysisDataFrameHeader header(frameIndex, 0.0, 0.0);
 167         moduleManager().notifyFrameFinish(header);
 168     }
 169 }
 170
 171
 172 void AnalysisDataProxy::dataFinished()
 173 {
 174     moduleManager().notifyDataFinish();
 175 }
 176
 177 } // namespace gmx