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