src/gromacs/analysisdata/tests/datatest.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012,2013,2014,2015,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 datatest.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_analysisdata
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "datatest.h"
  45
  46 #include <gmock/gmock.h>
  47 #include <gtest/gtest.h>
  48
  49 #include "gromacs/analysisdata/analysisdata.h"
  50 #include "gromacs/analysisdata/paralleloptions.h"
  51 #include "gromacs/utility/gmxassert.h"
  52 #include "gromacs/utility/stringutil.h"
  53
  54 #include "gromacs/analysisdata/tests/mock_datamodule.h"
  55 #include "testutils/refdata.h"
  56 #include "testutils/testasserts.h"
  57
  58 namespace gmx
  59 {
  60
  61 namespace test
  62 {
  63
  64 /********************************************************************
  65  * AnalysisDataTestInputPointSet
  66  */
  67
  68 AnalysisDataTestInputPointSet::AnalysisDataTestInputPointSet(int index, int dataSetIndex, int firstColumn) :
  69     index_(index),
  70     dataSetIndex_(dataSetIndex),
  71     firstColumn_(firstColumn)
  72 {
  73 }
  74
  75
  76 /********************************************************************
  77  * AnalysisDataTestInputFrame
  78  */
  79
  80 AnalysisDataTestInputFrame::AnalysisDataTestInputFrame(int index, real x) : index_(index), x_(x) {}
  81
  82 AnalysisDataTestInputPointSet& AnalysisDataTestInputFrame::addPointSet(int dataSet, int firstColumn)
  83 {
  84     pointSets_.push_back(AnalysisDataTestInputPointSet(pointSets_.size(), dataSet, firstColumn));
  85     return pointSets_.back();
  86 }
  87
  88 void AnalysisDataTestInputFrame::addPointSetWithValues(int dataSet, int firstColumn, real y1)
  89 {
  90     AnalysisDataTestInputPointSet& pointSet = addPointSet(dataSet, firstColumn);
  91     pointSet.addValue(y1);
  92 }
  93
  94 void AnalysisDataTestInputFrame::addPointSetWithValues(int dataSet, int firstColumn, real y1, real y2)
  95 {
  96     AnalysisDataTestInputPointSet& pointSet = addPointSet(dataSet, firstColumn);
  97     pointSet.addValue(y1);
  98     pointSet.addValue(y2);
  99 }
 100
 101 void AnalysisDataTestInputFrame::addPointSetWithValues(int dataSet, int firstColumn, real y1, real y2, real y3)
 102 {
 103     AnalysisDataTestInputPointSet& pointSet = addPointSet(dataSet, firstColumn);
 104     pointSet.addValue(y1);
 105     pointSet.addValue(y2);
 106     pointSet.addValue(y3);
 107 }
 108
 109 void AnalysisDataTestInputFrame::addPointSetWithValueAndError(int dataSet, int firstColumn, real y1, real e1)
 110 {
 111     AnalysisDataTestInputPointSet& pointSet = addPointSet(dataSet, firstColumn);
 112     pointSet.addValueWithError(y1, e1);
 113 }
 114
 115
 116 /********************************************************************
 117  * AnalysisDataTestInput
 118  */
 119
 120 AnalysisDataTestInput::AnalysisDataTestInput(int dataSetCount, bool bMultipoint) :
 121     columnCounts_(dataSetCount),
 122     bMultipoint_(bMultipoint)
 123 {
 124 }
 125
 126
 127 AnalysisDataTestInput::~AnalysisDataTestInput() {}
 128
 129
 130 const AnalysisDataTestInputFrame& AnalysisDataTestInput::frame(int index) const
 131 {
 132     GMX_RELEASE_ASSERT(index >= 0 && index < frameCount(), "Out-of-range frame index");
 133     return frames_[index];
 134 }
 135
 136
 137 void AnalysisDataTestInput::setColumnCount(int dataSet, int columnCount)
 138 {
 139     GMX_RELEASE_ASSERT(dataSet >= 0 && dataSet < dataSetCount(), "Out-of-range data set index");
 140     columnCounts_[dataSet] = columnCount;
 141 }
 142
 143
 144 AnalysisDataTestInputFrame& AnalysisDataTestInput::addFrame(real x)
 145 {
 146     frames_.push_back(AnalysisDataTestInputFrame(frames_.size(), x));
 147     return frames_.back();
 148 }
 149
 150 void AnalysisDataTestInput::addFrameWithValues(real x, real y1)
 151 {
 152     AnalysisDataTestInputFrame& frame = addFrame(x);
 153     frame.addPointSetWithValues(0, 0, y1);
 154 }
 155
 156 void AnalysisDataTestInput::addFrameWithValues(real x, real y1, real y2)
 157 {
 158     AnalysisDataTestInputFrame& frame = addFrame(x);
 159     frame.addPointSetWithValues(0, 0, y1, y2);
 160 }
 161
 162 void AnalysisDataTestInput::addFrameWithValues(real x, real y1, real y2, real y3)
 163 {
 164     AnalysisDataTestInputFrame& frame = addFrame(x);
 165     frame.addPointSetWithValues(0, 0, y1, y2, y3);
 166 }
 167
 168 void AnalysisDataTestInput::addFrameWithValueAndError(real x, real y1, real e1)
 169 {
 170     AnalysisDataTestInputFrame& frame = addFrame(x);
 171     frame.addPointSetWithValueAndError(0, 0, y1, e1);
 172 }
 173
 174
 175 /********************************************************************
 176  * AnalysisDataTest
 177  */
 178
 179 AnalysisDataTestFixture::AnalysisDataTestFixture() {}
 180
 181
 182 void AnalysisDataTestFixture::setupDataObject(const AnalysisDataTestInput& input, AnalysisData* data)
 183 {
 184     data->setDataSetCount(input.dataSetCount());
 185     for (int i = 0; i < input.dataSetCount(); ++i)
 186     {
 187         data->setColumnCount(i, input.columnCount(i));
 188     }
 189     data->setMultipoint(input.isMultipoint());
 190 }
 191
 192
 193 void AnalysisDataTestFixture::presentAllData(const AnalysisDataTestInput& input, AnalysisData* data)
 194 {
 195     gmx::AnalysisDataParallelOptions options;
 196     gmx::AnalysisDataHandle          handle = data->startData(options);
 197     for (int row = 0; row < input.frameCount(); ++row)
 198     {
 199         presentDataFrame(input, row, handle);
 200         EXPECT_EQ(row + 1, data->frameCount());
 201     }
 202     handle.finishData();
 203 }
 204
 205
 206 void AnalysisDataTestFixture::presentDataFrame(const AnalysisDataTestInput& input, int row, AnalysisDataHandle handle)
 207 {
 208     const AnalysisDataTestInputFrame& frame = input.frame(row);
 209     handle.startFrame(row, frame.x(), frame.dx());
 210     for (int i = 0; i < frame.pointSetCount(); ++i)
 211     {
 212         const AnalysisDataTestInputPointSet& points = frame.pointSet(i);
 213         handle.selectDataSet(points.dataSetIndex());
 214         for (int j = 0; j < points.size(); ++j)
 215         {
 216             if (points.hasError(j))
 217             {
 218                 handle.setPoint(j + points.firstColumn(), points.y(j), points.error(j), points.present(j));
 219             }
 220             else
 221             {
 222                 handle.setPoint(j + points.firstColumn(), points.y(j), points.present(j));
 223             }
 224         }
 225         if (input.isMultipoint())
 226         {
 227             handle.finishPointSet();
 228         }
 229     }
 230     handle.finishFrame();
 231 }
 232
 233
 234 void AnalysisDataTestFixture::addStaticCheckerModule(const AnalysisDataTestInput& data,
 235                                                      AbstractAnalysisData*        source)
 236 {
 237     MockAnalysisDataModulePointer module(new MockAnalysisDataModule(0));
 238     module->setupStaticCheck(data, source, false);
 239     source->addModule(module);
 240 }
 241
 242
 243 void AnalysisDataTestFixture::addStaticParallelCheckerModule(const AnalysisDataTestInput& data,
 244                                                              AbstractAnalysisData*        source)
 245 {
 246     MockAnalysisDataModulePointer module(new MockAnalysisDataModule(0));
 247     module->setupStaticCheck(data, source, true);
 248     source->addModule(module);
 249 }
 250
 251
 252 void AnalysisDataTestFixture::addStaticColumnCheckerModule(const AnalysisDataTestInput& data,
 253                                                            int                          firstcol,
 254                                                            int                          n,
 255                                                            AbstractAnalysisData*        source)
 256 {
 257     MockAnalysisDataModulePointer module(new MockAnalysisDataModule(0));
 258     module->setupStaticColumnCheck(data, firstcol, n, source);
 259     source->addColumnModule(firstcol, n, module);
 260 }
 261
 262
 263 void AnalysisDataTestFixture::addStaticStorageCheckerModule(const AnalysisDataTestInput& data,
 264                                                             int                   storageCount,
 265                                                             AbstractAnalysisData* source)
 266 {
 267     MockAnalysisDataModulePointer module(new MockAnalysisDataModule(0));
 268     module->setupStaticStorageCheck(data, storageCount, source);
 269     source->addModule(module);
 270 }
 271
 272
 273 void AnalysisDataTestFixture::addReferenceCheckerModule(const TestReferenceChecker&   checker,
 274                                                         const char*                   id,
 275                                                         AbstractAnalysisData*         source,
 276                                                         const FloatingPointTolerance& tolerance)
 277 {
 278     MockAnalysisDataModulePointer module(new MockAnalysisDataModule(0));
 279     TestReferenceChecker          tmpChecker(checker);
 280     TestReferenceChecker          compoundChecker(tmpChecker.checkCompound("AnalysisData", id));
 281     compoundChecker.setDefaultTolerance(tolerance);
 282     module->setupReferenceCheck(compoundChecker, source);
 283     source->addModule(module);
 284 }
 285
 286
 287 void AnalysisDataTestFixture::addReferenceCheckerModule(const char* id, AbstractAnalysisData* source)
 288 {
 289     addReferenceCheckerModule(data_.rootChecker(), id, source, defaultRealTolerance());
 290 }
 291
 292 } // namespace test
 293 } // namespace gmx